feat(HMS-4648): add 413 and 431 codes to errors

This change update the public API contract to reflect the status code returned when a size limit happens for the public endpoints. https://issues.redhat.com/browse/HMS-4648 Signed-off-by: Alejandro Visiedo <[email protected]>
podengo-project · Sep 27, 2024 · c5d7b62 · c5d7b62
1 parent 2ee029a
commit c5d7b62
Show file tree

Hide file tree

Showing 2 changed files with 90 additions and 0 deletions.
diff --git a/public.openapi.json b/public.openapi.json
@@ -78,6 +78,12 @@
           },
           "404": {
             "$ref": "#/components/responses/ErrorResponse"
+          },
+          "413": {
+            "$ref": "#/components/responses/ErrorResponse"
+          },
+          "431": {
+            "$ref": "#/components/responses/ErrorResponse"
           }
         },
         "security": [
@@ -124,6 +130,12 @@
           },
           "404": {
             "$ref": "#/components/responses/ErrorResponse"
+          },
+          "413": {
+            "$ref": "#/components/responses/ErrorResponse"
+          },
+          "431": {
+            "$ref": "#/components/responses/ErrorResponse"
           }
         },
         "security": [
@@ -173,6 +185,12 @@
           },
           "404": {
             "$ref": "#/components/responses/ErrorResponse"
+          },
+          "413": {
+            "$ref": "#/components/responses/ErrorResponse"
+          },
+          "431": {
+            "$ref": "#/components/responses/ErrorResponse"
           }
         },
         "security": [
@@ -212,6 +230,12 @@
           },
           "404": {
             "$ref": "#/components/responses/ErrorResponse"
+          },
+          "413": {
+            "$ref": "#/components/responses/ErrorResponse"
+          },
+          "431": {
+            "$ref": "#/components/responses/ErrorResponse"
           }
         },
         "security": [
@@ -239,6 +263,12 @@
           },
           "404": {
             "$ref": "#/components/responses/ErrorResponse"
+          },
+          "413": {
+            "$ref": "#/components/responses/ErrorResponse"
+          },
+          "431": {
+            "$ref": "#/components/responses/ErrorResponse"
           }
         },
         "security": [
@@ -280,6 +310,12 @@
           },
           "404": {
             "$ref": "#/components/responses/ErrorResponse"
+          },
+          "413": {
+            "$ref": "#/components/responses/ErrorResponse"
+          },
+          "431": {
+            "$ref": "#/components/responses/ErrorResponse"
           }
         },
         "security": [
@@ -326,6 +362,12 @@
           },
           "404": {
             "$ref": "#/components/responses/ErrorResponse"
+          },
+          "413": {
+            "$ref": "#/components/responses/ErrorResponse"
+          },
+          "431": {
+            "$ref": "#/components/responses/ErrorResponse"
           }
         },
         "security": [
@@ -412,6 +454,12 @@
                 }
               }
             }
+          },
+          "413": {
+            "$ref": "#/components/responses/ErrorResponse"
+          },
+          "431": {
+            "$ref": "#/components/responses/ErrorResponse"
           }
         },
         "security": [
@@ -447,6 +495,12 @@
           },
           "404": {
             "$ref": "#/components/responses/ErrorResponse"
+          },
+          "413": {
+            "$ref": "#/components/responses/ErrorResponse"
+          },
+          "431": {
+            "$ref": "#/components/responses/ErrorResponse"
           }
         },
         "security": [

diff --git a/public.openapi.yaml b/public.openapi.yaml
@@ -54,6 +54,10 @@ paths:
                     $ref: '#/components/responses/ErrorResponse'
                 '404':
                     $ref: '#/components/responses/ErrorResponse'
+                '413':
+                    $ref: '#/components/responses/ErrorResponse'
+                '431':
+                    $ref: '#/components/responses/ErrorResponse'
             security:
                 - x-rh-identity:
                       - Type:User
@@ -81,6 +85,10 @@ paths:
                     $ref: '#/components/responses/ErrorResponse'
                 '404':
                     $ref: '#/components/responses/ErrorResponse'
+                '413':
+                    $ref: '#/components/responses/ErrorResponse'
+                '431':
+                    $ref: '#/components/responses/ErrorResponse'
             security:
                 - x-rh-identity:
                       - Type:System
@@ -110,6 +118,10 @@ paths:
                     $ref: '#/components/responses/ErrorResponse'
                 '404':
                     $ref: '#/components/responses/ErrorResponse'
+                '413':
+                    $ref: '#/components/responses/ErrorResponse'
+                '431':
+                    $ref: '#/components/responses/ErrorResponse'
             security:
                 - x-rh-identity:
                       - Type:User
@@ -133,6 +145,10 @@ paths:
                     $ref: '#/components/responses/ErrorResponse'
                 '404':
                     $ref: '#/components/responses/ErrorResponse'
+                '413':
+                    $ref: '#/components/responses/ErrorResponse'
+                '431':
+                    $ref: '#/components/responses/ErrorResponse'
             security:
                 - x-rh-identity:
                       - Type:User
@@ -150,6 +166,10 @@ paths:
                     $ref: '#/components/responses/ErrorResponse'
                 '404':
                     $ref: '#/components/responses/ErrorResponse'
+                '413':
+                    $ref: '#/components/responses/ErrorResponse'
+                '431':
+                    $ref: '#/components/responses/ErrorResponse'
             security:
                 - x-rh-identity:
                       - Type:User
@@ -176,6 +196,10 @@ paths:
                     $ref: '#/components/responses/ErrorResponse'
                 '404':
                     $ref: '#/components/responses/ErrorResponse'
+                '413':
+                    $ref: '#/components/responses/ErrorResponse'
+                '431':
+                    $ref: '#/components/responses/ErrorResponse'
             security:
                 - x-rh-identity:
                       - Type:User
@@ -204,6 +228,10 @@ paths:
                     $ref: '#/components/responses/ErrorResponse'
                 '404':
                     $ref: '#/components/responses/ErrorResponse'
+                '413':
+                    $ref: '#/components/responses/ErrorResponse'
+                '431':
+                    $ref: '#/components/responses/ErrorResponse'
             security:
                 - x-rh-identity:
                       - Type:System:domain
@@ -257,6 +285,10 @@ paths:
                         application/json:
                             schema:
                                 $ref: '#/components/schemas/Errors'
+                '413':
+                    $ref: '#/components/responses/ErrorResponse'
+                '431':
+                    $ref: '#/components/responses/ErrorResponse'
             security:
                 - x-rh-identity:
                       - Type:System:domain
@@ -279,6 +311,10 @@ paths:
                     $ref: '#/components/responses/ErrorResponse'
                 '404':
                     $ref: '#/components/responses/ErrorResponse'
+                '413':
+                    $ref: '#/components/responses/ErrorResponse'
+                '431':
+                    $ref: '#/components/responses/ErrorResponse'
             security:
                 - x-rh-identity:
                       - Type:System