docs: Include details on WARP for API endpoints (#2234)

* docs: Include details on WARP for API endpoints [skip pizza] * fix: PR comments [skip pizza]
theopensystemslab · Sep 22, 2023 · 00112a7 · 00112a7
1 parent e2c0abc
commit 00112a7
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/api.planx.uk/modules/team/docs.yaml b/api.planx.uk/modules/team/docs.yaml
@@ -26,6 +26,9 @@ paths:
   /team/{teamId}/add-member:
     put:
       summary: Add user to team, and assign them a role
+      description: "Requires authentication via a Cloudflare WARP client
+        \n\n
+        Please login at [https://api.editor.planx.uk/team](https://api.editor.planx.uk/team){:target='_blank'}"
       tags: ["team"]
       parameters:
         - $ref: "#/components/parameters/teamId"
@@ -43,6 +46,9 @@ paths:
   /team/{teamId}/change-member-role:
     patch:
       summary: Change role of an existing team member
+      description: "Requires authentication via a Cloudflare WARP client
+        \n\n
+        Please login at [https://api.editor.planx.uk/team](https://api.editor.planx.uk/team){:target='_blank'}"
       tags: ["team"]
       parameters:
         - $ref: "#/components/parameters/teamId"
@@ -60,6 +66,9 @@ paths:
   /team/{teamId}/remove-member:
     delete:
       summary: Remover user from team
+      description: "Requires authentication via a Cloudflare WARP client
+        \n\n
+        Please login at [https://api.editor.planx.uk/team](https://api.editor.planx.uk/team){:target='_blank'}"
       tags: ["team"]
       parameters:
         - $ref: "#/components/parameters/teamId"