# 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..location` can be either 'params', 'body', 'header', 'query' or 'cookies', and `invalid-params..value` reports the value that didn't pass validation whose `invalid-params..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* | 5 minutes | | `POST /users/ask-send-verify-email` | 3 | 5 minutes | Depending on the endpoint, *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 from __future__ import annotations import pprint import re # noqa: F401 import json from pydantic import BaseModel, Field, StrictBool, StrictStr, field_validator from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self class UpdateMe(BaseModel): """ UpdateMe """ # noqa: E501 password: Optional[Annotated[str, Field(min_length=6, strict=True, max_length=255)]] = None current_password: Optional[Annotated[str, Field(min_length=6, strict=True, max_length=255)]] = Field(default=None, alias="currentPassword") email: Optional[Email] = Field(default=None, description="new email used for login and service communications") display_name: Optional[Annotated[str, Field(min_length=3, strict=True, max_length=120)]] = Field(default=None, description="new name of the user in its representations", alias="displayName") display_nsfw: Optional[StrictStr] = Field(default=None, description="new NSFW display policy", alias="displayNSFW") p2p_enabled: Optional[StrictBool] = Field(default=None, description="whether to enable P2P in the player or not", alias="p2pEnabled") auto_play_video: Optional[StrictBool] = Field(default=None, description="new preference regarding playing videos automatically", alias="autoPlayVideo") auto_play_next_video: Optional[StrictBool] = Field(default=None, description="new preference regarding playing following videos automatically", alias="autoPlayNextVideo") auto_play_next_video_playlist: Optional[StrictBool] = Field(default=None, description="new preference regarding playing following playlist videos automatically", alias="autoPlayNextVideoPlaylist") videos_history_enabled: Optional[StrictBool] = Field(default=None, description="whether to keep track of watched history or not", alias="videosHistoryEnabled") video_languages: Optional[List[StrictStr]] = Field(default=None, description="list of languages to filter videos down to", alias="videoLanguages") theme: Optional[StrictStr] = None no_instance_config_warning_modal: Optional[StrictBool] = Field(default=None, alias="noInstanceConfigWarningModal") no_account_setup_warning_modal: Optional[StrictBool] = Field(default=None, alias="noAccountSetupWarningModal") no_welcome_modal: Optional[StrictBool] = Field(default=None, alias="noWelcomeModal") __properties: ClassVar[List[str]] = ["password", "currentPassword", "email", "displayName", "displayNSFW", "p2pEnabled", "autoPlayVideo", "autoPlayNextVideo", "autoPlayNextVideoPlaylist", "videosHistoryEnabled", "videoLanguages", "theme", "noInstanceConfigWarningModal", "noAccountSetupWarningModal", "noWelcomeModal"] @field_validator('display_nsfw') def display_nsfw_validate_enum(cls, value): """Validates the enum""" if value is None: return value if value not in ('true', 'false', 'both'): raise ValueError("must be one of enum values ('true', 'false', 'both')") return value model_config = { "populate_by_name": True, "validate_assignment": True, "protected_namespaces": (), } def to_str(self) -> str: """Returns the string representation of the model using alias""" return pprint.pformat(self.model_dump(by_alias=True)) def to_json(self) -> str: """Returns the JSON representation of the model using alias""" # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead return json.dumps(self.to_dict()) @classmethod def from_json(cls, json_str: str) -> Optional[Self]: """Create an instance of UpdateMe from a JSON string""" return cls.from_dict(json.loads(json_str)) def to_dict(self) -> Dict[str, Any]: """Return the dictionary representation of the model using alias. This has the following differences from calling pydantic's `self.model_dump(by_alias=True)`: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. """ excluded_fields: Set[str] = set([ ]) _dict = self.model_dump( by_alias=True, exclude=excluded_fields, exclude_none=True, ) # override the default output from pydantic by calling `to_dict()` of email if self.email: _dict['email'] = self.email.to_dict() return _dict @classmethod def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: """Create an instance of UpdateMe from a dict""" if obj is None: return None if not isinstance(obj, dict): return cls.model_validate(obj) _obj = cls.model_validate({ "password": obj.get("password"), "currentPassword": obj.get("currentPassword"), "email": Email.from_dict(obj["email"]) if obj.get("email") is not None else None, "displayName": obj.get("displayName"), "displayNSFW": obj.get("displayNSFW"), "p2pEnabled": obj.get("p2pEnabled"), "autoPlayVideo": obj.get("autoPlayVideo"), "autoPlayNextVideo": obj.get("autoPlayNextVideo"), "autoPlayNextVideoPlaylist": obj.get("autoPlayNextVideoPlaylist"), "videosHistoryEnabled": obj.get("videosHistoryEnabled"), "videoLanguages": obj.get("videoLanguages"), "theme": obj.get("theme"), "noInstanceConfigWarningModal": obj.get("noInstanceConfigWarningModal"), "noAccountSetupWarningModal": obj.get("noAccountSetupWarningModal"), "noWelcomeModal": obj.get("noWelcomeModal") }) return _obj