Skip to content

Commit

Permalink
Merge pull request #91 from apivideo/api-rate-limiting-oas
Browse files Browse the repository at this point in the history
Add API rate limiting to the OAS
  • Loading branch information
bot-api-video authored Apr 18, 2024
2 parents 6f4f6d7 + 84ca590 commit 301b28c
Show file tree
Hide file tree
Showing 76 changed files with 625 additions and 101 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,7 @@ Method | HTTP request | Description
- [RestreamsResponseObject](https://github.com/apivideo/api.video-python-client/blob/main/docs/RestreamsResponseObject.md)
- [TokenCreationPayload](https://github.com/apivideo/api.video-python-client/blob/main/docs/TokenCreationPayload.md)
- [TokenListResponse](https://github.com/apivideo/api.video-python-client/blob/main/docs/TokenListResponse.md)
- [TooManyRequests](https://github.com/apivideo/api.video-python-client/blob/main/docs/TooManyRequests.md)
- [UploadToken](https://github.com/apivideo/api.video-python-client/blob/main/docs/UploadToken.md)
- [Video](https://github.com/apivideo/api.video-python-client/blob/main/docs/Video.md)
- [VideoAssets](https://github.com/apivideo/api.video-python-client/blob/main/docs/VideoAssets.md)
Expand Down
1 change: 1 addition & 0 deletions apivideo/api/analytics_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
from apivideo.model.analytics_plays_response import AnalyticsPlaysResponse
from apivideo.model.model403_error_schema import Model403ErrorSchema
from apivideo.model.not_found import NotFound
from apivideo.model.too_many_requests import TooManyRequests


class AnalyticsApi(_EndPoint):
Expand Down
1 change: 1 addition & 0 deletions apivideo/api/captions_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
from apivideo.model.captions_list_response import CaptionsListResponse
from apivideo.model.captions_update_payload import CaptionsUpdatePayload
from apivideo.model.not_found import NotFound
from apivideo.model.too_many_requests import TooManyRequests


class CaptionsApi(_EndPoint):
Expand Down
1 change: 1 addition & 0 deletions apivideo/api/chapters_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
from apivideo.model.chapter import Chapter
from apivideo.model.chapters_list_response import ChaptersListResponse
from apivideo.model.not_found import NotFound
from apivideo.model.too_many_requests import TooManyRequests


class ChaptersApi(_EndPoint):
Expand Down
1 change: 1 addition & 0 deletions apivideo/api/live_streams_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
from apivideo.model.live_stream_list_response import LiveStreamListResponse
from apivideo.model.live_stream_update_payload import LiveStreamUpdatePayload
from apivideo.model.not_found import NotFound
from apivideo.model.too_many_requests import TooManyRequests


class LiveStreamsApi(_EndPoint):
Expand Down
1 change: 1 addition & 0 deletions apivideo/api/player_themes_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
from apivideo.model.player_theme_creation_payload import PlayerThemeCreationPayload
from apivideo.model.player_theme_update_payload import PlayerThemeUpdatePayload
from apivideo.model.player_themes_list_response import PlayerThemesListResponse
from apivideo.model.too_many_requests import TooManyRequests


class PlayerThemesApi(_EndPoint):
Expand Down
1 change: 1 addition & 0 deletions apivideo/api/upload_tokens_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
from apivideo.model.not_found import NotFound
from apivideo.model.token_creation_payload import TokenCreationPayload
from apivideo.model.token_list_response import TokenListResponse
from apivideo.model.too_many_requests import TooManyRequests
from apivideo.model.upload_token import UploadToken


Expand Down
1 change: 1 addition & 0 deletions apivideo/api/videos_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
from apivideo.exceptions import ApiTypeError, ApiValueError
from apivideo.model.bad_request import BadRequest
from apivideo.model.not_found import NotFound
from apivideo.model.too_many_requests import TooManyRequests
from apivideo.model.video import Video
from apivideo.model.video_creation_payload import VideoCreationPayload
from apivideo.model.video_status import VideoStatus
Expand Down
1 change: 1 addition & 0 deletions apivideo/api/watermarks_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
from apivideo.exceptions import ApiTypeError, ApiValueError
from apivideo.model.bad_request import BadRequest
from apivideo.model.not_found import NotFound
from apivideo.model.too_many_requests import TooManyRequests
from apivideo.model.watermark import Watermark
from apivideo.model.watermarks_list_response import WatermarksListResponse

Expand Down
1 change: 1 addition & 0 deletions apivideo/api/webhooks_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
from apivideo.exceptions import ApiTypeError, ApiValueError
from apivideo.model.bad_request import BadRequest
from apivideo.model.not_found import NotFound
from apivideo.model.too_many_requests import TooManyRequests
from apivideo.model.webhook import Webhook
from apivideo.model.webhooks_creation_payload import WebhooksCreationPayload
from apivideo.model.webhooks_list_response import WebhooksListResponse
Expand Down
171 changes: 171 additions & 0 deletions apivideo/model/too_many_requests.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
"""
api.video
api.video is an API that encodes on the go to facilitate immediate playback, enhancing viewer streaming experiences across multiple devices and platforms. You can stream live or on-demand online videos within minutes. # noqa: E501
Contact: [email protected]
"""


import re # noqa: F401
import sys # noqa: F401

from apivideo.model_utils import ( # noqa: F401
ApiTypeError,
ModelComposed,
ModelNormal,
ModelSimple,
cached_property,
change_keys_js_to_python,
convert_js_args_to_python_args,
date,
datetime,
file_type,
none_type,
validate_get_composed_info,
)


class TooManyRequests(ModelNormal):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
Do not edit the class manually.
Attributes:
allowed_values (dict): The key is the tuple path to the attribute
and the for var_name this is (var_name,). The value is a dict
with a capitalized key describing the allowed value and an allowed
value. These dicts store the allowed enum values.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
discriminator_value_class_map (dict): A dict to go from the discriminator
variable value to the discriminator class name.
validations (dict): The key is the tuple path to the attribute
and the for var_name this is (var_name,). The value is a dict
that stores validations for max_length, min_length, max_items,
min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
inclusive_minimum, and regex.
additional_properties_type (tuple): A tuple of classes accepted
as additional properties values.
"""

allowed_values = {
}

validations = {
}

additional_properties_type = None

_nullable = False

@cached_property
def openapi_types():
"""
This must be a method because a model may have properties that are
of type self, this must run after the class is loaded
Returns
openapi_types (dict): The key is attribute name
and the value is attribute type.
"""
return {
'type': (str,), # noqa: E501
'title': (str,), # noqa: E501
'status': (int,), # noqa: E501
}

@cached_property
def discriminator():
return None


attribute_map = {
'type': 'type', # noqa: E501
'title': 'title', # noqa: E501
'status': 'status', # noqa: E501
}

_composed_schemas = {}

required_properties = set([
'_data_store',
'_check_type',
'_spec_property_naming',
'_path_to_item',
'_configuration',
'_visited_composed_classes',
])

@convert_js_args_to_python_args
def __init__(self, *args, **kwargs): # noqa: E501
"""TooManyRequests - a model defined in OpenAPI
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types
will be type checked and a TypeError will be
raised if the wrong type is input.
Defaults to True
_path_to_item (tuple/list): This is a list of keys or values to
drill down to the model in received_data
when deserializing a response
_spec_property_naming (bool): True if the variable names in the input data
are serialized names, as specified in the OpenAPI document.
False if the variable names in the input data
are pythonic names, e.g. snake case (default)
_configuration (Configuration): the instance to use when
deserializing a file_type parameter.
If passed, type conversion is attempted
If omitted no type conversion is done.
_visited_composed_classes (tuple): This stores a tuple of
classes that we have traveled through so that
if we see that class again we will not use its
discriminator again.
When traveling through a discriminator, the
composed schema that is
is traveled through is added to this set.
For example if Animal has a discriminator
petType and we pass in "Dog", and the class Dog
allOf includes Animal, we move through Animal
once using the discriminator, and pick Dog.
Then in Dog, we will make an instance of the
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
type (str): A link to the error documentation.. [optional] # noqa: E501
title (str): A description of the error that occurred.. [optional] # noqa: E501
status (int): The HTTP status code.. [optional] # noqa: E501
"""

_check_type = kwargs.pop('_check_type', True)
_spec_property_naming = kwargs.pop('_spec_property_naming', False)
_path_to_item = kwargs.pop('_path_to_item', ())
_configuration = kwargs.pop('_configuration', None)
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())

if args:
raise ApiTypeError(
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
args,
self.__class__.__name__,
),
path_to_item=_path_to_item,
valid_classes=(self.__class__,),
)

self._data_store = {}
self._check_type = _check_type
self._spec_property_naming = _spec_property_naming
self._path_to_item = _path_to_item
self._configuration = _configuration
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)

for var_name, var_value in kwargs.items():
if var_name not in self.attribute_map and \
self._configuration is not None and \
self._configuration.discard_unknown_keys and \
self.additional_properties_type is None:
# discard variable.
continue
setattr(self, var_name, var_value)
20 changes: 12 additions & 8 deletions docs/AnalyticsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Retrieve filtered analytics about the number of plays for your live streams in a
import apivideo
from apivideo.api import analytics_api
from apivideo.model.model403_error_schema import Model403ErrorSchema
from apivideo.model.too_many_requests import TooManyRequests
from apivideo.model.analytics_plays_response import AnalyticsPlaysResponse
from apivideo.model.not_found import NotFound
from apivideo.model.analytics_plays400_error import AnalyticsPlays400Error
Expand Down Expand Up @@ -81,10 +82,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 All @@ -101,6 +103,7 @@ Retrieve filtered analytics about the number of plays for your videos in a proje
import apivideo
from apivideo.api import analytics_api
from apivideo.model.model403_error_schema import Model403ErrorSchema
from apivideo.model.too_many_requests import TooManyRequests
from apivideo.model.analytics_plays_response import AnalyticsPlaysResponse
from apivideo.model.not_found import NotFound
from apivideo.model.analytics_plays400_error import AnalyticsPlays400Error
Expand Down Expand Up @@ -161,10 +164,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)

Loading

0 comments on commit 301b28c

Please sign in to comment.