Skip to content

Commit

Permalink
Merge pull request #10679 from saraycp/person_token_delete
Browse files Browse the repository at this point in the history
Document 'person/{login}/token/{id}' delete method
  • Loading branch information
krauselukas committed Jan 22, 2021
2 parents 3853a4c + 785b7f4 commit fd09004
Show file tree
Hide file tree
Showing 2 changed files with 55 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 @@ -75,6 +75,8 @@ paths:
$ref: 'paths/person_login_group.yaml'
/person/{login}/token:
$ref: 'paths/person_login_token.yaml'
/person/{login}/token/{id}:
$ref: 'paths/person_login_token_id.yaml'

/request:
$ref: 'paths/request.yaml'
Expand Down
53 changes: 53 additions & 0 deletions src/api/public/apidocs-new/paths/person_login_token_id.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
delete:
summary: Delete a token of a person.
description: Delete a token of the specified person.
parameters:
- $ref: '../components/parameters/login.yaml'
- in: path
name: id
schema:
type: string
required: true
description: Id of the token to be removed.
example: 3
responses:
'200':
description: |
OK. The request has succeeded.
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: ok
summary: Ok
'401':
$ref: '../components/responses/unauthorized.yaml'
'403':
description: |
Forbidden.
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: update_user_not_authorized
summary: 'You are not authorized to update this User.'
'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 Token with 'id'=33 [WHERE `tokens`.`user_id` = ?]"
tags:
- Person

0 comments on commit fd09004

Please sign in to comment.