Explorar o código

docs(api): add 429 to document read/update/delete ops (rate-limited scoped keys)

Fszontagh hai 1 mes
pai
achega
089aa6ed21
Modificáronse 1 ficheiros con 10 adicións e 5 borrados
  1. 10 5
      api/openapi.json

+ 10 - 5
api/openapi.json

@@ -521,7 +521,8 @@
           },
           },
           "401": { "description": "Unauthorized" },
           "401": { "description": "Unauthorized" },
           "403": { "description": "Forbidden" },
           "403": { "description": "Forbidden" },
-          "404": { "description": "Collection not found" }
+          "404": { "description": "Collection not found" },
+          "429": { "description": "Too Many Requests (rate-limited scoped key)" }
         }
         }
       },
       },
       "post": {
       "post": {
@@ -603,7 +604,8 @@
           },
           },
           "401": { "description": "Unauthorized" },
           "401": { "description": "Unauthorized" },
           "403": { "description": "Forbidden" },
           "403": { "description": "Forbidden" },
-          "404": { "description": "Document not found" }
+          "404": { "description": "Document not found" },
+          "429": { "description": "Too Many Requests (rate-limited scoped key)" }
         }
         }
       },
       },
       "put": {
       "put": {
@@ -622,7 +624,8 @@
           "401": { "description": "Unauthorized" },
           "401": { "description": "Unauthorized" },
           "403": { "description": "Forbidden" },
           "403": { "description": "Forbidden" },
           "404": { "description": "Collection not found" },
           "404": { "description": "Collection not found" },
-          "422": { "description": "Validation error" }
+          "422": { "description": "Validation error" },
+          "429": { "description": "Too Many Requests (rate-limited scoped key)" }
         }
         }
       },
       },
       "patch": {
       "patch": {
@@ -641,7 +644,8 @@
           "401": { "description": "Unauthorized" },
           "401": { "description": "Unauthorized" },
           "403": { "description": "Forbidden" },
           "403": { "description": "Forbidden" },
           "404": { "description": "Document not found" },
           "404": { "description": "Document not found" },
-          "422": { "description": "Validation error" }
+          "422": { "description": "Validation error" },
+          "429": { "description": "Too Many Requests (rate-limited scoped key)" }
         }
         }
       },
       },
       "delete": {
       "delete": {
@@ -651,7 +655,8 @@
           "200": { "description": "Document deleted" },
           "200": { "description": "Document deleted" },
           "401": { "description": "Unauthorized" },
           "401": { "description": "Unauthorized" },
           "403": { "description": "Forbidden" },
           "403": { "description": "Forbidden" },
-          "404": { "description": "Document not found" }
+          "404": { "description": "Document not found" },
+          "429": { "description": "Too Many Requests (rate-limited scoped key)" }
         }
         }
       }
       }
     },
     },