add the schema for the x-correlator and change the 429 examples

add the schema for the x-correlator change the examples for error response 429 to the latest version
camaraproject · Feb 11, 2025 · 6bc8945 · 6bc8945
1 parent a374342
commit 6bc8945
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/code/API_definitions/region-device-count.yaml b/code/API_definitions/region-device-count.yaml
@@ -179,13 +179,17 @@ components:
       description: Correlation id for the different services
       schema:
         type: string
+        pattern: ^[a-zA-Z0-9-]{0,55}$
+        example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
   parameters:
     x-correlator:
       name: x-correlator
       in: header
       description: Correlation id for the different services
       schema:
         type: string
+        pattern: ^[a-zA-Z0-9-]{0,55}$
+        example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46"
   schemas:
     RegionDeviceCountRequestBody:
       type: object
@@ -653,13 +657,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.
   examples:
     RETRIEVAL_CIRCLE:
       value: