Merge pull request #390 from rartych/quota

Updated message field and description for Error 429
camaraproject · Jan 24, 2025 · ed04c87 · ed04c87
2 parents 76e2cb0 + a3b4103
commit ed04c87
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/artifacts/CAMARA_common.yaml b/artifacts/CAMARA_common.yaml
@@ -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:

diff --git a/documentation/API-design-guidelines.md b/documentation/API-design-guidelines.md
@@ -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>