146 lines
13 KiB
Python
146 lines
13 KiB
Python
# coding: utf-8
|
|
|
|
"""
|
|
PeerTube
|
|
|
|
The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [REST API quick start](https://docs.joinpeertube.org/api/rest-getting-started) for a few examples of using the PeerTube API. # Authentication When you sign up for an account on a PeerTube instance, you are given the possibility to generate sessions on it, and authenticate there using an access token. Only __one access token can currently be used at a time__. ## Roles Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/admin/managing-users#roles) for a detail of their permissions. # Errors The API uses standard HTTP status codes to indicate the success or failure of the API call, completed by a [RFC7807-compliant](https://tools.ietf.org/html/rfc7807) response body. ``` HTTP 1.1 404 Not Found Content-Type: application/problem+json; charset=utf-8 { \"detail\": \"Video not found\", \"docs\": \"https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo\", \"status\": 404, \"title\": \"Not Found\", \"type\": \"about:blank\" } ``` We provide error `type` values for [a growing number of cases](https://github.com/Chocobozzz/PeerTube/blob/develop/packages/models/src/server/core-error-code.enum.ts), but it is still optional. Types are used to disambiguate errors that bear the same status code and are non-obvious: ``` HTTP 1.1 403 Forbidden Content-Type: application/problem+json; charset=utf-8 { \"detail\": \"Cannot get this video regarding follow constraints\", \"docs\": \"https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo\", \"status\": 403, \"title\": \"Forbidden\", \"type\": \"https://docs.joinpeertube.org/api-rest-reference.html#section/Errors/does_not_respect_follow_constraints\" } ``` Here a 403 error could otherwise mean that the video is private or blocklisted. ### Validation errors Each parameter is evaluated on its own against a set of rules before the route validator proceeds with potential testing involving parameter combinations. Errors coming from validation errors appear earlier and benefit from a more detailed error description: ``` HTTP 1.1 400 Bad Request Content-Type: application/problem+json; charset=utf-8 { \"detail\": \"Incorrect request parameters: id\", \"docs\": \"https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo\", \"instance\": \"/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180\", \"invalid-params\": { \"id\": { \"location\": \"params\", \"msg\": \"Invalid value\", \"param\": \"id\", \"value\": \"9c9de5e8-0a1e-484a-b099-e80766180\" } }, \"status\": 400, \"title\": \"Bad Request\", \"type\": \"about:blank\" } ``` Where `id` is the name of the field concerned by the error, within the route definition. `invalid-params.<field>.location` can be either 'params', 'body', 'header', 'query' or 'cookies', and `invalid-params.<field>.value` reports the value that didn't pass validation whose `invalid-params.<field>.msg` is about. ### Deprecated error fields Some fields could be included with previous versions. They are still included but their use is deprecated: - `error`: superseded by `detail` - `code`: superseded by `type` (which is now an URI) # Rate limits We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators: | Endpoint (prefix: `/api/v1`) | Calls | Time frame | |------------------------------|---------------|--------------| | `/*` | 50 | 10 seconds | | `POST /users/token` | 15 | 5 minutes | | `POST /users/register` | 2<sup>*</sup> | 5 minutes | | `POST /users/ask-send-verify-email` | 3 | 5 minutes | Depending on the endpoint, <sup>*</sup>failed requests are not taken into account. A service limit is announced by a `429 Too Many Requests` status code. You can get details about the current state of your rate limit by reading the following headers: | Header | Description | |-------------------------|------------------------------------------------------------| | `X-RateLimit-Limit` | Number of max requests allowed in the current time period | | `X-RateLimit-Remaining` | Number of remaining requests in the current time period | | `X-RateLimit-Reset` | Timestamp of end of current time period as UNIX timestamp | | `Retry-After` | Seconds to delay after the first `429` is received | # CORS This API features [Cross-Origin Resource Sharing (CORS)](https://fetch.spec.whatwg.org/), allowing cross-domain communication from the browser for some routes: | Endpoint | |------------------------- ---| | `/api/*` | | `/download/*` | | `/lazy-static/*` | | `/.well-known/webfinger` | In addition, all routes serving ActivityPub are CORS-enabled for all origins.
|
|
|
|
The version of the OpenAPI document: 5.2.0
|
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
|
|
Do not edit the class manually.
|
|
""" # noqa: E501
|
|
|
|
|
|
import unittest
|
|
|
|
from peertube.models.server_config import ServerConfig
|
|
|
|
class TestServerConfig(unittest.TestCase):
|
|
"""ServerConfig unit test stubs"""
|
|
|
|
def setUp(self):
|
|
pass
|
|
|
|
def tearDown(self):
|
|
pass
|
|
|
|
def make_instance(self, include_optional) -> ServerConfig:
|
|
"""Test ServerConfig
|
|
include_option is a boolean, when False only required
|
|
params are included, when True both required and
|
|
optional params are included """
|
|
# uncomment below to create an instance of `ServerConfig`
|
|
"""
|
|
model = ServerConfig()
|
|
if include_optional:
|
|
return ServerConfig(
|
|
instance = peertube.models.server_config_instance.ServerConfig_instance(
|
|
name = '',
|
|
short_description = '',
|
|
default_client_route = '',
|
|
is_nsfw = True,
|
|
default_nsfw_policy = '',
|
|
customizations = peertube.models.server_config_instance_customizations.ServerConfig_instance_customizations(
|
|
javascript = '',
|
|
css = '', ), ),
|
|
search = peertube.models.server_config_search.ServerConfig_search(
|
|
remote_uri = peertube.models.server_config_search_remote_uri.ServerConfig_search_remoteUri(
|
|
users = True,
|
|
anonymous = True, ), ),
|
|
plugin = peertube.models.server_config_plugin.ServerConfig_plugin(
|
|
registered = [
|
|
''
|
|
], ),
|
|
theme = peertube.models.server_config_plugin.ServerConfig_plugin(
|
|
registered = [
|
|
''
|
|
], ),
|
|
email = peertube.models.server_config_email.ServerConfig_email(
|
|
enabled = True, ),
|
|
contact_form = peertube.models.server_config_email.ServerConfig_email(
|
|
enabled = True, ),
|
|
server_version = '',
|
|
server_commit = '',
|
|
signup = peertube.models.server_config_signup.ServerConfig_signup(
|
|
allowed = True,
|
|
allowed_for_current_ip = True,
|
|
requires_email_verification = True, ),
|
|
transcoding = peertube.models.server_config_transcoding.ServerConfig_transcoding(
|
|
hls = peertube.models.server_config_email.ServerConfig_email(
|
|
enabled = True, ),
|
|
web_videos = peertube.models.server_config_email.ServerConfig_email(
|
|
enabled = True, ),
|
|
enabled_resolutions = [
|
|
240
|
|
], ),
|
|
var_import = peertube.models.server_config_import.ServerConfig_import(
|
|
videos = peertube.models.server_config_import_videos.ServerConfig_import_videos(
|
|
http = peertube.models.server_config_email.ServerConfig_email(
|
|
enabled = True, ),
|
|
torrent = peertube.models.server_config_email.ServerConfig_email(
|
|
enabled = True, ), ),
|
|
video_channel_synchronization = , ),
|
|
auto_blacklist = peertube.models.server_config_auto_blacklist.ServerConfig_autoBlacklist(
|
|
videos = peertube.models.server_config_auto_blacklist_videos.ServerConfig_autoBlacklist_videos(
|
|
of_users = peertube.models.server_config_email.ServerConfig_email(
|
|
enabled = True, ), ), ),
|
|
avatar = peertube.models.server_config_avatar.ServerConfig_avatar(
|
|
file = peertube.models.server_config_avatar_file.ServerConfig_avatar_file(
|
|
size = peertube.models.server_config_avatar_file_size.ServerConfig_avatar_file_size(
|
|
max = 56, ), ),
|
|
extensions = [
|
|
''
|
|
], ),
|
|
video = peertube.models.server_config_video.ServerConfig_video(
|
|
image = peertube.models.server_config_video_image.ServerConfig_video_image(
|
|
extensions = [
|
|
''
|
|
],
|
|
size = peertube.models.server_config_avatar_file_size.ServerConfig_avatar_file_size(
|
|
max = 56, ), ),
|
|
file = peertube.models.server_config_video_file.ServerConfig_video_file(), ),
|
|
video_caption = peertube.models.server_config_video_caption.ServerConfig_videoCaption(
|
|
file = peertube.models.server_config_video_caption_file.ServerConfig_videoCaption_file(
|
|
size = peertube.models.server_config_avatar_file_size.ServerConfig_avatar_file_size(
|
|
max = 56, ),
|
|
extensions = [
|
|
''
|
|
], ), ),
|
|
user = peertube.models.server_config_user.ServerConfig_user(
|
|
video_quota = 16810141515,
|
|
video_quota_daily = 1681014151, ),
|
|
trending = peertube.models.server_config_trending.ServerConfig_trending(
|
|
videos = peertube.models.server_config_trending_videos.ServerConfig_trending_videos(
|
|
interval_days = 56, ), ),
|
|
tracker = peertube.models.server_config_email.ServerConfig_email(
|
|
enabled = True, ),
|
|
followings = peertube.models.server_config_followings.ServerConfig_followings(
|
|
instance = peertube.models.server_config_followings_instance.ServerConfig_followings_instance(
|
|
auto_follow_index = peertube.models.server_config_followings_instance_auto_follow_index.ServerConfig_followings_instance_autoFollowIndex(
|
|
index_url = '', ), ), ),
|
|
homepage = peertube.models.server_config_email.ServerConfig_email(
|
|
enabled = True, ),
|
|
open_telemetry = peertube.models.server_config_open_telemetry.ServerConfig_openTelemetry(
|
|
metrics = peertube.models.server_config_open_telemetry_metrics.ServerConfig_openTelemetry_metrics(
|
|
enabled = True,
|
|
playback_stats_interval = 1.337, ), ),
|
|
views = peertube.models.server_config_views.ServerConfig_views(
|
|
views = peertube.models.server_config_views_views.ServerConfig_views_views(
|
|
watching_interval = peertube.models.server_config_views_views_watching_interval.ServerConfig_views_views_watchingInterval(
|
|
anonymous = 1.337,
|
|
users = 1.337, ), ), )
|
|
)
|
|
else:
|
|
return ServerConfig(
|
|
)
|
|
"""
|
|
|
|
def testServerConfig(self):
|
|
"""Test ServerConfig"""
|
|
# inst_req_only = self.make_instance(include_optional=False)
|
|
# inst_req_and_optional = self.make_instance(include_optional=True)
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|