Defined the "RateLimit", "RateLimitRemaining", and the "RateLimitUsed" headers for the Open API specification document in the library target.

2025-10-13 14:59:29 +02:00
parent 4637638264
commit 6c0653f589
1 changed files with 25 additions and 0 deletions
@@ -658,6 +658,31 @@ components:
      schema:
        type: string
        example: <https://api.discogs.com/artists/1/releases?page=2&per_page=75>; rel="next", <https://api.discogs.com/artists/1/releases?page=30&per_page=75>; rel="last"
+      required: true
+    RateLimit:
+      description: A total number of requests that can be made in a minute window.
+      schema:
+        type: integer
+        minimum: 25
+        maximum: 60
+        example: 60
+      required: true
+    RateLimitRemaining:
+      description: A number of remaining requests that can be made in an existing rate limit window.
+      schema:
+        type: integer
+        minimum: 0
+        maximum: 60
+        example: 59
+      required: true
+    RateLimitUsed:
+      description: A number of requests that have been made in an existing rate limit window.
+      schema:
+        type: integer
+        minimum: 0
+        maximum: 60
+        example: 1
+      required: true
  parameters:
    ArtistId:
      name: artist_id