From 56df23688da817879742a252235f424d53e44980 Mon Sep 17 00:00:00 2001 From: Lukas Krause Date: Fri, 17 Mar 2023 13:39:36 +0100 Subject: [PATCH] Document `/source/{project_name}/{package_name}?cmd=updatepatchinfo` with OpenAPI --- src/api/public/apidocs-new/OBS-v2.10.50.yaml | 2 ++ ...name_package_name_cmd_updatepatchinfo.yaml | 28 +++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 src/api/public/apidocs-new/paths/source_project_name_package_name_cmd_updatepatchinfo.yaml diff --git a/src/api/public/apidocs-new/OBS-v2.10.50.yaml b/src/api/public/apidocs-new/OBS-v2.10.50.yaml index e9e1dca600f..5c069a288e5 100644 --- a/src/api/public/apidocs-new/OBS-v2.10.50.yaml +++ b/src/api/public/apidocs-new/OBS-v2.10.50.yaml @@ -364,6 +364,8 @@ paths: $ref: 'paths/source_project_name_package_name_cmd_undelete.yaml' /source/{project_name}/{package_name}?cmd=unlock: $ref: 'paths/source_project_name_package_name_cmd_unlock.yaml' + /source/{project_name}/{package_name}?cmd=updatepatchinfo: + $ref: 'paths/source_project_name_package_name_cmd_updatepatchinfo.yaml' /source/{project_name}/{package_name}?cmd=waitservice: $ref: 'paths/source_project_name_package_name_cmd_waitservice.yaml' /source/{project_name}/{package_name}?cmd=wipe: diff --git a/src/api/public/apidocs-new/paths/source_project_name_package_name_cmd_updatepatchinfo.yaml b/src/api/public/apidocs-new/paths/source_project_name_package_name_cmd_updatepatchinfo.yaml new file mode 100644 index 00000000000..baf126c5d50 --- /dev/null +++ b/src/api/public/apidocs-new/paths/source_project_name_package_name_cmd_updatepatchinfo.yaml @@ -0,0 +1,28 @@ +post: + summary: Update the issues listed in the `_patchinfo` file of a specified package. + description: | + Update the issues listed in the `_patchinfo` file of a specified package, based on + infos available through the issue trackers. + security: + - basic_authentication: [] + parameters: + - $ref: '../components/parameters/project_name.yaml' + - $ref: '../components/parameters/package_name.yaml' + 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: cmd_execution_no_permission + summary: no permission to modify package patchinfo in project openSUSE:Maintenance:123 + '404': + $ref: '../components/responses/unknown_project_or_package.yaml' + tags: + - Sources - Packages