Skip to content

Commit

Permalink
Add teams/{id}/members endpoint to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kberzinch committed Jul 17, 2024
1 parent 6854808 commit 839aee6
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/admins/api/endpoints.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,13 @@ All endpoints require an ``Authorization`` header with an OAuth access token, an
:status 200: an array of team information is returned
:status 401: the token was either not provided or invalid
:status 403: the authenticated user does not have permission for this operation (``read-teams``)

.. http:get:: /api/v1/teams/(int:id)/members
:synopsis: Return information about members for a given team

:requestheader Authorization: an OAuth access token (see :ref:`Authentication`)
:requestheader Accept: ``application/json``

:status 200: an array of members for the team is returned
:status 401: the token was either not provided or invalid
:status 403: the authenticated user does not have permission for this operation (``read-teams``)

0 comments on commit 839aee6

Please sign in to comment.