-
Notifications
You must be signed in to change notification settings - Fork 437
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document 'person/{login}/token/{id}' delete method
Using OpenAPI.
- Loading branch information
Showing
2 changed files
with
55 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
53 changes: 53 additions & 0 deletions
53
src/api/public/apidocs-new/paths/person_login_token_id.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |