Add get-membership API to docs

This adds docs for the API that was added in #9197
hypothesis · Jan 7, 2025 · 00034c6 · 00034c6
1 parent 3081a7a
commit 00034c6
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/docs/_extra/api-reference/hypothesis-v1.yaml b/docs/_extra/api-reference/hypothesis-v1.yaml
@@ -930,6 +930,30 @@ paths:
                       $ref: '#/components/schemas/Membership'
 
   /groups/{id}/members/{user}:
+    # ----------------------------------------------------------
+    # GET groups/{id}/members/{user} - Get group member
+    # ----------------------------------------------------------
+    get:
+      tags:
+        - memberships
+      summary: Get group member
+      description: Get a user's membership of a group.
+        Authenticated user must have read access to the group.
+        Does not require authentication for reading members of public groups.
+      security:
+        - ApiKey: []
+        - {}
+      parameters:
+        - $ref: '#/components/parameters/GroupID'
+        - $ref: '#/components/parameters/UserID'
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Membership'
+
     # ----------------------------------------------------------
     # POST groups/{id}/members/{user} - Add user to group
     # ----------------------------------------------------------

diff --git a/docs/_extra/api-reference/hypothesis-v2.yaml b/docs/_extra/api-reference/hypothesis-v2.yaml
@@ -928,6 +928,30 @@ paths:
                       $ref: '#/components/schemas/Membership'
 
   /groups/{id}/members/{user}:
+    # ----------------------------------------------------------
+    # GET groups/{id}/members/{user} - Get group member
+    # ----------------------------------------------------------
+    get:
+      tags:
+        - memberships
+      summary: Get group member
+      description: Fetch a user's membership of a group.
+        Authenticated user must have read access to the group.
+        Does not require authentication for reading members of public groups.
+      security:
+        - ApiKey: []
+        - {}
+      parameters:
+        - $ref: '#/components/parameters/GroupID'
+        - $ref: '#/components/parameters/UserID'
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Membership'
+
     # ----------------------------------------------------------
     # POST groups/{id}/members/{user} - Add user to group
     # ----------------------------------------------------------