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.

Sign up for GitHub

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

Updated message field and description for Error 429 #390

Merged
merged 4 commits into from
Jan 24, 2025
Merged

Updated message field and description for Error 429 #390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
735691e
Update API-design-guidelines.md
rartych Jan 22, 2025
e25a588
Update CAMARA_common.yaml
rartych Jan 22, 2025
764bd3f
Update CAMARA_common.yaml
rartych Jan 22, 2025
a3b4103
Update API-design-guidelines.md
rartych Jan 22, 2025
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
6 changes: 3 additions & 3 deletions artifacts/CAMARA_common.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -666,13 +666,13 @@ components:
value:
status: 429
code: QUOTA_EXCEEDED
message: Either out of resource quota or reaching rate limiting.
message: Out of resource quota.
GENERIC_429_TOO_MANY_REQUESTS:
description: API Server request limit is overpassed
description: Access to the API has been temporarily blocked due to rate or spike arrest limits being reached
value:
status: 429
code: TOO_MANY_REQUESTS
message: Either out of resource quota or reaching rate limiting.
message: Rate limit reached.
Generic500:
description: Internal Server Error
headers:
Expand Down
4 changes: 2 additions & 2 deletions documentation/API-design-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -773,8 +773,8 @@ In the following, we elaborate on the existing client errors. In particular, we
| 422 | `SERVICE_NOT_APPLICABLE` | The service is not available for the provided identifier. | Service not applicable for the provided identifier |
| 422 | `MISSING_IDENTIFIER` | The device cannot be identified. | An identifier is not included in the request and the device or phone number identification cannot be derived from the 3-legged access token |
| 422 | `{{SPECIFIC_CODE}}` | `{{SPECIFIC_CODE_MESSAGE}}` | Any semantic condition associated to business logic, specifically related to a field or data structure |
| 429 | `QUOTA_EXCEEDED` | Either out of resource quota or reaching rate limiting. | Request is rejected due to exceeding a business quota limit |
| 429 | `TOO_MANY_REQUESTS` | Either out of resource quota or reaching rate limiting. | API Server request limit is overpassed |
| 429 | `QUOTA_EXCEEDED` | Out of resource quota. | Request is rejected due to exceeding a business quota limit |
| 429 | `TOO_MANY_REQUESTS` | Rate limit reached. | Access to the API has been temporarily blocked due to rate or spike arrest limits being reached |

<font size="3"><span style="color: blue"> Server Exceptions </span></font>

Expand Down