Document DELETE staging excluded requests endpoint

Endpoint: DELETE `/staging/{project_name}/excluded_requests`
openSUSE · Apr 25, 2023 · 3fb49c9 · 3fb49c9
1 parent 05ee8a1
commit 3fb49c9
Showing 1 changed file with 58 additions and 0 deletions.
diff --git a/src/api/public/apidocs-new/paths/staging_project_name_excluded_requests.yaml b/src/api/public/apidocs-new/paths/staging_project_name_excluded_requests.yaml
@@ -55,3 +55,61 @@ post:
                 summary: "Project not found: <some project>."
   tags:
     - Staging Workflow
+
+delete:
+  summary: Delete the specified requests from the list of excluded requests.
+  description: Stop excluding the requests from the staging workflow.
+  security:
+    - basic_authentication: []
+  parameters:
+    - $ref: '../components/parameters/project_name.yaml'
+  requestBody:
+    description: List of requests to stop excluding from the staging workflow
+    content:
+      application/xml; charset=utf-8:
+        schema:
+          $ref: '../components/schemas/staging/excluded_requests.yaml'
+  responses:
+    '200':
+      $ref: '../components/responses/succeeded.yaml'
+    '401':
+      $ref: '../components/responses/unauthorized.yaml'
+    '400':
+      description: |
+        Bad Request.
+
+        XML Schema used for body validation: [status.xsd](../schema/status.xsd).
+      content:
+        application/xml; charset=utf-8:
+          schema:
+            $ref: '../components/schemas/api_response.yaml'
+          examples:
+            Invalid Request:
+              value:
+                code: invalid_request
+                summary: "Error while unexcluding requests: Requests with number ID are not excluded."
+            Invalid XML Format:
+              value:
+                code: invalid_xml_format
+                summary: 'XML format is not valid'
+            Empty Body:
+              value:
+                code: invalid_request
+                summary: 'Empty body'
+    '404':
+      description: Not Found
+      content:
+        application/xml; charset=utf-8:
+          schema:
+            $ref: '../components/schemas/api_response.yaml'
+          examples:
+            project_without_staging_workflow:
+              value:
+                code: not_found
+                sumary: "Project project_name doesn't have an associated Staging Workflow"
+            Unknown Project:
+              value:
+                code: unknown_project
+                summary: "Project not found: <some project>."
+  tags:
+    - Staging Workflow