add explicit error status codes for host-conf

The host-conf resource returns 404 and 409 statuses for specific semantic conditions. Add these responses codes to the response list. Distinct and specific descriptions are given to document the semantics, instead of referencing ErrorResponse with its generic description.
podengo-project · Sep 3, 2024 · 286b935 · 286b935
1 parent 95d9bbf
commit 286b935
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/public.openapi.json b/public.openapi.json
@@ -392,6 +392,26 @@
         "responses": {
           "200": {
             "$ref": "#/components/responses/HostConfResponse"
+          },
+          "404": {
+            "description": "No enabled domains matched request parameters",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Multiple active domains matched request parameters",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
           }
         },
         "security": [

diff --git a/public.openapi.yaml b/public.openapi.yaml
@@ -245,6 +245,18 @@ paths:
             responses:
                 '200':
                     $ref: '#/components/responses/HostConfResponse'
+                '404':
+                    description: No enabled domains matched request parameters
+                    content:
+                        application/json:
+                            schema:
+                                $ref: '#/components/schemas/Errors'
+                '409':
+                    description: Multiple active domains matched request parameters
+                    content:
+                        application/json:
+                            schema:
+                                $ref: '#/components/schemas/Errors'
             security:
                 - x-rh-identity:
                       - Type:System:domain