Add API rate limiting to the OAS #115
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ThibaultBee
reviewed
Apr 11, 2024
docs/VideosApi.md
Outdated
| @@ -615,8 +621,9 @@ Name | Type | Description | Notes | |||
| ### HTTP response details | |||
| | Status code | Description | Response headers | | |||
| |-------------|-------------|------------------| | |||
| **200** | Success | - | | |||
| **200** | Success | * X-RateLimit-Limit - The request limit per minute. <br> * X-RateLimit-Remaining - The number of available requests left for the current time window. <br> * X-RateLimit-RetryAfter - The number of seconds left until the current rate limit window resets. <br> | | |||
There was a problem hiding this comment.
@szekelyzol formating is strange here
There was a problem hiding this comment.
I think this was autogenerated 😢
There was a problem hiding this comment.
Well it is properly displayed there: https://github.com/apivideo/api.video-java-client/blob/api-rate-limiting-oas/docs/VideosApi.md#http-response-details-6
ThibaultBee
reviewed
Apr 11, 2024
|
|
||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **type** | **String** | A link to the error documentation. | [optional] |
There was a problem hiding this comment.
just to confirm: type is just a link to the documentation?
There was a problem hiding this comment.
Yes, in API error responses type always links to the docs
bot-api-video
force-pushed
the
api-rate-limiting-oas
branch
from
bac4753 to
295ed9e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes are for this Asana task.
Docs drafts are here.
Summary
429 - Too many requestserror response schema and example to every endpoint except/auth200response ofGET /videosas a test: