Skip to content

Commit

Permalink
OpenAPI specifications for GET/POST source files - without attribute …
Browse files Browse the repository at this point in the history
…paramater
  • Loading branch information
rubhanazeem committed Mar 20, 2023
1 parent 550f228 commit 188df48
Show file tree
Hide file tree
Showing 2 changed files with 62 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 @@ -380,6 +380,8 @@ paths:
$ref: 'paths/source_project_name_package_name_file_name.yaml'
/source/{project_name}/{package_name}/{binary_filename}/_attribute/{attribute_name}:
$ref: 'paths/source_project_name_package_name_binary_filename_attribute_name.yaml'
/source/{project_name}/{package_name}/{binary_filename}/_attribute:
$ref: 'paths/source_project_name_package_name_binary_filename_attribute.yaml'

/trigger/{operation}:
$ref: 'paths/trigger_operation.yaml'
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
get:
summary: Get list of attributes and attribute values with binary parameter
description: |
Get a list of all attributes and their values for a given binary
security:
- basic_authentication: []
parameters:
- $ref: '../components/parameters/project_name.yaml'
- $ref: '../components/parameters/package_name.yaml'
- $ref: '../components/parameters/binary_filename.yaml'
responses:
'200':
description: OK. The request has succeeded.
content:
application/xml; charset=utf-8:
schema:
$ref: '../components/schemas/source/attributes.yaml'
example:
- name: AllowSubmitToMaintenanceRelease
namespace: OBS
binary: SLES-cd-DVD-x86_64
- name: OwnerRootProjectTest
namespace: OBS
binary: Ceph
'401':
$ref: '../components/responses/unauthorized.yaml'
'404':
$ref: '../components/responses/unknown_project_or_package.yaml'
tags:
- Sources - Files

post:
summary: Add an attribute
description: |
Add an attribute with binary to a package
security:
- basic_authentication: []
parameters:
- $ref: '../components/parameters/project_name.yaml'
- $ref: '../components/parameters/package_name.yaml'
- $ref: '../components/parameters/binary_filename.yaml'
requestBody:
description: Attributes you want to update
content:
application/xml; charset=utf-8:
schema:
$ref: '../components/schemas/source/attributes.yaml'
example:
name: MaintenanceProject
namespace: OBS
binary: Ceph
responses:
'200':
$ref: '../components/responses/succeeded.yaml'
'401':
$ref: '../components/responses/unauthorized.yaml'
'404':
$ref: '../components/responses/unknown_project_or_package.yaml'
tags:
- Sources - Files

0 comments on commit 188df48

Please sign in to comment.