Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions openapi/paths/API@[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -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:
akantcheff marked this conversation as resolved.
Show resolved Hide resolved
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
Expand Down
26 changes: 26 additions & 0 deletions openapi/paths/API@bpm@process@{id}@instantiation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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