Skip to content

Commit

Permalink
Add delete comments endpoint documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hellcp-work committed Apr 21, 2023
1 parent bc1b898 commit 479c9fe
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
4 changes: 4 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 @@ -8,6 +8,7 @@ tags:
- name: Attribute Namespaces
- name: Attributes
- name: Build
- name: Comments
- name: Configuration
- name: Distributions
- name: General Information
Expand Down Expand Up @@ -133,6 +134,9 @@ paths:
/build/{project_name}/{repository_name}/{architecture_name}/{package_name}/{file_name}?view=fileinfo:
$ref: 'paths/build_project_name_repository_name_architecture_name_package_name_file_name_view_fileinfo.yaml'

/comment/{comment_id}:
$ref: 'paths/comment_comment_id.yaml'

/configuration:
$ref: 'paths/configuration.yaml'

Expand Down
38 changes: 38 additions & 0 deletions src/api/public/apidocs-new/paths/comment_comment_id.yaml
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

0 comments on commit 479c9fe

Please sign in to comment.