feat: Add rate limit exceeded response to openapi.yml

OneBusAway · Aug 20, 2024 · f86965e · f86965e
1 parent 221f079
commit f86965e
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/openapi.yml b/openapi.yml
@@ -28,6 +28,8 @@ paths:
                         $ref: '#/components/schemas/CoverageResponse'
                     required:
                       - data
+        '429':
+          $ref: '#/components/responses/RateLimitExceeded'
 
   /api/where/agency/{agencyID}.json:
     get:
@@ -141,6 +143,9 @@ paths:
                     required:
                       - data
 
+        '404':
+          $ref: '#/components/responses/NotFound'
+
   /api/where/routes-for-location.json:
     get:
       tags:
@@ -2617,3 +2622,17 @@ components:
             currentTime: 1723054063108
             text: 'resource not found'
             version: 2
+
+    RateLimitExceeded:
+      description: Rate limit exceeded
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/ResponseWrapper'
+          examples:
+            rateLimitExceeded:
+              value:
+                code: 429
+                currentTime: 1724179666673
+                text: 'rate limit exceeded'
+                version: 1