Skip to content

Commit

Permalink
Merge pull request #10672 from saraycp/person_groups
Browse files Browse the repository at this point in the history
Document 'person/{login}/group' endpoint
  • Loading branch information
krauselukas committed Jan 22, 2021
2 parents 0ebb3dc + 573dc74 commit 8c4dd95
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/api/public/apidocs-new/OBS-v2.10.50.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ paths:
$ref: 'paths/person.yaml'
/person/register:
$ref: 'paths/person_register.yaml'
/person/{login}/group:
$ref: 'paths/person_login_group.yaml'
/person/{login}/token:
$ref: 'paths/person_login_token.yaml'

Expand Down
38 changes: 38 additions & 0 deletions src/api/public/apidocs-new/paths/person_login_group.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
get:
summary: List the groups of a person
description: List the groups the person belongs to.
security:
- basic_authentication: []
parameters:
- $ref: '../components/parameters/login.yaml'
responses:
'200':
description: >
OK. The request has succeeded.
XML Schema used for body validation: [directory.xsd](../schema/directory.xsd)
content:
application/xml; charset=utf-8:
schema:
$ref: '../components/schemas/directory.yaml'
example:
count: '2'
entry:
- name: 'factory-maintainers'
- name: 'obs-developers'
'401':
$ref: '../components/responses/unauthorized.yaml'
'404':
description: |
Not Found.
XML Schema used for body validation: [status.xsd](../schema/status.xsd)
content:
application/xml; charset=utf-8:
schema:
$ref: '../components/schemas/api_response.yaml'
example:
code: not_found
summary: "Couldn't find User with login = fake"
tags:
- Person

0 comments on commit 8c4dd95

Please sign in to comment.