Merge pull request #14232 from rubhanazeem/document-status-messages

OpenAPI specifications for GET /status_message

src/api/public/apidocs-new/OBS-v2.10.50.yaml

@@ -431,6 +431,8 @@ paths:
   # Status messages
   /status/messages:
     $ref: 'paths/status_messages.yaml'
+  /status_message:
+    $ref: 'paths/status_message.yaml'
   /status/messages/{id}:
     $ref: 'paths/status_messages_id.yaml'
 

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

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.