Protobuffs - add description comments

metadata-protobuf/doc/index.md

@@ -36,10 +36,10 @@
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| header | [string](#string) | optional |  |
-| bullet_points | [string](#string) | repeated |  |
-| cover_image | [string](#string) | optional |  |
-| description | [string](#string) | optional |  |
+| header | [string](#string) | optional | Candidacy header text |
+| bullet_points | [string](#string) | repeated | Candidate program in form of bullet points |
+| banner_image_uri | [string](#string) | optional | Image uri of candidate's banner |
+| description | [string](#string) | optional | Candidacy description (md-formatted) |
 
 
 
@@ -70,9 +70,9 @@
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| name | [string](#string) | optional |  |
-| avatar_uri | [string](#string) | optional |  |
-| about | [string](#string) | optional |  |
+| name | [string](#string) | optional | Member's real name |
+| avatar_uri | [string](#string) | optional | Member's avatar image uri |
+| about | [string](#string) | optional | Member's md-formatted about text |
 
 
 
@@ -103,7 +103,7 @@
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| answers | [string](#string) | repeated |  |
+| answers | [string](#string) | repeated | List of answers to opening application form questions |
 
 
 
@@ -118,12 +118,12 @@
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| short_description | [string](#string) | required |  |
-| description | [string](#string) | required |  |
-| hiring_limit | [uint32](#uint32) | required |  |
-| expected_duration | [uint32](#uint32) | required |  |
-| application_details | [string](#string) | required |  |
-| application_form_questions | [OpeningMetadata.ApplicationFormQuestion](#OpeningMetadata.ApplicationFormQuestion) | repeated |  |
+| short_description | [string](#string) | required | Short description of the opening |
+| description | [string](#string) | required | Full description of the opening |
+| hiring_limit | [uint32](#uint32) | required | Expected number of hired applicants |
+| expected_ending_timestamp | [uint64](#uint64) | required | Expected time when the opening will close (Unix timestamp) |
+| application_details | [string](#string) | required | Md-formatted text explaining the application process |
+| application_form_questions | [OpeningMetadata.ApplicationFormQuestion](#OpeningMetadata.ApplicationFormQuestion) | repeated | List of questions that should be answered during application |
 
 
 
@@ -138,8 +138,8 @@
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| question | [string](#string) | required |  |
-| type | [OpeningMetadata.ApplicationFormQuestion.InputType](#OpeningMetadata.ApplicationFormQuestion.InputType) | required |  |
+| question | [string](#string) | required | The question itself (ie. "What is your name?"") |
+| type | [OpeningMetadata.ApplicationFormQuestion.InputType](#OpeningMetadata.ApplicationFormQuestion.InputType) | required | Suggested type of the UI answer input |
 
 
 
@@ -154,10 +154,10 @@
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| description | [string](#string) | optional |  |
-| about | [string](#string) | optional |  |
-| status | [string](#string) | optional | Can also be an enum if we only want a limited set |
-| status_message | [string](#string) | optional |  |
+| description | [string](#string) | optional | Full status description (md-formatted) |
+| about | [string](#string) | optional | Status about text (md-formatted) |
+| status | [string](#string) | optional | The status itself (expected to be 1-3 words) |
+| status_message | [string](#string) | optional | Short status message |
 
 
 

metadata-protobuf/proto/Council.proto

@@ -1,8 +1,8 @@
 syntax = "proto2";
 
 message CouncilCandidacyNoteMetadata {
-  optional string header = 1;
-  repeated string bullet_points = 2;
-  optional string cover_image = 3;
-  optional string description = 4;
+  optional string header = 1; // Candidacy header text
+  repeated string bullet_points = 2; // Candidate program in form of bullet points
+  optional string banner_image_uri = 3; // Image uri of candidate's banner
+  optional string description = 4; // Candidacy description (md-formatted)
 }

metadata-protobuf/proto/Membership.proto

@@ -1,7 +1,7 @@
 syntax = "proto2";
 
 message MembershipMetadata {
-  optional string name = 1;
-  optional string avatar_uri = 2;
-  optional string about = 3;
+  optional string name = 1; // Member's real name
+  optional string avatar_uri = 2; // Member's avatar image uri
+  optional string about = 3; // Member's md-formatted about text
 }

metadata-protobuf/proto/WorkingGroups.proto

@@ -1,29 +1,29 @@
 syntax = "proto2";
 
 message OpeningMetadata {
-  required string short_description = 1;
-  required string description = 2;
-  required uint32 hiring_limit = 3;
-  required uint32 expected_duration = 4;
-  required string application_details = 5;
+  required string short_description = 1; // Short description of the opening
+  required string description = 2; // Full description of the opening
+  required uint32 hiring_limit = 3; // Expected number of hired applicants
+  required uint64 expected_ending_timestamp = 4; // Expected time when the opening will close (Unix timestamp)
+  required string application_details = 5; // Md-formatted text explaining the application process
   message ApplicationFormQuestion {
-    required string question = 1;
+    required string question = 1; // The question itself (ie. "What is your name?"")
     enum InputType {
       TEXT = 1;
       TEXTAREA = 2;
     }
-    required InputType type = 2;
+    required InputType type = 2; // Suggested type of the UI answer input
   }
-  repeated ApplicationFormQuestion application_form_questions = 6;
+  repeated ApplicationFormQuestion application_form_questions = 6; // List of questions that should be answered during application
 }
 
 message ApplicationMetadata {
-  repeated string answers = 1;
+  repeated string answers = 1; // List of answers to opening application form questions
 }
 
 message WorkingGroupStatusMetadata {
-  optional string description = 1;
-  optional string about = 2;
-  optional string status = 3; // Can also be an enum if we only want a limited set
-  optional string status_message = 4;
+  optional string description = 1; // Full status description (md-formatted)
+  optional string about = 2; // Status about text (md-formatted)
+  optional string status = 3; // The status itself (expected to be 1-3 words)
+  optional string status_message = 4; // Short status message
 }