Skip to content

Commit

Permalink
Add API rate limiting to the OAS
Browse files Browse the repository at this point in the history
  • Loading branch information
@szekelyzol
szekelyzol authored Apr 16, 2024
1 parent f6af497 commit 5796fa8
Show file tree
Hide file tree
Showing 61 changed files with 456 additions and 102 deletions.
3 changes: 3 additions & 0 deletions .openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ docs/RestreamsRequestObject.md
docs/RestreamsResponseObject.md
docs/TokenCreationPayload.md
docs/TokenListResponse.md
docs/TooManyRequests.md
docs/UploadToken.md
docs/UploadTokensApi.md
docs/Video.md
Expand Down Expand Up @@ -142,6 +143,7 @@ src/ApiVideo.Test/Model/RestreamsRequestObjectTests.cs
src/ApiVideo.Test/Model/RestreamsResponseObjectTests.cs
src/ApiVideo.Test/Model/TokenCreationPayloadTests.cs
src/ApiVideo.Test/Model/TokenListResponseTests.cs
src/ApiVideo.Test/Model/TooManyRequestsTests.cs
src/ApiVideo.Test/Model/UploadTokenTests.cs
src/ApiVideo.Test/Model/VideoAssetsTests.cs
src/ApiVideo.Test/Model/VideoClipTests.cs
Expand Down Expand Up @@ -237,6 +239,7 @@ src/ApiVideo/Model/RestreamsRequestObject.cs
src/ApiVideo/Model/RestreamsResponseObject.cs
src/ApiVideo/Model/TokenCreationPayload.cs
src/ApiVideo/Model/TokenListResponse.cs
src/ApiVideo/Model/TooManyRequests.cs
src/ApiVideo/Model/UploadToken.cs
src/ApiVideo/Model/Video.cs
src/ApiVideo/Model/VideoAssets.cs
Expand Down
2 changes: 1 addition & 1 deletion .openapi-generator/oas_apivideo.yaml-defaut-cli.sha256
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
5678c55d78ebee898e89b47215b59cb855d1997cdda9202292548ec786d8e9f5
d7b342ceb1a4805da9e3d6355384e34c1a99e1300d01cac3ae3218c5738f11f1
1 change: 1 addition & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,7 @@ Method | HTTP request | Description
- [RestreamsResponseObject](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/RestreamsResponseObject.md)
- [TokenCreationPayload](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/TokenCreationPayload.md)
- [TokenListResponse](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/TokenListResponse.md)
- [TooManyRequests](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/TooManyRequests.md)
- [UploadToken](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/UploadToken.md)
- [Video](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/Video.md)
- [VideoAssets](https://github.com/apivideo/api.video-csharp-client/blob/main/docs/VideoAssets.md)
Expand Down
18 changes: 10 additions & 8 deletions docs/AnalyticsApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,11 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success | - |
| **400** | Bad request error | - |
| **403** | Forbidden - Disabled Analytics | - |
| **404** | Not Found | - |
| **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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **400** | Bad request error | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **403** | Forbidden - Disabled Analytics | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **404** | Not Found | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **429** | Too Many Requests | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Expand Down Expand Up @@ -159,10 +160,11 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success | - |
| **400** | Bad request error | - |
| **403** | Forbidden - Disabled Analytics | - |
| **404** | Not Found | - |
| **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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **400** | Bad request error | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **403** | Forbidden - Disabled Analytics | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **404** | Not Found | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **429** | Too Many Requests | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

33 changes: 19 additions & 14 deletions docs/CaptionsApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,10 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success | - |
| **400** | Bad request error | - |
| **404** | Not Found | - |
| **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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **400** | Bad request error | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **404** | Not Found | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **429** | Too Many Requests | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Expand Down Expand Up @@ -149,9 +150,10 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success | - |
| **400** | Bad request error | - |
| **404** | Not Found | - |
| **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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **400** | Bad request error | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **404** | Not Found | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **429** | Too Many Requests | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Expand Down Expand Up @@ -221,9 +223,10 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success | - |
| **400** | Bad request error | - |
| **404** | Not Found | - |
| **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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **400** | Bad request error | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **404** | Not Found | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **429** | Too Many Requests | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Expand Down Expand Up @@ -290,9 +293,10 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **204** | No Content | - |
| **400** | Bad request error | - |
| **404** | Not Found | - |
| **204** | No Content | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **400** | Bad request error | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **404** | Not Found | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **429** | Too Many Requests | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Expand Down Expand Up @@ -362,8 +366,9 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success | - |
| **404** | Not Found | - |
| **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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **404** | Not Found | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **429** | Too Many Requests | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

22 changes: 13 additions & 9 deletions docs/ChaptersApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,10 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success | - |
| **400** | Bad Request | - |
| **404** | Not Found | - |
| **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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **400** | Bad Request | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **404** | Not Found | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **429** | Too Many Requests | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Expand Down Expand Up @@ -146,8 +147,9 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success | - |
| **404** | Not Found | - |
| **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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **404** | Not Found | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **429** | Too Many Requests | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Expand Down Expand Up @@ -214,8 +216,9 @@ void (empty response body)
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **204** | No Content | - |
| **404** | Not Found | - |
| **204** | No Content | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **404** | Not Found | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **429** | Too Many Requests | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Expand Down Expand Up @@ -285,8 +288,9 @@ Name | Type | Description | Notes
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success | - |
| **404** | Not Found | - |
| **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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **404** | Not Found | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |
| **429** | Too Many Requests | * 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-Retry-After - The number of seconds left until the current rate limit window resets. <br> |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Loading

0 comments on commit 5796fa8

Please sign in to comment.