-
Notifications
You must be signed in to change notification settings - Fork 440
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add delete comments endpoint documentation
- Loading branch information
1 parent
bc1b898
commit 479c9fe
Showing
2 changed files
with
42 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
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,38 @@ | ||
delete: | ||
summary: Delete a comment | ||
description: Delete a given comment based on its id. | ||
security: | ||
- basic_authentication: [] | ||
parameters: | ||
- in: path | ||
name: comment_id | ||
schema: | ||
type: integer | ||
required: true | ||
description: Id of the comment. | ||
example: 1124 | ||
responses: | ||
'200': | ||
$ref: '../components/responses/succeeded.yaml' | ||
'401': | ||
$ref: '../components/responses/unauthorized.yaml' | ||
'403': | ||
description: 'Forbidden' | ||
content: | ||
application/xml; charset=utf-8: | ||
schema: | ||
$ref: '../components/schemas/api_response.yaml' | ||
example: | ||
code: delete_comment_not_authorized | ||
summary: Sorry, you are not authorized to delete this comment | ||
'404': | ||
description: Not Found | ||
content: | ||
application/xml; charset=utf-8: | ||
schema: | ||
$ref: '../components/schemas/api_response.yaml' | ||
example: | ||
code: not_found | ||
summary: Couldn't find Comment with id '1124' | ||
tags: | ||
- Comments |