Include en-US description of custom roles in static API (#1181)

* Include en-US description of custom roles in static API * Add a custom role to static-api test
rust-lang · Jan 9, 2024 · 4fea82a · 4fea82a
1 parent 3161442
commit 4fea82a
Show file tree

Hide file tree

Showing 9 changed files with 50 additions and 3 deletions.
diff --git a/rust_team_data/src/v1.rs b/rust_team_data/src/v1.rs
@@ -23,6 +23,7 @@ pub struct Team {
     pub alumni: Vec<TeamMember>,
     pub github: Option<TeamGitHub>,
     pub website_data: Option<TeamWebsite>,
+    pub roles: Vec<MemberRole>,
     pub discord: Vec<TeamDiscord>,
 }
 
@@ -60,6 +61,12 @@ pub struct TeamWebsite {
     pub weight: i64,
 }
 
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
+pub struct MemberRole {
+    pub id: String,
+    pub description: String,
+}
+
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
 pub struct TeamDiscord {
     pub name: String,

diff --git a/src/static_api.rs b/src/static_api.rs
@@ -189,6 +189,14 @@ impl<'a> Generator<'a> {
                     zulip_stream: ws.zulip_stream().map(|s| s.into()),
                     weight: ws.weight(),
                 }),
+                roles: team
+                    .roles()
+                    .iter()
+                    .map(|role| v1::MemberRole {
+                        id: role.id.clone(),
+                        description: role.description.clone(),
+                    })
+                    .collect(),
                 discord: team
                     .discord_roles()
                     .map(|roles| {

diff --git a/tests/static-api/_expected/v1/teams.json b/tests/static-api/_expected/v1/teams.json
@@ -14,6 +14,7 @@
     "alumni": [],
     "github": null,
     "website_data": null,
+    "roles": [],
     "discord": []
   },
   "foo": {
@@ -69,6 +70,7 @@
       "zulip_stream": "t-foo",
       "weight": 1000
     },
+    "roles": [],
     "discord": []
   },
   "leaderless": {
@@ -86,6 +88,7 @@
     "alumni": [],
     "github": null,
     "website_data": null,
+    "roles": [],
     "discord": []
   },
   "leads-permissions": {
@@ -115,6 +118,7 @@
     "alumni": [],
     "github": null,
     "website_data": null,
+    "roles": [],
     "discord": []
   },
   "wg-test": {
@@ -126,7 +130,10 @@
         "name": "Second user",
         "github": "user-2",
         "github_id": 2,
-        "is_lead": true
+        "is_lead": true,
+        "roles": [
+          "convener"
+        ]
       }
     ],
     "alumni": [
@@ -145,6 +152,12 @@
     ],
     "github": null,
     "website_data": null,
+    "roles": [
+      {
+        "id": "convener",
+        "description": "Convener"
+      }
+    ],
     "discord": []
   }
 }
diff --git a/tests/static-api/_expected/v1/teams/alumni.json b/tests/static-api/_expected/v1/teams/alumni.json
@@ -13,5 +13,6 @@
   "alumni": [],
   "github": null,
   "website_data": null,
+  "roles": [],
   "discord": []
 }
diff --git a/tests/static-api/_expected/v1/teams/foo.json b/tests/static-api/_expected/v1/teams/foo.json
@@ -51,5 +51,6 @@
     "zulip_stream": "t-foo",
     "weight": 1000
   },
+  "roles": [],
   "discord": []
 }
diff --git a/tests/static-api/_expected/v1/teams/leaderless.json b/tests/static-api/_expected/v1/teams/leaderless.json
@@ -13,5 +13,6 @@
   "alumni": [],
   "github": null,
   "website_data": null,
+  "roles": [],
   "discord": []
 }
diff --git a/tests/static-api/_expected/v1/teams/leads-permissions.json b/tests/static-api/_expected/v1/teams/leads-permissions.json
@@ -25,5 +25,6 @@
   "alumni": [],
   "github": null,
   "website_data": null,
+  "roles": [],
   "discord": []
 }
diff --git a/tests/static-api/_expected/v1/teams/wg-test.json b/tests/static-api/_expected/v1/teams/wg-test.json
@@ -7,7 +7,10 @@
       "name": "Second user",
       "github": "user-2",
       "github_id": 2,
-      "is_lead": true
+      "is_lead": true,
+      "roles": [
+        "convener"
+      ]
     }
   ],
   "alumni": [
@@ -26,5 +29,11 @@
   ],
   "github": null,
   "website_data": null,
+  "roles": [
+    {
+      "id": "convener",
+      "description": "Convener"
+    }
+  ],
   "discord": []
 }
diff --git a/tests/static-api/teams/wg-test.toml b/tests/static-api/teams/wg-test.toml
@@ -3,5 +3,11 @@ kind = "working-group"
 
 [people]
 leads = ["user-2"]
-members = ["user-2"]
+members = [
+    { github = "user-2", roles = ["convener"] },
+]
 alumni = ["user-0", "user-5"]
+
+[[roles]]
+id = "convener"
+description = "Convener"