Skip to content

Commit

Permalink
Document DELETE /source/{project_name}/{package_name}
Browse files Browse the repository at this point in the history
... endpoint with OpenAPI
  • Loading branch information
eduardoj committed Mar 10, 2023
1 parent c7baa3c commit 98130bc
Show file tree
Hide file tree
Showing 2 changed files with 59 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 @@ -309,6 +309,8 @@ paths:

# Sources - Packages

/source/{project_name}/{package_name}:
$ref: 'paths/source_project_name_package_name.yaml'
/source/{project_name}/{package_name}?cmd=commit:
$ref: 'paths/source_project_name_package_name_cmd_commit.yaml'
/source/{project_name}/{package_name}?cmd=copy:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
delete:
summary: Deletes a specified package including all its source files.
description: Deletes a specified package including all its source files. By default only if no other packages use this package as a devel package.
security:
- basic_authentication: []
parameters:
- $ref: '../components/parameters/project_name.yaml'
- $ref: '../components/parameters/package_name.yaml'
- in: query
name: comment
schema:
type: string
description: Comment to be included in the revision history of the package.
example: This package was no longer needed.
- in: query
name: force
schema:
type: string
enum:
- 1
- 0
default: 0
description: Set to `1` to delete this package, even if other packages use this one as devel package.
example: 1
responses:
'200':
$ref: '../components/responses/succeeded.yaml'
'400':
description: Bad Request.
content:
application/xml; charset=utf-8:
schema:
$ref: '../components/schemas/api_response.yaml'
examples:
Delete Error:
value:
code: delete_error
summary: "Package is used by following packages as devel package: project_devel/ctris"
'401':
$ref: '../components/responses/unauthorized.yaml'
'404':
description: Not Found.
content:
application/xml; charset=utf-8:
schema:
$ref: '../components/schemas/api_response.yaml'
examples:
Unknown Project:
value:
code: unknown_project
summary: "Project not found: home:some_project"
Unknown Package:
value:
code: unknown_package
summary: "Package not found: home:some_project/some_package"
tags:
- Sources - Packages

0 comments on commit 98130bc

Please sign in to comment.