feat(process): add 429 status when case creation limit reached (#196)

bonitasoft · Oct 2, 2024 · 7abd249 · 7abd249
1 parent f8ae57c
commit 7abd249
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/openapi/paths/API@bpm@case.yaml b/openapi/paths/API@bpm@case.yaml
@@ -73,6 +73,28 @@ post:
       $ref: '../components/responses/Forbidden.yaml'
     '400':
       $ref: '../components/responses/BadRequest.yaml'
+    '429':
+      description: Case creation limit reached (Community 2024.3+ only)
+      headers:
+        Retry-After:
+            schema:
+              type: string
+              format: date-time
+            description: Date when case counter will be refilled
+      content:
+        application/json:
+          schema: 
+            type: object
+            properties:
+              message:
+                type: string
+                description: The error message
+              exception:
+                type: string
+                description: The exception type
+          example:
+            message: Error occurred when starting process 5524355418393634511. Case creation limit reached.
+            exception: org.bonitasoft.web.toolkit.client.common.exception.api.APITooManyRequestException
     '5XX':
       $ref: '../components/responses/ServerError.yaml'
   x-codegen-request-body-name: body

diff --git a/openapi/paths/API@bpm@process@{id}@instantiation.yaml b/openapi/paths/API@bpm@process@{id}@instantiation.yaml
@@ -52,6 +52,32 @@ post:
               - "Expected input [ticket_account] is missing"
               - "Expected input [ticket_description] is missing"
               - "Expected input [ticket_subject] is missing"
+    '429':
+      description: Case creation limit reached (Community 2024.3+ only)
+      headers:
+        Retry-After:
+          schema:
+            type: string
+            format: date-time
+          description: Date when case counter will be refilled
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              code:	
+                type: number
+                description: The response status code
+              description:
+                type: string
+                description: The status description
+              reasonPhrase:
+                type: string
+                description: The detail of the reason
+          example:
+            code: 429
+            description: Unable to start the process with ID 5524355418393634511
+            reasonPhrase: Case creation limit reached.
     '5XX':
       $ref: '../components/responses/ServerError.yaml'
   x-codegen-request-body-name: body