From 381ad62064f875c2409a6f7391b5a95c2b69bbcd Mon Sep 17 00:00:00 2001 From: Rubhan Azeem Date: Tue, 25 Apr 2023 16:39:29 +0200 Subject: [PATCH 1/2] OpenAPI specifications for GET status_message --- src/api/public/apidocs-new/OBS-v2.10.50.yaml | 2 ++ .../apidocs-new/paths/status_message.yaml | 34 +++++++++++++++++++ 2 files changed, 36 insertions(+) create mode 100644 src/api/public/apidocs-new/paths/status_message.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 8a6c730e93d..4db3ac311f9 100644 --- a/src/api/public/apidocs-new/OBS-v2.10.50.yaml +++ b/src/api/public/apidocs-new/OBS-v2.10.50.yaml @@ -398,6 +398,8 @@ paths: # Status messages /status/messages: $ref: 'paths/status_messages.yaml' + /status_message: + $ref: 'paths/status_message.yaml' /trigger/{operation}: $ref: 'paths/trigger_operation.yaml' diff --git a/src/api/public/apidocs-new/paths/status_message.yaml b/src/api/public/apidocs-new/paths/status_message.yaml new file mode 100644 index 00000000000..9cb30ca140b --- /dev/null +++ b/src/api/public/apidocs-new/paths/status_message.yaml @@ -0,0 +1,34 @@ +get: + summary: Get list of status messages + description: | + Get a list of all status messages + security: + - basic_authentication: [] + parameters: + - $ref: '../components/parameters/limit.yaml' + responses: + '200': + description: OK. The request has succeeded. + content: + application/xml; charset=utf-8: + schema: + $ref: '../components/schemas/status_messages.yaml' + example: + count: 2 + status_message: + - id: 2 + message: OBS 3.0 is released! + user: Iggy + severity: announcement + scope: all_users + created_at: 2021-10-15 13:28:22 UTC + - id: 1 + message: Feature number 42 was implemented! + user: Iggy + severity: announcement + scope: all_users + created_at: 2021-10-12 11:18:12 UTC + '401': + $ref: '../components/responses/unauthorized.yaml' + tags: + - Status Messages From fa09d9c7818f29874ab4e971366c499502082a86 Mon Sep 17 00:00:00 2001 From: Rubhan Azeem Date: Fri, 28 Apr 2023 12:31:08 +0200 Subject: [PATCH 2/2] Add limit parameter in status_messages endpoint --- src/api/public/apidocs-new/paths/status_messages.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/api/public/apidocs-new/paths/status_messages.yaml b/src/api/public/apidocs-new/paths/status_messages.yaml index d1c6a038c14..987b5cedb99 100644 --- a/src/api/public/apidocs-new/paths/status_messages.yaml +++ b/src/api/public/apidocs-new/paths/status_messages.yaml @@ -4,6 +4,8 @@ get: Get a list of all status messages security: - basic_authentication: [] + parameters: + - $ref: '../components/parameters/limit.yaml' responses: '200': description: OK. The request has succeeded.