interesting
/
PeerTube
mirror of https://github.com/Chocobozzz/PeerTube.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
PeerTube/support/doc/api/openapi.yaml

7786 lines
226 KiB
YAML
Raw Normal View History

migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
openapi: 3.0.0
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
info:
Add api doc in html
2018-01-24 04:54:32 -06:00
title: PeerTube
Updated notification types in openapi reference Relates to https://github.com/Chocobozzz/PeerTube/issues/1565
2021-12-22 04:01:24 -06:00
version: 4.0.0
updated REST API documentation
2018-11-13 16:27:58 -06:00
contact:
name: PeerTube Community
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
url: https://joinpeertube.org
updated REST API documentation
2018-11-13 16:27:58 -06:00
license:
name: AGPLv3.0
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
url: https://github.com/Chocobozzz/PeerTube/blob/master/LICENSE
updated REST API documentation
2018-11-13 16:27:58 -06:00
x-logo:
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
url: https://joinpeertube.org/img/brand.png
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
altText: PeerTube Project Homepage
updated REST API documentation
2018-11-13 16:27:58 -06:00
description: |
Openapi consistency
2020-04-21 05:09:54 -05:00
The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
[openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO)
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
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)
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
add rate limit table to openapi spec
2021-05-06 18:40:21 -05:00
See the [REST API quick start](https://docs.joinpeertube.org/api-rest-getting-started) for a few
add operationId to common operations
2021-05-24 12:38:26 -05:00
examples of using the PeerTube API.
Openapi consistency
2020-04-21 05:09:54 -05:00
updated REST API documentation
2018-11-13 16:27:58 -06:00
# Authentication
OpenAPI clients generation
2020-02-14 07:14:14 -06:00
add rate limit table to openapi spec
2021-05-06 18:40:21 -05:00
When you sign up for an account on a PeerTube instance, you are given the possibility
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
to generate sessions on it, and authenticate there using an access token. Only __one
access token can currently be used at a time__.
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
## Roles
Accounts are given permissions based on their role. There are three roles on
Use new doc website links
2021-02-12 03:12:19 -06:00
PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/admin-managing-users?id=roles) for a detail of their permissions.
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
# Errors
OpenAPI clients generation
2020-02-14 07:14:14 -06:00
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
The API uses standard HTTP status codes to indicate the success or failure
refactor API errors to standard error format
2021-05-31 18:36:53 -05:00
of the API call, completed by a [RFC7807-compliant](https://tools.ietf.org/html/rfc7807) response body.
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
```
more faithful error description in openapi spec
2021-05-13 07:10:04 -05:00
HTTP 1.1 404 Not Found
refactor API errors to standard error format
2021-05-31 18:36:53 -05:00
Content-Type: application/problem+json; charset=utf-8
more faithful error description in openapi spec
2021-05-13 07:10:04 -05:00
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
{
refactor API errors to standard error format
2021-05-31 18:36:53 -05:00
"detail": "Video not found",
refactor deprecated body-parser usage
2021-06-01 06:25:41 -05:00
"docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
refactor API errors to standard error format
2021-05-31 18:36:53 -05:00
"status": 404,
"title": "Not Found",
"type": "about:blank"
explicit error formatting variant in openapi spec
2021-05-10 18:18:02 -05:00
}
```
refactor error code values for URI compatibility
2021-06-02 07:28:30 -05:00
We provide error `type` values for [a growing number of cases](https://github.com/Chocobozzz/PeerTube/blob/develop/shared/models/server/server-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.
more faithful error description in openapi spec
2021-05-13 07:10:04 -05:00
### Validation errors
Each parameter is evaluated on its own against a set of rules before the route validator
refactor API errors to standard error format
2021-05-31 18:36:53 -05:00
proceeds with potential testing involving parameter combinations. Errors coming from validation
refactor error code values for URI compatibility
2021-06-02 07:28:30 -05:00
errors appear earlier and benefit from a more detailed error description:
add response content for createVideoChannel endpoint in openapi spec closes #4077
2021-05-12 06:44:32 -05:00
explicit error formatting variant in openapi spec
2021-05-10 18:18:02 -05:00
```
more faithful error description in openapi spec
2021-05-13 07:10:04 -05:00
HTTP 1.1 400 Bad Request
refactor API errors to standard error format
2021-05-31 18:36:53 -05:00
Content-Type: application/problem+json; charset=utf-8
more faithful error description in openapi spec
2021-05-13 07:10:04 -05:00
explicit error formatting variant in openapi spec
2021-05-10 18:18:02 -05:00
{
refactor API errors to standard error format
2021-05-31 18:36:53 -05:00
"detail": "Incorrect request parameters: id",
refactor deprecated body-parser usage
2021-06-01 06:25:41 -05:00
"docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
refactor API errors to standard error format
2021-05-31 18:36:53 -05:00
"instance": "/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180",
"invalid-params": {
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
"id": {
refactor API errors to standard error format
2021-05-31 18:36:53 -05:00
"location": "params",
"msg": "Invalid value",
explicit error formatting variant in openapi spec
2021-05-10 18:18:02 -05:00
"param": "id",
refactor API errors to standard error format
2021-05-31 18:36:53 -05:00
"value": "9c9de5e8-0a1e-484a-b099-e80766180"
explicit error formatting variant in openapi spec
2021-05-10 18:18:02 -05:00
}
refactor API errors to standard error format
2021-05-31 18:36:53 -05:00
},
"status": 400,
"title": "Bad Request",
"type": "about:blank"
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
}
```
add rate limit table to openapi spec
2021-05-06 18:40:21 -05:00
more faithful error description in openapi spec
2021-05-13 07:10:04 -05:00
Where `id` is the name of the field concerned by the error, within the route definition.
refactor API errors to standard error format
2021-05-31 18:36:53 -05:00
`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`
more faithful error description in openapi spec
2021-05-13 07:10:04 -05:00
is about.
refactor error code values for URI compatibility
2021-06-02 07:28:30 -05:00
### 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)
add rate limit table to openapi spec
2021-05-06 18:40:21 -05:00
# Rate limits
fix response in openapi spec for quota and video ratings closes #4064 closes #4065
2021-05-10 03:26:50 -05:00
We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators:
add rate limit table to openapi spec
2021-05-06 18:40:21 -05:00
add cors section in openapi spec
2021-05-12 14:21:52 -05:00
| 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 |
add rate limit table to openapi spec
2021-05-06 18:40:21 -05:00
add missing video comment fields in openapi spec closes #4079
2021-05-11 13:19:26 -05:00
Depending on the endpoint, <sup>*</sup>failed requests are not taken into account. A service
add rate limit table to openapi spec
2021-05-06 18:40:21 -05:00
limit is announced by a `429 Too Many Requests` status code.
relax guarantee on openapi rate limit doc accuracy
2021-05-07 02:46:22 -05:00
You can get details about the current state of your rate limit by reading the
following headers:
add rate limit table to openapi spec
2021-05-06 18:40:21 -05:00
| Header | Description |
|-------------------------|------------------------------------------------------------|
add response content for createVideoChannel endpoint in openapi spec closes #4077
2021-05-12 06:44:32 -05:00
| `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 |
add cors section in openapi spec
2021-05-12 14:21:52 -05:00
# CORS
This API features [Cross-Origin Resource Sharing (CORS)](https://fetch.spec.whatwg.org/),
allowing cross-domain communication from the browser for some routes:
Fix broken openapi schema
2021-05-27 04:52:03 -05:00
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
| Endpoint |
|------------------------- ---|
| `/api/*` |
| `/download/*` |
| `/lazy-static/*` |
| `/live/segments-sha256/*` |
| `/.well-known/webfinger` |
add cors section in openapi spec
2021-05-12 14:21:52 -05:00
In addition, all routes serving ActivityPub are CORS-enabled for all origins.
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
externalDocs:
Updated openapi.html ExternalDocs url
2019-07-06 08:11:26 -05:00
url: https://docs.joinpeertube.org/api-rest-reference.html
updated REST API documentation
2018-11-13 16:27:58 -06:00
tags:
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
- name: Register
description: |
As a visitor, you can use this API to open an account (if registrations are open on
Fix broken openapi schema
2021-05-27 04:52:03 -05:00
that PeerTube instance). As an admin, you should use the dedicated [User creation
add operationId to common operations
2021-05-24 12:38:26 -05:00
API](#operation/addUser) instead.
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
- name: Session
x-displayName: Login/Logout
description: |
Sessions deal with access tokens over time. Only __one session token can currently be used at a time__.
updated REST API documentation
2018-11-13 16:27:58 -06:00
- name: Accounts
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
description: >
Fix users tests
2020-07-02 07:23:50 -05:00
Accounts encompass remote accounts discovered across the federation,
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
and correspond to the main Actor, along with video channels a user can create, which
are also Actors.
When a comment is posted, it is done with your Account's Actor.
- name: Users
description: >
Using some features of PeerTube require authentication, for which User
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
provide different levels of permission as well as associated user
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
information. Each user has a corresponding local Account for federation.
- name: My User
description: >
Operations related to your own User, when logged-in.
- name: My Subscriptions
description: >
Operations related to your subscriptions to video channels, their
new videos, and how to keep up to date with their latest publications!
add My History API to openapi (#3363) Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Rigel Kent <par@rigelk.eu>
2020-11-25 17:27:59 -06:00
- name: My History
description: >
Add permanent live support
2020-12-03 07:10:54 -06:00
Operations related to your watch history.
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- name: My Notifications
description: >
Notifications following new videos, follows or reports. They allow you
to keep track of the interactions and overall important information that
concerns you. You MAY set per-notification type delivery preference, to
receive the info either by mail, by in-browser notification or both.
updated REST API documentation
2018-11-13 16:27:58 -06:00
- name: Config
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
description: >
Each server exposes public information regarding supported videos and
options.
updated REST API documentation
2018-11-13 16:27:58 -06:00
- name: Job
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
description: >
Jobs are long-running tasks enqueued and processed by the instance
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
itself. No additional worker registration is currently available.
Openapi consistency
2020-04-21 05:09:54 -05:00
- name: Instance Follows
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
description: >
Managing servers which the instance interacts with is crucial to the
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
concept of federation in PeerTube and external video indexation. The PeerTube
Fix video tags update/upload in openapi
2019-01-09 07:10:25 -06:00
server then deals with inter-server ActivityPub operations and propagates
updated REST API documentation
2018-11-13 16:27:58 -06:00
information across its social graph by posting activities to actors' inbox
endpoints.
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
externalDocs:
Use new doc website links
2021-02-12 03:12:19 -06:00
url: https://docs.joinpeertube.org/admin-following-instances?id=instances-follows
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
- name: Instance Redundancy
description: >
Redundancy is part of the inter-server solidarity that PeerTube fosters.
Manage the list of instances you wish to help by seeding their videos according
to the policy of video selection of your choice. Note that you have a similar functionality
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
to mirror individual videos, see [video mirroring](#tag/Video-Mirroring).
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
externalDocs:
Use new doc website links
2021-02-12 03:12:19 -06:00
url: https://docs.joinpeertube.org/admin-following-instances?id=instances-redundancy
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
- name: Plugins
description: >
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
Managing plugins installed from a local path or from NPM, or search for new ones.
externalDocs:
Use new doc website links
2021-02-12 03:12:19 -06:00
url: https://docs.joinpeertube.org/api-plugins
Add new abuses tests
2020-07-08 08:51:46 -05:00
- name: Abuses
updated REST API documentation
2018-11-13 16:27:58 -06:00
description: |
Add new abuses tests
2020-07-08 08:51:46 -05:00
Abuses deal with reports of local or remote videos/comments/accounts alike.
updated REST API documentation
2018-11-13 16:27:58 -06:00
- name: Video
description: |
Operations dealing with listing, uploading, fetching or modifying videos.
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
- name: Video Upload
description: |
Operations dealing with adding video or audio. PeerTube supports two upload modes, and three import modes.
### Upload
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
- [_legacy_](#operation/uploadLegacy), where the video file is sent in a single request
- [_resumable_](#operation/uploadResumableInit), where the video file is sent in chunks
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
You can upload videos more reliably by using the resumable variant. Its protocol lets
you resume an upload operation after a network interruption or other transmission failure,
saving time and bandwidth in the event of network failures.
Favor using resumable uploads in any of the following cases:
- You are transferring large files
- The likelihood of a network interruption is high
- Uploads are originating from a device with a low-bandwidth or unstable Internet connection,
such as a mobile device
### Import
- _URL_-based: where the URL points to any service supported by [youtube-dl](https://ytdl-org.github.io/youtube-dl/)
Fix various typos Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
- _magnet_-based: where the URI resolves to a BitTorrent resource containing a single supported video file
- _torrent_-based: where the metainfo file resolves to a BitTorrent resource containing a single supported video file
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
The import function is practical when the desired video/audio is available online. It makes PeerTube
download it for you, saving you as much bandwidth and avoiding any instability or limitation your network might have.
Add ability to cancel & delete video imports
2022-01-19 07:23:00 -06:00
- name: Video Imports
description: Operations dealing with listing, adding and removing video imports.
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
- name: Video Captions
description: Operations dealing with listing, adding and removing closed captions of a video.
- name: Video Channels
description: Operations dealing with the creation, modification and listing of videos within a channel.
- name: Video Comments
description: >
Operations dealing with comments to a video. Comments are organized in threads: adding a
comment in response to the video starts a thread, adding a reply to a comment adds it to
its root comment thread.
- name: Video Blocks
description: Operations dealing with blocking videos (removing them from view and preventing interactions).
- name: Video Rates
description: Like/dislike a video.
- name: Video Playlists
description: Operations dealing with playlists of videos. Playlists are bound to users and/or channels.
Add ability to run transcoding jobs
2021-11-18 07:35:08 -06:00
- name: Video Files
description: Operations on video files
- name: Video Transcoding
description: Video transcoding related operations
Update open api routes
2022-04-05 07:34:52 -05:00
- name: Video stats
description: Video statistics
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
- name: Feeds
description: Server syndication feeds
updated REST API documentation
2018-11-13 16:27:58 -06:00
- name: Search
description: |
Add rest api doc for index search
2020-06-10 08:18:15 -05:00
The search helps to find _videos_ or _channels_ from within the instance and beyond.
updated REST API documentation
2018-11-13 16:27:58 -06:00
Videos from other instances federated by the instance (that is, instances
followed by the instance) can be found via keywords and other criteria of
the advanced search.
Add rest api doc for index search
2020-06-10 08:18:15 -05:00
Administrators can also enable the use of a remote search system, indexing
videos and channels not could be not federated by the instance.
Instance homepage support (#4007) * Prepare homepage parsers * Add ability to update instance hompage * Add ability to set homepage as landing page * Add homepage preview in admin * Dynamically update left menu for homepage * Inject home content in homepage * Add videos list and channel miniature custom markup * Remove unused elements in markup service
2021-05-27 08:59:55 -05:00
- name: Homepage
description: Get and update the custom homepage
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
- name: Video Mirroring
description: |
PeerTube instances can mirror videos from one another, and help distribute some videos.
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
For importing videos as your own, refer to [video imports](#operation/importVideo).
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
x-tagGroups:
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
- name: Auth
tags:
- Register
- Session
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
- name: Accounts
tags:
- Accounts
Openapi consistency
2020-04-21 05:09:54 -05:00
- Users
Add video import in open api
2019-07-29 07:33:16 -05:00
- My User
Openapi consistency
2020-04-21 05:09:54 -05:00
- My Subscriptions
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- My Notifications
add My History API to openapi (#3363) Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Rigel Kent <par@rigelk.eu>
2020-11-25 17:27:59 -06:00
- My History
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
- name: Videos
tags:
- Video
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
- Video Upload
Add ability to cancel & delete video imports
2022-01-19 07:23:00 -06:00
- Video Imports
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
- Video Captions
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Channels
- Video Comments
- Video Rates
- Video Playlists
Update open api routes
2022-04-05 07:34:52 -05:00
- Video Stats
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Ownership Change
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
- Video Mirroring
Add ability to run transcoding jobs
2021-11-18 07:35:08 -06:00
- Video Files
- Video Transcoding
Add open api doc for live
2020-11-09 04:21:08 -06:00
- Live Videos
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
- Feeds
Openapi consistency
2020-04-21 05:09:54 -05:00
- name: Search
tags:
- Search
Instance homepage support (#4007) * Prepare homepage parsers * Add ability to update instance hompage * Add ability to set homepage as landing page * Add homepage preview in admin * Dynamically update left menu for homepage * Inject home content in homepage * Add videos list and channel miniature custom markup * Remove unused elements in markup service
2021-05-27 08:59:55 -05:00
- name: Custom pages
tags:
- Homepage
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
- name: Moderation
tags:
Add new abuses tests
2020-07-08 08:51:46 -05:00
- Abuses
predefined report reasons & improved reporter UI (#2842) - added `startAt` and `endAt` optional timestamps to help pin down reported sections of a video - added predefined report reasons - added video player with report modal
2020-06-22 06:00:39 -05:00
- Video Blocks
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
- Account Blocks
- Server Blocks
fix rest api quickstart and specify values in openapi spec
2018-11-19 15:07:29 -06:00
- name: Instance Configuration
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
tags:
- Config
Openapi consistency
2020-04-21 05:09:54 -05:00
- Instance Follows
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
- Instance Redundancy
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
- Plugins
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
- name: Jobs
tags:
- Job
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
paths:
Only use account name in routes
2018-05-25 02:57:16 -05:00
'/accounts/{name}':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
tags:
- Accounts
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get an account
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: getAccount
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
parameters:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/name'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
'404':
description: account not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Only use account name in routes
2018-05-25 02:57:16 -05:00
'/accounts/{name}/videos':
Video channel API routes refractor
2018-04-25 03:21:38 -05:00
get:
tags:
- Accounts
updated REST API documentation
2018-11-13 16:27:58 -06:00
- Video
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: 'List videos of an account'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: getAccountVideos
Video channel API routes refractor
2018-04-25 03:21:38 -05:00
parameters:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/name'
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
- $ref: '#/components/parameters/categoryOneOf'
Add ability to filter my videos by live
2021-05-03 04:06:19 -05:00
- $ref: '#/components/parameters/isLive'
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
- $ref: '#/components/parameters/tagsOneOf'
- $ref: '#/components/parameters/tagsAllOf'
- $ref: '#/components/parameters/licenceOneOf'
- $ref: '#/components/parameters/languageOneOf'
- $ref: '#/components/parameters/nsfw'
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
- $ref: '#/components/parameters/isLocal'
- $ref: '#/components/parameters/include'
Add ability to filter out public videos from admin
2021-11-12 07:19:56 -06:00
- $ref: '#/components/parameters/privacyOneOf'
Add ability to filter by file type
2021-11-03 05:32:41 -05:00
- $ref: '#/components/parameters/hasHLSFiles'
- $ref: '#/components/parameters/hasWebtorrentFiles'
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
- $ref: '#/components/parameters/skipCount'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/videosSort'
Video channel API routes refractor
2018-04-25 03:21:38 -05:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
Fix videos list response in rest api doc
2019-05-24 03:17:54 -05:00
$ref: '#/components/schemas/VideoListResponse'
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
x-codeSamples:
updated REST API documentation
2018-11-13 16:27:58 -06:00
- lang: JavaScript
source: |
fix API spec on POST /videos/upload and provide Shell example
2018-11-15 10:08:42 -06:00
fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos')
updated REST API documentation
2018-11-13 16:27:58 -06:00
.then(function(response) {
return response.json()
}).then(function(data) {
console.log(data)
})
fix API spec on POST /videos/upload and provide Shell example
2018-11-15 10:08:42 -06:00
- lang: Shell
source: |
Switch examples to curl since httpie has a 512MB limit (#3012) Co-authored-by: Rigel Kent <par@rigelk.eu>
2020-07-28 06:48:55 -05:00
## DEPENDENCIES: jq
curl -s https://peertube2.cpy.re/api/v1/accounts/{name}/videos | jq
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
- lang: Ruby
source: |
require 'net/http'
Fix Ruby and Python REST API examples The previous examples where wrong, since they used a POST request. I used the requests library for Python, since that is what most people would want to use. I removed the http.verify_mode in the Ruby example since I don't think it is good practice to tell people to not verify HTTPS requests
2019-11-12 07:46:43 -06:00
require 'json'
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
Fix Ruby and Python REST API examples The previous examples where wrong, since they used a POST request. I used the requests library for Python, since that is what most people would want to use. I removed the http.verify_mode in the Ruby example since I don't think it is good practice to tell people to not verify HTTPS requests
2019-11-12 07:46:43 -06:00
uri = URI.parse("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
Fix Ruby and Python REST API examples The previous examples where wrong, since they used a POST request. I used the requests library for Python, since that is what most people would want to use. I removed the http.verify_mode in the Ruby example since I don't think it is good practice to tell people to not verify HTTPS requests
2019-11-12 07:46:43 -06:00
http = Net::HTTP.new(uri.host, uri.port)
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
http.use_ssl = true
Fix Ruby and Python REST API examples The previous examples where wrong, since they used a POST request. I used the requests library for Python, since that is what most people would want to use. I removed the http.verify_mode in the Ruby example since I don't think it is good practice to tell people to not verify HTTPS requests
2019-11-12 07:46:43 -06:00
response = http.get(uri.request_uri)
puts JSON.parse(response.read_body)
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
- lang: Python
source: |
Fix Ruby and Python REST API examples The previous examples where wrong, since they used a POST request. I used the requests library for Python, since that is what most people would want to use. I removed the http.verify_mode in the Ruby example since I don't think it is good practice to tell people to not verify HTTPS requests
2019-11-12 07:46:43 -06:00
import requests
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
Fix Ruby and Python REST API examples The previous examples where wrong, since they used a POST request. I used the requests library for Python, since that is what most people would want to use. I removed the http.verify_mode in the Ruby example since I don't think it is good practice to tell people to not verify HTTPS requests
2019-11-12 07:46:43 -06:00
r = requests.get("https://peertube2.cpy.re/api/v1//accounts/{name}/videos")
json = r.json()
grouping tags by main category in the spec
2018-11-16 07:33:48 -06:00
Fix Ruby and Python REST API examples The previous examples where wrong, since they used a POST request. I used the requests library for Python, since that is what most people would want to use. I removed the http.verify_mode in the Ruby example since I don't think it is good practice to tell people to not verify HTTPS requests
2019-11-12 07:46:43 -06:00
print(json)
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Split check user params tests
2021-10-19 08:02:43 -05:00
'/accounts/{name}/followers':
get:
tags:
- Accounts
summary: 'List followers of an account'
security:
- OAuth2: []
operationId: getAccountFollowers
parameters:
- $ref: '#/components/parameters/name'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/followersSort'
- $ref: '#/components/parameters/search'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
total:
type: integer
example: 1
data:
type: array
items:
$ref: '#/components/schemas/Follow'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
/accounts:
get:
tags:
- Accounts
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List accounts
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: getAccounts
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
fix API spec on POST /videos/upload and provide Shell example
2018-11-15 10:08:42 -06:00
'application/json':
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
schema:
type: array
items:
$ref: '#/components/schemas/Account'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
/config:
get:
tags:
- Config
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get instance public configuration
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: getConfig
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
$ref: '#/components/schemas/ServerConfig'
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/api/v1/config
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
/config/about:
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get instance "About" information
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: getAbout
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
tags:
- Config
responses:
'200':
description: successful operation
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
content:
application/json:
schema:
$ref: '#/components/schemas/ServerConfigAbout'
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/api/v1/config/about
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
/config/custom:
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get instance runtime configuration
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: getCustomConfig
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
tags:
- Config
security:
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- admin
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
responses:
'200':
description: successful operation
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
content:
application/json:
schema:
$ref: '#/components/schemas/ServerConfigCustom'
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
put:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Set instance runtime configuration
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: putCustomConfig
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
tags:
- Config
security:
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- admin
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
responses:
'200':
description: successful operation
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
'400':
x-summary: field inconsistencies
description: >
Arises when:
- the emailer is disabled and the instance is open to registrations
- webtorrent and hls are disabled with transcoding enabled - you need at least one enabled
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
delete:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Delete instance runtime configuration
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: delCustomConfig
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
tags:
- Config
security:
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- admin
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
responses:
'200':
description: successful operation
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Instance homepage support (#4007) * Prepare homepage parsers * Add ability to update instance hompage * Add ability to set homepage as landing page * Add homepage preview in admin * Dynamically update left menu for homepage * Inject home content in homepage * Add videos list and channel miniature custom markup * Remove unused elements in markup service
2021-05-27 08:59:55 -05:00
/custom-pages/homepage/instance:
get:
summary: Get instance custom homepage
tags:
- Homepage
responses:
'404':
description: No homepage set
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/CustomHomepage'
put:
summary: Set instance custom homepage
tags:
- Homepage
security:
- OAuth2:
- admin
requestBody:
content:
application/json:
schema:
type: object
properties:
content:
type: string
description: content of the homepage, that will be injected in the client
responses:
'204':
description: successful operation
Add ability to cancel & delete video imports
2022-01-19 07:23:00 -06:00
/jobs/pause:
post:
summary: Pause job queue
security:
- OAuth2:
- admin
tags:
- Job
responses:
'204':
description: successful operation
/jobs/resume:
post:
summary: Resume job queue
security:
- OAuth2:
- admin
tags:
- Job
responses:
'204':
description: successful operation
add job state in path in openapi spec
2018-11-19 15:10:35 -06:00
/jobs/{state}:
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List instance jobs
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: getJobs
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- admin
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
- Job
Apidoc (#302) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file * api documentation improvement
2018-02-17 12:24:56 -06:00
parameters:
- name: state
in: path
required: true
add display of logs matching any state
2020-12-13 12:27:25 -06:00
description: The state of the job ('' for for no filter)
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
schema:
type: string
fix rest api quickstart and specify values in openapi spec
2018-11-19 15:07:29 -06:00
enum:
add display of logs matching any state
2020-12-13 12:27:25 -06:00
- ''
fix rest api quickstart and specify values in openapi spec
2018-11-19 15:07:29 -06:00
- active
- completed
- failed
- waiting
- delayed
add display of logs matching any state
2020-12-13 12:27:25 -06:00
- $ref: '#/components/parameters/jobType'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
type: object
properties:
total:
type: integer
example: 1
data:
type: array
maxItems: 100
items:
$ref: '#/components/schemas/Job'
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
/server/followers:
get:
tags:
- Instance Follows
summary: List instances following the server
parameters:
- $ref: '#/components/parameters/followState'
- $ref: '#/components/parameters/actorType'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
total:
type: integer
example: 1
data:
type: array
items:
$ref: '#/components/schemas/Follow'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
'/server/followers/{nameWithHost}':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
delete:
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
summary: Remove or reject a follower to your server
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
- admin
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Instance Follows
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
parameters:
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
- name: nameWithHost
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
in: path
required: true
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
description: The remote actor handle to remove from your followers
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
schema:
type: string
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
format: email
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
'204':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
description: successful operation
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
'404':
description: follower not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
'/server/followers/{nameWithHost}/reject':
post:
summary: Reject a pending follower to your server
security:
- OAuth2:
- admin
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Instance Follows
Apidoc (#302) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file * api documentation improvement
2018-02-17 12:24:56 -06:00
parameters:
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
- name: nameWithHost
in: path
required: true
description: The remote actor handle to remove from your followers
schema:
type: string
format: email
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
'204':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
description: successful operation
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
'404':
description: follower not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
'/server/followers/{nameWithHost}/accept':
post:
summary: Accept a pending follower to your server
security:
- OAuth2:
- admin
tags:
- Instance Follows
parameters:
- name: nameWithHost
in: path
required: true
description: The remote actor handle to remove from your followers
schema:
type: string
format: email
responses:
'204':
description: successful operation
'404':
description: follower not found
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
/server/following:
get:
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Instance Follows
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
summary: List instances followed by the server
Apidoc (#302) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file * api documentation improvement
2018-02-17 12:24:56 -06:00
parameters:
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
- $ref: '#/components/parameters/followState'
- $ref: '#/components/parameters/actorType'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
type: object
properties:
total:
type: integer
example: 1
data:
type: array
items:
$ref: '#/components/schemas/Follow'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
post:
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- admin
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Instance Follows
Add ability for instances to follow any actor
2021-07-20 07:15:15 -05:00
summary: Follow a list of actors (PeerTube instance, channel or account)
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
'500':
description: cannot follow a non-HTTPS server
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
requestBody:
content:
application/json:
schema:
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
type: object
properties:
hosts:
type: array
items:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: hostname
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
uniqueItems: true
Add ability for instances to follow any actor
2021-07-20 07:15:15 -05:00
handles:
type: array
items:
type: string
uniqueItems: true
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Add ability for instances to follow any actor
2021-07-20 07:15:15 -05:00
'/server/following/{hostOrHandle}':
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
delete:
Add ability for instances to follow any actor
2021-07-20 07:15:15 -05:00
summary: Unfollow an actor (PeerTube instance, channel or account)
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
security:
- OAuth2:
- admin
tags:
- Instance Follows
parameters:
Add ability for instances to follow any actor
2021-07-20 07:15:15 -05:00
- name: hostOrHandle
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
in: path
required: true
Add ability for instances to follow any actor
2021-07-20 07:15:15 -05:00
description: The hostOrHandle to unfollow
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
schema:
type: string
responses:
'204':
description: successful operation
'404':
Add ability for instances to follow any actor
2021-07-20 07:15:15 -05:00
description: host or handle not found
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
/users:
post:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Create a user
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: addUser
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- admin
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Users
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
Fix users tests
2020-07-02 07:23:50 -05:00
'200':
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
description: user created
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
$ref: '#/components/schemas/AddUserResponse'
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
links:
# GET /users/{id}
add operationId to common operations
2021-05-24 12:38:26 -05:00
GetUser:
operationId: getUser
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
parameters:
id: '$response.body#/user/id'
# PUT /users/{id}
add operationId to common operations
2021-05-24 12:38:26 -05:00
PutUser:
operationId: putUser
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
parameters:
id: '$response.body#/user/id'
# DELETE /users/{id}
add operationId to common operations
2021-05-24 12:38:26 -05:00
DelUser:
operationId: delUser
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
parameters:
id: '$response.body#/user/id'
'403':
description: insufficient authority to create an admin or moderator
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddUser'
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: |
If the smtp server is configured, you can leave the password empty and an email will be sent
asking the user to set it first.
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
required: true
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List users
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: getUsers
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
add blocked filter in users list to filter banned users fixes #2914
2020-07-02 15:49:51 -05:00
- OAuth2:
- admin
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Users
Apidoc (#302) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file * api documentation improvement
2018-02-17 12:24:56 -06:00
parameters:
add blocked filter in users list to filter banned users fixes #2914
2020-07-02 15:49:51 -05:00
- $ref: '#/components/parameters/usersSearch'
- $ref: '#/components/parameters/usersBlocked'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
- $ref: '#/components/parameters/usersSort'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
'/users/{id}':
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
parameters:
- $ref: '#/components/parameters/id'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
delete:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Delete a user
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- admin
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Users
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: delUser
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get a user
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Users
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: getUser
specify getUserId variant in openapi spec closes #4062
2021-05-10 05:01:40 -05:00
parameters:
- name: withStats
in: query
description: include statistics about the user (only available as a moderator/admin)
schema:
type: boolean
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
specify getUserId variant in openapi spec closes #4062
2021-05-10 05:01:40 -05:00
x-summary: successful operation
description: |
As an admin/moderator, you can request a response augmented with statistics about the user's
moderation relations and videos usage, by using the `withStats` parameter.
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
specify getUserId variant in openapi spec closes #4062
2021-05-10 05:01:40 -05:00
oneOf:
- $ref: '#/components/schemas/User'
- $ref: '#/components/schemas/UserWithStats'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
put:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Update a user
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Users
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: putUser
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUser'
required: true
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
/oauth-clients/local:
get:
summary: Login prerequisite
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
description: You need to retrieve a client id and secret before [logging in](#operation/getOAuthToken).
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
operationId: getOAuthClient
tags:
- Session
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/OAuthClient'
links:
UseOAuthClientToLogin:
operationId: getOAuthToken
parameters:
client_id: '$response.body#/client_id'
client_secret: '$response.body#/client_secret'
add code examples for login in openapi spec
2021-05-14 12:19:10 -05:00
x-codeSamples:
- lang: Shell
source: |
API="https://peertube2.cpy.re/api/v1"
## AUTH
curl -s "$API/oauth-clients/local"
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
/users/token:
post:
summary: Login
operationId: getOAuthToken
description: With your [client id and secret](#operation/getOAuthClient), you can retrieve an access and refresh tokens.
tags:
- Session
requestBody:
content:
application/x-www-form-urlencoded:
schema:
oneOf:
- $ref: '#/components/schemas/OAuthToken-password'
- $ref: '#/components/schemas/OAuthToken-refresh_token'
discriminator:
propertyName: grant_type
mapping:
password: '#/components/schemas/OAuthToken-password'
refresh_token: '#/components/schemas/OAuthToken-refresh_token'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
token_type:
type: string
example: Bearer
access_token:
type: string
example: 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0
description: valid for 1 day
refresh_token:
type: string
example: 2e0d675df9fc96d2e4ec8a3ebbbf45eca9137bb7
description: valid for 2 weeks
expires_in:
type: integer
minimum: 0
example: 14399
refresh_token_expires_in:
type: integer
minimum: 0
example: 1209600
refactor error code values for URI compatibility
2021-06-02 07:28:30 -05:00
'400':
x-summary: client or credentials are invalid
description: |
Disambiguate via `type`:
- `invalid_client` for an unmatched `client_id`
- `invalid_grant` for unmatched credentials
add invalid_token error to openapi spec
2021-06-04 01:40:08 -05:00
'401':
x-summary: token expired
description: |
Disambiguate via `type`:
- default value for a regular authentication failure
- `invalid_token` for an expired token
add code examples for login in openapi spec
2021-05-14 12:19:10 -05:00
x-codeSamples:
- lang: Shell
source: |
## DEPENDENCIES: jq
API="https://peertube2.cpy.re/api/v1"
USERNAME="<your_username>"
PASSWORD="<your_password>"
## AUTH
client_id=$(curl -s "$API/oauth-clients/local" | jq -r ".client_id")
client_secret=$(curl -s "$API/oauth-clients/local" | jq -r ".client_secret")
curl -s "$API/users/token" \
--data client_id="$client_id" \
--data client_secret="$client_secret" \
--data grant_type=password \
--data username="$USERNAME" \
--data password="$PASSWORD" \
| jq -r ".access_token"
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
/users/revoke-token:
post:
summary: Logout
description: Revokes your access token and its associated refresh token, destroying your current session.
operationId: revokeOAuthToken
tags:
- Session
security:
- OAuth2: []
responses:
'200':
description: successful operation
Add video import in open api
2019-07-29 07:33:16 -05:00
/users/register:
post:
summary: Register a user
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: registerUser
Add video import in open api
2019-07-29 07:33:16 -05:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Users
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
- Register
Add video import in open api
2019-07-29 07:33:16 -05:00
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
Add video import in open api
2019-07-29 07:33:16 -05:00
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterUser'
required: true
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
/users/{id}/verify-email:
post:
summary: Verify a user
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: verifyUser
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
description: |
Following a user registration, the new user will receive an email asking to click a link
Fix broken openapi schema
2021-05-27 04:52:03 -05:00
containing a secret.
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
tags:
- Users
- Register
parameters:
- $ref: '#/components/parameters/id'
requestBody:
content:
application/json:
schema:
type: object
properties:
verificationString:
type: string
format: url
isPendingEmail:
type: boolean
required:
- verificationString
responses:
'204':
description: successful operation
'403':
description: invalid verification string
'404':
description: user not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
/users/ask-send-verify-email:
post:
summary: Resend user verification link
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: resendEmailToVerifyUser
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
tags:
- Users
- Register
responses:
'204':
description: successful operation
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
/users/me:
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get my user information
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: getUserInfo
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
- OAuth2:
- user
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Add video import in open api
2019-07-29 07:33:16 -05:00
- My User
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
put:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Update my user information
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: putUserInfo
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
- OAuth2:
- user
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Add video import in open api
2019-07-29 07:33:16 -05:00
- My User
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'204':
Add originallyPublishedAt to PUT videos + change HTTP response to 204
2019-08-14 03:53:31 -05:00
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMe'
required: true
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Add video import in open api
2019-07-29 07:33:16 -05:00
/users/me/videos/imports:
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get video imports of my user
Add video import in open api
2019-07-29 07:33:16 -05:00
security:
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- user
Add video import in open api
2019-07-29 07:33:16 -05:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Videos
Add video import in open api
2019-07-29 07:33:16 -05:00
- My User
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
responses:
'200':
description: successful operation
content:
application/json:
schema:
fix imports list response in openapi spec closes #4063
2021-05-10 04:02:54 -05:00
$ref: '#/components/schemas/VideoImportsList'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
/users/me/video-quota-used:
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get my user used quota
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
- OAuth2:
- user
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Add video import in open api
2019-07-29 07:33:16 -05:00
- My User
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
fix response in openapi spec for quota and video ratings closes #4064 closes #4065
2021-05-10 03:26:50 -05:00
type: object
properties:
videoQuotaUsed:
type: number
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: The user video quota used so far in bytes
fix response in openapi spec for quota and video ratings closes #4064 closes #4065
2021-05-10 03:26:50 -05:00
example: 16810141515
videoQuotaUsedDaily:
type: number
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: The user video quota used today in bytes
fix response in openapi spec for quota and video ratings closes #4064 closes #4065
2021-05-10 03:26:50 -05:00
example: 1681014151
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
'/users/me/videos/{videoId}/rating':
get:
Improve abuse api doc
2020-04-21 08:24:19 -05:00
summary: Get rate of my user for a video
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Add video import in open api
2019-07-29 07:33:16 -05:00
- My User
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Rates
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
parameters:
- name: videoId
in: path
required: true
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: The video id
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
schema:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/Video/properties/id'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
$ref: '#/components/schemas/GetMeVideoRating'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
/users/me/videos:
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get videos of my user
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
- OAuth2:
- user
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Add video import in open api
2019-07-29 07:33:16 -05:00
- My User
Openapi consistency
2020-04-21 05:09:54 -05:00
- Videos
Apidoc (#302) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file * api documentation improvement
2018-02-17 12:24:56 -06:00
parameters:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
Fix videos list response in rest api doc
2019-05-24 03:17:54 -05:00
$ref: '#/components/schemas/VideoListResponse'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
/users/me/subscriptions:
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get my user subscriptions
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
security:
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- user
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- My Subscriptions
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
responses:
'200':
description: successful operation
refactor subscriptions response from list to totalDataList in openapi spec closes #4067
2021-05-10 07:39:01 -05:00
content:
application/json:
schema:
$ref: '#/components/schemas/VideoChannelList'
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
post:
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
tags:
- My Subscriptions
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Add subscription to my user
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
security:
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- user
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
requestBody:
content:
application/json:
schema:
type: object
properties:
uri:
type: string
format: uri
description: uri of the video channels to subscribe to
required:
- uri
examples:
default:
value:
uri: 008a0e54-375d-49d0-8379-143202e24152@video.lqdn.fr
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
responses:
'200':
description: successful operation
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
/users/me/subscriptions/exist:
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get if subscriptions exist for my user
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
security:
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- user
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- My Subscriptions
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
parameters:
- $ref: '#/components/parameters/subscriptionsUris'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
/users/me/subscriptions/videos:
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List videos of subscriptions of my user
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
security:
- OAuth2:
- user
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- My Subscriptions
- Videos
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
parameters:
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
- $ref: '#/components/parameters/categoryOneOf'
Add ability to filter my videos by live
2021-05-03 04:06:19 -05:00
- $ref: '#/components/parameters/isLive'
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
- $ref: '#/components/parameters/tagsOneOf'
- $ref: '#/components/parameters/tagsAllOf'
- $ref: '#/components/parameters/licenceOneOf'
- $ref: '#/components/parameters/languageOneOf'
- $ref: '#/components/parameters/nsfw'
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
- $ref: '#/components/parameters/isLocal'
- $ref: '#/components/parameters/include'
Add ability to filter out public videos from admin
2021-11-12 07:19:56 -06:00
- $ref: '#/components/parameters/privacyOneOf'
Add ability to filter by file type
2021-11-03 05:32:41 -05:00
- $ref: '#/components/parameters/hasHLSFiles'
- $ref: '#/components/parameters/hasWebtorrentFiles'
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
- $ref: '#/components/parameters/skipCount'
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
- $ref: '#/components/parameters/videosSort'
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
Fix videos list response in rest api doc
2019-05-24 03:17:54 -05:00
$ref: '#/components/schemas/VideoListResponse'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Fix openapi schema
2019-07-03 10:28:09 -05:00
'/users/me/subscriptions/{subscriptionHandle}':
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get subscription of my user
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
security:
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- user
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- My Subscriptions
Fix openapi schema
2019-07-03 10:28:09 -05:00
parameters:
- $ref: '#/components/parameters/subscriptionHandle'
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/VideoChannel'
delete:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Delete subscription of my user
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
security:
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- user
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- My Subscriptions
Fix openapi schema
2019-07-03 10:28:09 -05:00
parameters:
- $ref: '#/components/parameters/subscriptionHandle'
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
responses:
'200':
description: successful operation
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
/users/me/notifications:
get:
summary: List my notifications
security:
- OAuth2: []
tags:
- My Notifications
parameters:
- name: unread
in: query
description: only list unread notifications
schema:
type: boolean
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/NotificationListResponse'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
/users/me/notifications/read:
post:
summary: Mark notifications as read by their id
security:
- OAuth2: []
tags:
- My Notifications
requestBody:
content:
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
application/json:
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
schema:
type: object
properties:
ids:
type: array
description: ids of the notifications to mark as read
items:
type: integer
required:
- ids
responses:
'204':
description: successful operation
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
/users/me/notifications/read-all:
post:
summary: Mark all my notification as read
security:
- OAuth2: []
tags:
- My Notifications
responses:
'204':
description: successful operation
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
/users/me/notification-settings:
put:
summary: Update my notification settings
security:
- OAuth2: []
tags:
- My Notifications
requestBody:
content:
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
application/json:
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
schema:
type: object
properties:
newVideoFromSubscription:
$ref: '#/components/schemas/NotificationSettingValue'
newCommentOnMyVideo:
$ref: '#/components/schemas/NotificationSettingValue'
Add migrations
2020-07-07 07:34:16 -05:00
abuseAsModerator:
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
$ref: '#/components/schemas/NotificationSettingValue'
videoAutoBlacklistAsModerator:
$ref: '#/components/schemas/NotificationSettingValue'
blacklistOnMyVideo:
$ref: '#/components/schemas/NotificationSettingValue'
myVideoPublished:
$ref: '#/components/schemas/NotificationSettingValue'
myVideoImportFinished:
$ref: '#/components/schemas/NotificationSettingValue'
newFollow:
$ref: '#/components/schemas/NotificationSettingValue'
newUserRegistration:
$ref: '#/components/schemas/NotificationSettingValue'
commentMention:
$ref: '#/components/schemas/NotificationSettingValue'
newInstanceFollower:
$ref: '#/components/schemas/NotificationSettingValue'
autoInstanceFollowing:
$ref: '#/components/schemas/NotificationSettingValue'
responses:
'204':
description: successful operation
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add My History API to openapi (#3363) Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Rigel Kent <par@rigelk.eu>
2020-11-25 17:27:59 -06:00
/users/me/history/videos:
get:
summary: List watched videos history
security:
- OAuth2: []
tags:
- My History
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
Allow user to search through their watch history (#3576) * allow user to search through their watch history * add tests for search in watch history * Update client/src/app/shared/shared-main/users/user-history.service.ts
2021-01-13 02:16:15 -06:00
- $ref: '#/components/parameters/search'
add My History API to openapi (#3363) Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Rigel Kent <par@rigelk.eu>
2020-11-25 17:27:59 -06:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/VideoListResponse'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Add ability to delete history element
2022-01-18 04:23:41 -06:00
/users/me/history/videos/{videoId}:
delete:
summary: Delete history element
security:
- OAuth2: []
tags:
- My History
parameters:
- name: videoId
in: path
required: true
schema:
$ref: '#/components/schemas/Video/properties/id'
responses:
'204':
description: successful operation
add My History API to openapi (#3363) Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Rigel Kent <par@rigelk.eu>
2020-11-25 17:27:59 -06:00
/users/me/history/videos/remove:
post:
summary: Clear video history
security:
- OAuth2: []
tags:
- My History
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
beforeDate:
description: history before this date will be deleted
type: string
format: date-time
responses:
'204':
description: successful operation
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
/users/me/avatar/pick:
post:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Update my user avatar
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Add video import in open api
2019-07-29 07:33:16 -05:00
- My User
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
Update avatar/banner API doc
2021-04-08 02:34:32 -05:00
type: object
properties:
Implement avatar miniatures (#4639) * client: remove unused file * refactor(client/my-actor-avatar): size from input Read size from component input instead of scss, to make it possible to use smaller avatar images when implemented. * implement avatar miniatures close #4560 * fix(test): max file size * fix(search-index): normalize res acc to avatarMini * refactor avatars to an array * client/search: resize channel avatar to 120 * refactor(client/videos): remove unused function * client(actor-avatar): set default size * fix tests and avatars full result When findOne is used only an array containting one avatar is returned. * update migration version and version notations * server/search: harmonize normalizing * Cleanup avatar miniature PR Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-02-28 01:34:43 -06:00
avatars:
type: array
items:
$ref: '#/components/schemas/ActorImage'
more explicit error messages for file uploads
2020-11-23 03:45:42 -06:00
'413':
description: image file too large
headers:
X-File-Maximum-Size:
schema:
type: string
format: Nginx size
description: Maximum file size for the avatar
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
avatarfile:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: The file to upload
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
type: string
format: binary
encoding:
Improved description of all file uploads (#2053) * Add format:binary for file uploads * Fix wrongly named field for encoding * Fix typo in field name * Add contentType for torrentfile and captionfile * Add contentType for videofile
2019-08-21 01:32:15 -05:00
avatarfile:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
contentType: image/png, image/jpeg
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Update avatar/banner API doc
2021-04-08 02:34:32 -05:00
/users/me/avatar:
delete:
summary: Delete my avatar
security:
- OAuth2: []
tags:
- My User
responses:
'204':
description: successful operation
Openapi consistency
2020-04-21 05:09:54 -05:00
/videos/ownership:
get:
summary: List video ownership changes
tags:
- Video Ownership Change
security:
- OAuth2: []
responses:
'200':
description: successful operation
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Openapi consistency
2020-04-21 05:09:54 -05:00
'/videos/ownership/{id}/accept':
post:
summary: Accept ownership change request
tags:
- Video Ownership Change
security:
- OAuth2: []
parameters:
- $ref: '#/components/parameters/idOrUUID'
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
'403':
description: cannot terminate an ownership change of another user
'404':
Add fixme info
2022-02-01 09:38:07 -06:00
description: video ownership change not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Openapi consistency
2020-04-21 05:09:54 -05:00
'/videos/ownership/{id}/refuse':
post:
summary: Refuse ownership change request
tags:
- Video Ownership Change
security:
- OAuth2: []
parameters:
- $ref: '#/components/parameters/idOrUUID'
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
'403':
description: cannot terminate an ownership change of another user
'404':
Add fixme info
2022-02-01 09:38:07 -06:00
description: video ownership change not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Openapi consistency
2020-04-21 05:09:54 -05:00
'/videos/{id}/give-ownership':
post:
summary: Request ownership change
tags:
- Video Ownership Change
security:
- OAuth2: []
parameters:
- $ref: '#/components/parameters/idOrUUID'
requestBody:
required: true
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
username:
type: string
required:
- username
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
Openapi consistency
2020-04-21 05:09:54 -05:00
'400':
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: changing video ownership to a remote account is not supported yet
'404':
description: video not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Api doc improvement (#252) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file
2018-01-25 11:39:51 -06:00
/videos:
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List videos
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: getVideos
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
- Video
Apidoc (#302) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file * api documentation improvement
2018-02-17 12:24:56 -06:00
parameters:
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
- $ref: '#/components/parameters/categoryOneOf'
Add ability to filter my videos by live
2021-05-03 04:06:19 -05:00
- $ref: '#/components/parameters/isLive'
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
- $ref: '#/components/parameters/tagsOneOf'
- $ref: '#/components/parameters/tagsAllOf'
- $ref: '#/components/parameters/licenceOneOf'
- $ref: '#/components/parameters/languageOneOf'
- $ref: '#/components/parameters/nsfw'
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
- $ref: '#/components/parameters/isLocal'
- $ref: '#/components/parameters/include'
Add ability to filter out public videos from admin
2021-11-12 07:19:56 -06:00
- $ref: '#/components/parameters/privacyOneOf'
Add ability to filter by file type
2021-11-03 05:32:41 -05:00
- $ref: '#/components/parameters/hasHLSFiles'
- $ref: '#/components/parameters/hasWebtorrentFiles'
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
- $ref: '#/components/parameters/skipCount'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
- $ref: '#/components/parameters/videosSort'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
Fix videos list response in rest api doc
2019-05-24 03:17:54 -05:00
$ref: '#/components/schemas/VideoListResponse'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Api doc improvement (#252) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file
2018-01-25 11:39:51 -06:00
/videos/categories:
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List available video categories
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
operationId: getCategories
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
- Video
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
type: array
items:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/api/v1/videos/categories
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Api doc improvement (#252) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file
2018-01-25 11:39:51 -06:00
/videos/licences:
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List available video licences
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
operationId: getLicences
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
- Video
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
type: array
items:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/api/v1/videos/licences
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Api doc improvement (#252) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file
2018-01-25 11:39:51 -06:00
/videos/languages:
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List available video languages
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
operationId: getLanguages
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
- Video
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
type: array
items:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/api/v1/videos/languages
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Api doc improvement (#252) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file
2018-01-25 11:39:51 -06:00
/videos/privacies:
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
summary: List available video privacy policies
operationId: getPrivacyPolicies
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
- Video
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
type: array
items:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/api/v1/videos/privacies
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
'/videos/{id}':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
put:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Update a video
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: putVideo
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
- Video
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
Add originallyPublishedAt to PUT videos + change HTTP response to 204
2019-08-14 03:53:31 -05:00
'204':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
thumbnailfile:
description: Video thumbnail file
type: string
Improved description of all file uploads (#2053) * Add format:binary for file uploads * Fix wrongly named field for encoding * Fix typo in field name * Add contentType for torrentfile and captionfile * Add contentType for videofile
2019-08-21 01:32:15 -05:00
format: binary
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
previewfile:
description: Video preview file
type: string
Improved description of all file uploads (#2053) * Add format:binary for file uploads * Fix wrongly named field for encoding * Fix typo in field name * Add contentType for torrentfile and captionfile * Add contentType for videofile
2019-08-21 01:32:15 -05:00
format: binary
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
category:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
$ref: '#/components/schemas/VideoCategorySet'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
licence:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
$ref: '#/components/schemas/VideoLicenceSet'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
language:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
$ref: '#/components/schemas/VideoLanguageSet'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
privacy:
$ref: '#/components/schemas/VideoPrivacySet'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
description:
description: Video description
type: string
waitTranscoding:
description: Whether or not we wait transcoding before publish the video
type: string
support:
allow limiting video-comments rss feeds to an account or video channel
2020-06-27 06:12:30 -05:00
description: A text tell the audience how to support the video creator
add response content for createVideoChannel endpoint in openapi spec closes #4077
2021-05-12 06:44:32 -05:00
example: Please support our work on https://soutenir.framasoft.org/en/ <3
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
type: string
nsfw:
description: Whether or not this video contains sensitive content
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
type: boolean
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
name:
description: Video name
type: string
fix name limit for video in openapi spec
2021-05-03 05:17:30 -05:00
minLength: 3
maxLength: 120
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
tags:
Add the video tags restrictions to the API docs Fixes #1744
2019-03-29 05:45:41 -05:00
description: Video tags (maximum 5 tags each between 2 and 30 characters)
Fix video tags update/upload in openapi
2019-01-09 07:10:25 -06:00
type: array
Specify the restrictions on tags array and it's string items (#2016) * Fixed 2 typos * Specify tags array restrictions
2019-08-12 03:19:45 -05:00
minItems: 1
maxItems: 5
Fix video tags update/upload in openapi
2019-01-09 07:10:25 -06:00
items:
type: string
Specify the restrictions on tags array and it's string items (#2016) * Fixed 2 typos * Specify tags array restrictions
2019-08-12 03:19:45 -05:00
minLength: 2
maxLength: 30
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
commentsEnabled:
description: Enable or disable comments for this video
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
type: boolean
Add downloadEnabled boolean to PUT video
2021-06-25 07:18:12 -05:00
downloadEnabled:
description: Enable or disable downloading for this video
type: boolean
Add originallyPublishedAt to PUT videos + change HTTP response to 204
2019-08-14 03:53:31 -05:00
originallyPublishedAt:
description: Date when the content was originally published
type: string
format: date-time
Improve video REST documentation
2019-06-11 03:01:13 -05:00
scheduleUpdate:
$ref: '#/components/schemas/VideoScheduledUpdate'
Improved description of all file uploads (#2053) * Add format:binary for file uploads * Fix wrongly named field for encoding * Fix typo in field name * Add contentType for torrentfile and captionfile * Add contentType for videofile
2019-08-21 01:32:15 -05:00
encoding:
thumbnailfile:
contentType: image/jpeg
previewfile:
contentType: image/jpeg
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get a video
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: getVideo
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
- Video
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
Improve video REST documentation
2019-06-11 03:01:13 -05:00
$ref: '#/components/schemas/VideoDetails'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
delete:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Delete a video
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: delVideo
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
- Video
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
'/videos/{id}/description':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get complete video description
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: getVideoDesc
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
- Video
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
nullable: true
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
type: string
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
minLength: 3
maxLength: 10000
example: |
**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
'/videos/{id}/views':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
post:
Update open api routes
2022-04-05 07:34:52 -05:00
summary: Notify user is watching a video
description: Call this endpoint regularly (every 5-10 seconds for example) to notify the server the user is watching the video. After a while, PeerTube will increase video's viewers counter. If the user is authenticated, PeerTube will also store the current player time.
add video upload types, add doc middleware to more routes
2021-06-06 03:21:06 -05:00
operationId: addView
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
- Video
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
Update open api routes
2022-04-05 07:34:52 -05:00
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserViewingVideo'
required: true
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
'/videos/{id}/watching':
put:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Set watching progress of a video
Update open api routes
2022-04-05 07:34:52 -05:00
deprecated: true
description: This endpoint has been deprecated. Use `/videos/{id}/views` instead
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
tags:
- Video
security:
- OAuth2: []
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
requestBody:
content:
application/json:
schema:
Update open api routes
2022-04-05 07:34:52 -05:00
$ref: '#/components/schemas/UserViewingVideo'
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
required: true
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Update open api routes
2022-04-05 07:34:52 -05:00
'/videos/{id}/stats/overall':
get:
summary: Get overall stats of a video
tags:
- Video Stats
security:
- OAuth2: []
parameters:
- $ref: '#/components/parameters/idOrUUID'
Add filter by start/end date overall stats in api
2022-05-05 07:12:57 -05:00
- name: startDate
in: query
description: Filter stats by start date
schema:
type: string
format: date-time
- name: endDate
in: query
description: Filter stats by end date
schema:
type: string
format: date-time
Update open api routes
2022-04-05 07:34:52 -05:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/VideoStatsOverall'
'/videos/{id}/stats/retention':
get:
summary: Get retention stats of a video
tags:
- Video Stats
security:
- OAuth2: []
parameters:
- $ref: '#/components/parameters/idOrUUID'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/VideoStatsRetention'
'/videos/{id}/stats/timeseries/{metric}':
get:
summary: Get timeserie stats of a video
tags:
- Video Stats
security:
- OAuth2: []
parameters:
- $ref: '#/components/parameters/idOrUUID'
-
name: metric
in: path
required: true
description: The metric to get
schema:
type: string
enum:
- 'viewers'
- 'aggregateWatchTime'
Add filter by start/end date overall stats in api
2022-05-05 07:12:57 -05:00
- name: startDate
in: query
description: Filter stats by start date
schema:
type: string
format: date-time
- name: endDate
in: query
description: Filter stats by end date
schema:
type: string
format: date-time
Update open api routes
2022-04-05 07:34:52 -05:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/VideoStatsTimeserie'
Api doc improvement (#252) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file
2018-01-25 11:39:51 -06:00
/videos/upload:
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
post:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Upload a video
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
description: Uses a single request to upload a video.
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
operationId: uploadLegacy
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
- Video
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
- Video Upload
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
$ref: '#/components/schemas/VideoUploadResponse'
Downsample to the closest divisor standard framerate
2020-01-14 16:34:03 -06:00
'403':
emit more specific status codes on video upload (#3423) - reduce http status codes list to potentially useful codes - convert more codes to typed ones - factorize html generator for error responses
2020-12-08 14:16:10 -06:00
description: video didn't pass upload filter
Downsample to the closest divisor standard framerate
2020-01-14 16:34:03 -06:00
'408':
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
description: upload has timed out
more explicit error messages for file uploads
2020-11-23 03:45:42 -06:00
'413':
add video upload types, add doc middleware to more routes
2021-06-06 03:21:06 -05:00
x-summary: video file too large, due to quota or max body size limit set by the reverse-proxy
description: |
If the response has no body, it means the reverse-proxy didn't let it through. Otherwise disambiguate via `type`:
Fix various typos Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
- `quota_reached` for quota limits whether daily or global
more explicit error messages for file uploads
2020-11-23 03:45:42 -06:00
headers:
X-File-Maximum-Size:
schema:
type: string
format: Nginx size
description: Maximum file size for the video
emit more specific status codes on video upload (#3423) - reduce http status codes list to potentially useful codes - convert more codes to typed ones - factorize html generator for error responses
2020-12-08 14:16:10 -06:00
'415':
description: video type unsupported
Downsample to the closest divisor standard framerate
2020-01-14 16:34:03 -06:00
'422':
emit more specific status codes on video upload (#3423) - reduce http status codes list to potentially useful codes - convert more codes to typed ones - factorize html generator for error responses
2020-12-08 14:16:10 -06:00
description: video unreadable
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
requestBody:
content:
multipart/form-data:
schema:
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
$ref: '#/components/schemas/VideoUploadRequestLegacy'
Improved description of all file uploads (#2053) * Add format:binary for file uploads * Fix wrongly named field for encoding * Fix typo in field name * Add contentType for torrentfile and captionfile * Add contentType for videofile
2019-08-21 01:32:15 -05:00
encoding:
videofile:
contentType: video/mp4, video/webm, video/ogg, video/avi, video/quicktime, video/x-msvideo, video/x-flv, video/x-matroska, application/octet-stream
thumbnailfile:
contentType: image/jpeg
previewfile:
contentType: image/jpeg
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
x-codeSamples:
fix API spec on POST /videos/upload and provide Shell example
2018-11-15 10:08:42 -06:00
- lang: Shell
source: |
Switch examples to curl since httpie has a 512MB limit (#3012) Co-authored-by: Rigel Kent <par@rigelk.eu>
2020-07-28 06:48:55 -05:00
## DEPENDENCIES: jq
fix API spec on POST /videos/upload and provide Shell example
2018-11-15 10:08:42 -06:00
USERNAME="<your_username>"
PASSWORD="<your_password>"
FILE_PATH="<your_file_path>"
CHANNEL_ID="<your_channel_id>"
NAME="<video_name>"
add code examples for login in openapi spec
2021-05-14 12:19:10 -05:00
API="https://peertube2.cpy.re/api/v1"
fix API spec on POST /videos/upload and provide Shell example
2018-11-15 10:08:42 -06:00
## AUTH
add code examples for login in openapi spec
2021-05-14 12:19:10 -05:00
client_id=$(curl -s "$API/oauth-clients/local" | jq -r ".client_id")
client_secret=$(curl -s "$API/oauth-clients/local" | jq -r ".client_secret")
token=$(curl -s "$API/users/token" \
Switch examples to curl since httpie has a 512MB limit (#3012) Co-authored-by: Rigel Kent <par@rigelk.eu>
2020-07-28 06:48:55 -05:00
--data client_id="$client_id" \
--data client_secret="$client_secret" \
--data grant_type=password \
--data username="$USERNAME" \
--data password="$PASSWORD" \
fix API spec on POST /videos/upload and provide Shell example
2018-11-15 10:08:42 -06:00
| jq -r ".access_token")
add code examples for login in openapi spec
2021-05-14 12:19:10 -05:00
fix API spec on POST /videos/upload and provide Shell example
2018-11-15 10:08:42 -06:00
## VIDEO UPLOAD
add code examples for login in openapi spec
2021-05-14 12:19:10 -05:00
curl -s "$API/videos/upload" \
Switch examples to curl since httpie has a 512MB limit (#3012) Co-authored-by: Rigel Kent <par@rigelk.eu>
2020-07-28 06:48:55 -05:00
-H "Authorization: Bearer $token" \
--max-time 600 \
--form videofile=@"$FILE_PATH" \
--form channelId=$CHANNEL_ID \
--form name="$NAME"
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
/videos/upload-resumable:
post:
summary: Initialize the resumable upload of a video
description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to initialize the upload of a video
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
operationId: uploadResumableInit
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
security:
- OAuth2: []
tags:
- Video
- Video Upload
parameters:
- name: X-Upload-Content-Length
in: header
schema:
type: number
example: 2469036
required: true
description: Number of bytes that will be uploaded in subsequent requests. Set this value to the size of the file you are uploading.
- name: X-Upload-Content-Type
in: header
schema:
type: string
format: mimetype
example: video/mp4
required: true
description: MIME type of the file that you are uploading. Depending on your instance settings, acceptable values might vary.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VideoUploadRequestResumable'
responses:
'200':
description: file already exists, send a [`resume`](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) request instead
'201':
description: created
headers:
Location:
schema:
type: string
format: url
example: /api/v1/videos/upload-resumable?upload_id=471e97554f21dec3b8bb5d4602939c51
Content-Length:
schema:
type: number
example: 0
'413':
add video upload types, add doc middleware to more routes
2021-06-06 03:21:06 -05:00
x-summary: video file too large, due to quota, absolute max file size or concurrent partial upload limit
description: |
Disambiguate via `type`:
- `max_file_size_reached` for the absolute file size limit
- `quota_reached` for quota limits whether daily or global
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
'415':
description: video type unsupported
put:
summary: Send chunk for the resumable upload of a video
description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to continue, pause or resume the upload of a video
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
operationId: uploadResumable
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
security:
- OAuth2: []
tags:
- Video
- Video Upload
parameters:
- name: upload_id
Fix openapi doc for resumable upload
2021-05-27 09:06:24 -05:00
in: query
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
required: true
description: |
Remove invalid info from REST API doc
2022-03-21 02:43:15 -05:00
Created session id to proceed with. If you didn't send chunks in the last hour, it is
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
not valid anymore and you need to initialize a new upload.
schema:
type: string
- name: Content-Range
in: header
schema:
type: string
example: bytes 0-262143/2469036
required: true
description: |
Specifies the bytes in the file that the request is uploading.
For example, a value of `bytes 0-262143/1000000` shows that the request is sending the first
262144 bytes (256 x 1024) in a 2,469,036 byte file.
- name: Content-Length
in: header
schema:
type: number
example: 262144
required: true
description: |
Size of the chunk that the request is sending.
Remember that larger chunks are more efficient. PeerTube's web client uses chunks varying from
1048576 bytes (~1MB) and increases or reduces size depending on connection health.
requestBody:
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
'200':
description: last chunk received
headers:
Content-Length:
schema:
type: number
content:
application/json:
schema:
$ref: '#/components/schemas/VideoUploadResponse'
'308':
description: resume incomplete
headers:
Range:
schema:
type: string
example: bytes=0-262143
Content-Length:
schema:
type: number
example: 0
'403':
description: video didn't pass upload filter
add video upload types, add doc middleware to more routes
2021-06-06 03:21:06 -05:00
'404':
description: upload not found
'409':
description: chunk doesn't match range
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
'422':
description: video unreadable
add video upload types, add doc middleware to more routes
2021-06-06 03:21:06 -05:00
'429':
description: too many concurrent requests
prevent multiple post-process triggering of upload-resumable (#4175) * prevent multiple post-process triggering of upload-resumable * switch from 409 to 503 for upload being processed * Improve resumable upload check Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-10-25 10:42:20 -05:00
'503':
description: upload is already being processed
headers:
'Retry-After':
schema:
type: number
example: 300
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
delete:
summary: Cancel the resumable upload of a video, deleting any data uploaded so far
description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the upload of a video
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
operationId: uploadResumableCancel
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
security:
- OAuth2: []
tags:
- Video
- Video Upload
parameters:
- name: upload_id
Fix openapi doc for resumable upload
2021-05-27 09:06:24 -05:00
in: query
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
required: true
description: |
Created session id to proceed with. If you didn't send chunks in the last 12 hours, it is
not valid anymore and the upload session has already been deleted with its data ;-)
schema:
type: string
- name: Content-Length
in: header
required: true
schema:
type: number
example: 0
responses:
'204':
description: upload cancelled
headers:
Content-Length:
schema:
type: number
example: 0
add video upload types, add doc middleware to more routes
2021-06-06 03:21:06 -05:00
'404':
description: upload not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Add video import enpoint in openapi
2019-02-19 10:56:09 -06:00
/videos/imports:
post:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Import a video
description: Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
operationId: importVideo
Add video import enpoint in openapi
2019-02-19 10:56:09 -06:00
security:
- OAuth2: []
tags:
Add ability to cancel & delete video imports
2022-01-19 07:23:00 -06:00
- Video Imports
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
- Video Upload
Add video import enpoint in openapi
2019-02-19 10:56:09 -06:00
requestBody:
content:
multipart/form-data:
schema:
factorized upload and import post fields in openapi spec closes #4075
2021-05-11 03:07:15 -05:00
$ref: '#/components/schemas/VideoCreateImport'
Improved description of all file uploads (#2053) * Add format:binary for file uploads * Fix wrongly named field for encoding * Fix typo in field name * Add contentType for torrentfile and captionfile * Add contentType for videofile
2019-08-21 01:32:15 -05:00
encoding:
torrentfile:
contentType: application/x-bittorrent
thumbnailfile:
contentType: image/jpeg
previewfile:
contentType: image/jpeg
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/VideoUploadResponse'
'400':
description: '`magnetUri` or `targetUrl` or a torrent file missing'
emit more specific status codes on video upload (#3423) - reduce http status codes list to potentially useful codes - convert more codes to typed ones - factorize html generator for error responses
2020-12-08 14:16:10 -06:00
'403':
description: video didn't pass pre-import filter
'409':
description: HTTP or Torrent/magnetURI import not enabled
Add openapi doc
2020-07-28 04:12:16 -05:00
Add ability to cancel & delete video imports
2022-01-19 07:23:00 -06:00
/videos/imports/{id}/cancel:
post:
summary: Cancel video import
description: Cancel a pending video import
security:
- OAuth2: []
tags:
- Video Imports
parameters:
- $ref: '#/components/parameters/id'
responses:
'204':
description: successful operation
/videos/imports/{id}:
delete:
summary: Delete video import
description: Delete ended video import
security:
- OAuth2: []
tags:
- Video Imports
parameters:
- $ref: '#/components/parameters/id'
responses:
'204':
description: successful operation
Add open api doc for live
2020-11-09 04:21:08 -06:00
/videos/live:
post:
summary: Create a live
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: addLive
Add open api doc for live
2020-11-09 04:21:08 -06:00
security:
- OAuth2: []
tags:
- Live Videos
- Video
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/VideoUploadResponse'
add video upload types, add doc middleware to more routes
2021-06-06 03:21:06 -05:00
'400':
x-summary: validation error, or conflicting `saveReplay` and `permanentLive` parameter set
description: |
Disambiguate via `type`:
- default type for a validation error
- `live_conflicting_permanent_and_save_replay` for conflicting parameters set
Add open api doc for live
2020-11-09 04:21:08 -06:00
'403':
add video upload types, add doc middleware to more routes
2021-06-06 03:21:06 -05:00
x-summary: live is not enabled, allow replay is not enabled, or max instance/user live videos limit is exceeded
description: |
Disambiguate via `type`:
- `live_not_enabled` for a disabled live feature
- `live_not_allowing_replay` for a disabled replay feature
- `max_instance_lives_limit_reached` for the absolute concurrent live limit
- `max_user_lives_limit_reached` for the user concurrent live limit
Add open api doc for live
2020-11-09 04:21:08 -06:00
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
channelId:
description: Channel id that will contain this live video
type: integer
saveReplay:
type: boolean
Add permanent live support
2020-12-03 07:10:54 -06:00
permanentLive:
description: User can stream multiple times in a permanent live
type: boolean
Add latency setting support
2022-03-04 06:40:02 -06:00
latencyMode:
description: User can select live latency mode if enabled by the instance
$ref: '#/components/schemas/LiveVideoLatencyMode'
Add open api doc for live
2020-11-09 04:21:08 -06:00
thumbnailfile:
description: Live video/replay thumbnail file
type: string
format: binary
previewfile:
description: Live video/replay preview file
type: string
format: binary
privacy:
$ref: '#/components/schemas/VideoPrivacySet'
category:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
$ref: '#/components/schemas/VideoCategorySet'
Add open api doc for live
2020-11-09 04:21:08 -06:00
licence:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
$ref: '#/components/schemas/VideoLicenceSet'
Add open api doc for live
2020-11-09 04:21:08 -06:00
language:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
$ref: '#/components/schemas/VideoLanguageSet'
Add open api doc for live
2020-11-09 04:21:08 -06:00
description:
description: Live video/replay description
type: string
support:
description: A text tell the audience how to support the creator
add response content for createVideoChannel endpoint in openapi spec closes #4077
2021-05-12 06:44:32 -05:00
example: Please support our work on https://soutenir.framasoft.org/en/ <3
Add open api doc for live
2020-11-09 04:21:08 -06:00
type: string
nsfw:
description: Whether or not this live video/replay contains sensitive content
type: boolean
name:
description: Live video/replay name
type: string
fix name limit for video in openapi spec
2021-05-03 05:17:30 -05:00
minLength: 3
maxLength: 120
Add open api doc for live
2020-11-09 04:21:08 -06:00
tags:
description: Live video/replay tags (maximum 5 tags each between 2 and 30 characters)
type: array
minItems: 1
maxItems: 5
items:
type: string
minLength: 2
maxLength: 30
commentsEnabled:
description: Enable or disable comments for this live video/replay
type: boolean
downloadEnabled:
Add downloadEnabled boolean to PUT video
2021-06-25 07:18:12 -05:00
description: Enable or disable downloading for the replay of this live video
Add open api doc for live
2020-11-09 04:21:08 -06:00
type: boolean
required:
- channelId
- name
encoding:
thumbnailfile:
contentType: image/jpeg
previewfile:
contentType: image/jpeg
/videos/live/{id}:
get:
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
summary: Get information about a live
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
operationId: getLiveId
Add open api doc for live
2020-11-09 04:21:08 -06:00
security:
- OAuth2: []
tags:
- Live Videos
- Video
parameters:
- $ref: '#/components/parameters/idOrUUID'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/LiveVideoResponse'
put:
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
summary: Update information about a live
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
operationId: updateLiveId
Add open api doc for live
2020-11-09 04:21:08 -06:00
security:
- OAuth2: []
tags:
- Live Videos
- Video
parameters:
- $ref: '#/components/parameters/idOrUUID'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LiveVideoUpdate'
responses:
'204':
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: successful operation
Add open api doc for live
2020-11-09 04:21:08 -06:00
'400':
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: bad parameters or trying to update a live that has already started
Add open api doc for live
2020-11-09 04:21:08 -06:00
'403':
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: trying to save replay of the live but saving replay is not enabled on the instance
Support live session in server
2022-05-03 04:38:07 -05:00
/videos/live/{id}/sessions:
get:
summary: List live sessions
description: List all sessions created in a particular live
security:
- OAuth2: []
tags:
- Live Videos
parameters:
- $ref: '#/components/parameters/idOrUUID'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
total:
type: integer
example: 1
data:
type: array
items:
$ref: '#/components/schemas/LiveVideoSessionResponse'
/videos/{id}/live-session:
get:
summary: Get live session of a replay
description: If the video is a replay of a live, you can find the associated live session using this endpoint
security:
- OAuth2: []
tags:
- Live Videos
parameters:
- $ref: '#/components/parameters/idOrUUID'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/LiveVideoSessionResponse'
Add open api doc for live
2020-11-09 04:21:08 -06:00
Add openapi doc
2020-07-28 04:12:16 -05:00
/users/me/abuses:
get:
summary: List my abuses
refactor abuses response list to totalDataList in openapi spec closes #4066
2021-05-10 07:26:17 -05:00
operationId: getMyAbuses
Add openapi doc
2020-07-28 04:12:16 -05:00
security:
- OAuth2: []
tags:
- Abuses
- My User
parameters:
- name: id
in: query
description: only list the report with this id
schema:
type: integer
- name: state
in: query
schema:
$ref: '#/components/schemas/AbuseStateSet'
refactor abuses response list to totalDataList in openapi spec closes #4066
2021-05-10 07:26:17 -05:00
- $ref: '#/components/parameters/abusesSort'
Add openapi doc
2020-07-28 04:12:16 -05:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
responses:
'200':
description: successful operation
content:
application/json:
schema:
refactor abuses response list to totalDataList in openapi spec closes #4066
2021-05-10 07:26:17 -05:00
type: object
properties:
total:
type: integer
example: 1
data:
type: array
items:
$ref: '#/components/schemas/Abuse'
Add openapi doc
2020-07-28 04:12:16 -05:00
Update openapi
2020-07-10 02:51:56 -05:00
/abuses:
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
Add new abuses tests
2020-07-08 08:51:46 -05:00
summary: List abuses
refactor abuses response list to totalDataList in openapi spec closes #4066
2021-05-10 07:26:17 -05:00
operationId: getAbuses
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
Openapi consistency
2020-04-21 05:09:54 -05:00
- OAuth2:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
- admin
- moderator
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Add new abuses tests
2020-07-08 08:51:46 -05:00
- Abuses
Apidoc (#302) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file * api documentation improvement
2018-02-17 12:24:56 -06:00
parameters:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- name: id
in: query
description: only list the report with this id
schema:
type: integer
- name: predefinedReason
in: query
description: predefined reason the listed reports should contain
schema:
Update openapi
2020-07-10 02:51:56 -05:00
$ref: '#/components/schemas/PredefinedAbuseReasons'
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- name: search
in: query
description: plain search that will match with video titles, reporter names and more
schema:
type: string
- name: state
in: query
schema:
Add openapi doc
2020-07-28 04:12:16 -05:00
$ref: '#/components/schemas/AbuseStateSet'
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- name: searchReporter
in: query
description: only list reports of a specific reporter
schema:
type: string
- name: searchReportee
description: only list reports of a specific reportee
in: query
schema:
type: string
- name: searchVideo
in: query
description: only list reports of a specific video
schema:
type: string
- name: searchVideoChannel
in: query
description: only list reports of a specific video channel
schema:
type: string
Update contributing guide
2020-07-10 02:39:53 -05:00
- name: videoIs
in: query
add video upload types, add doc middleware to more routes
2021-06-06 03:21:06 -05:00
description: only list deleted or blocklisted videos
Update contributing guide
2020-07-10 02:39:53 -05:00
schema:
type: string
enum:
- 'deleted'
- 'blacklisted'
- name: filter
in: query
description: only list account, comment or video reports
schema:
type: string
enum:
- 'video'
- 'comment'
- 'account'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
- $ref: '#/components/parameters/abusesSort'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
refactor abuses response list to totalDataList in openapi spec closes #4066
2021-05-10 07:26:17 -05:00
type: object
properties:
total:
type: integer
example: 1
data:
type: array
items:
$ref: '#/components/schemas/Abuse'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
post:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Report an abuse
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Add new abuses tests
2020-07-08 08:51:46 -05:00
- Abuses
Improve abuse api doc
2020-04-21 08:24:19 -05:00
requestBody:
predefined report reasons & improved reporter UI (#2842) - added `startAt` and `endAt` optional timestamps to help pin down reported sections of a video - added predefined report reasons - added video player with report modal
2020-06-22 06:00:39 -05:00
required: true
Improve abuse api doc
2020-04-21 08:24:19 -05:00
content:
application/json:
schema:
type: object
properties:
reason:
description: Reason why the user reports this video
type: string
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
minLength: 2
maxLength: 3000
predefined report reasons & improved reporter UI (#2842) - added `startAt` and `endAt` optional timestamps to help pin down reported sections of a video - added predefined report reasons - added video player with report modal
2020-06-22 06:00:39 -05:00
predefinedReasons:
Update openapi
2020-07-10 02:51:56 -05:00
$ref: '#/components/schemas/PredefinedAbuseReasons'
video:
type: object
properties:
id:
description: Video id to report
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
allOf:
- $ref: '#/components/schemas/Video/properties/id'
Update openapi
2020-07-10 02:51:56 -05:00
startAt:
type: integer
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
format: seconds
Update openapi
2020-07-10 02:51:56 -05:00
description: Timestamp in the video that marks the beginning of the report
minimum: 0
endAt:
type: integer
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
format: seconds
Update openapi
2020-07-10 02:51:56 -05:00
description: Timestamp in the video that marks the ending of the report
minimum: 0
comment:
type: object
properties:
id:
description: Comment id to report
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
allOf:
- $ref: '#/components/schemas/VideoComment/properties/id'
Update openapi
2020-07-10 02:51:56 -05:00
account:
type: object
properties:
id:
description: Account id to report
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
type: integer
predefined report reasons & improved reporter UI (#2842) - added `startAt` and `endAt` optional timestamps to help pin down reported sections of a video - added predefined report reasons - added video player with report modal
2020-06-22 06:00:39 -05:00
required:
- reason
Improve abuse api doc
2020-04-21 08:24:19 -05:00
responses:
modify response for adding abuse in openapi spec closes #4093
2021-05-13 16:37:35 -05:00
'200':
Improve abuse api doc
2020-04-21 08:24:19 -05:00
description: successful operation
modify response for adding abuse in openapi spec closes #4093
2021-05-13 16:37:35 -05:00
content:
application/json:
schema:
type: object
properties:
abuse:
type: object
properties:
id:
$ref: '#/components/schemas/id'
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
'400':
description: incorrect request parameters
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Update openapi
2020-07-10 02:51:56 -05:00
'/abuses/{abuseId}':
Improve abuse api doc
2020-04-21 08:24:19 -05:00
put:
summary: Update an abuse
security:
- OAuth2:
- admin
- moderator
tags:
Add new abuses tests
2020-07-08 08:51:46 -05:00
- Abuses
Improve abuse api doc
2020-04-21 08:24:19 -05:00
parameters:
- $ref: '#/components/parameters/abuseId'
requestBody:
content:
application/json:
schema:
type: object
properties:
state:
Add migrations
2020-07-07 07:34:16 -05:00
$ref: '#/components/schemas/AbuseStateSet'
Improve abuse api doc
2020-04-21 08:24:19 -05:00
moderationComment:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
description: Update the report comment visible only to the moderation team
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
minLength: 2
maxLength: 3000
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
responses:
'204':
description: successful operation
'404':
Add new abuses tests
2020-07-08 08:51:46 -05:00
description: abuse not found
Improve abuse api doc
2020-04-21 08:24:19 -05:00
delete:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
tags:
Add new abuses tests
2020-07-08 08:51:46 -05:00
- Abuses
Improve abuse api doc
2020-04-21 08:24:19 -05:00
summary: Delete an abuse
security:
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- admin
- moderator
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
parameters:
- $ref: '#/components/parameters/abuseId'
Improve abuse api doc
2020-04-21 08:24:19 -05:00
responses:
'204':
description: successful operation
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
'404':
description: block not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Add openapi doc
2020-07-28 04:12:16 -05:00
'/abuses/{abuseId}/messages':
get:
summary: List messages of an abuse
security:
- OAuth2: []
tags:
- Abuses
parameters:
- $ref: '#/components/parameters/abuseId'
responses:
'200':
description: successful operation
content:
application/json:
schema:
paginate response for abuse list in openapi spec closes #4094
2021-05-13 16:40:34 -05:00
type: object
properties:
total:
type: integer
example: 1
data:
type: array
items:
$ref: '#/components/schemas/AbuseMessage'
Add openapi doc
2020-07-28 04:12:16 -05:00
post:
summary: Add message to an abuse
security:
- OAuth2: []
tags:
- Abuses
Fix openapi schema
2020-08-03 01:59:41 -05:00
parameters:
- $ref: '#/components/parameters/abuseId'
Add openapi doc
2020-07-28 04:12:16 -05:00
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
message:
description: Message to send
type: string
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
minLength: 2
maxLength: 3000
Add openapi doc
2020-07-28 04:12:16 -05:00
required:
- message
responses:
'200':
description: successful operation
'400':
description: incorrect request parameters
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Add openapi doc
2020-07-28 04:12:16 -05:00
'/abuses/{abuseId}/messages/{abuseMessageId}':
delete:
summary: Delete an abuse message
security:
- OAuth2: []
tags:
- Abuses
parameters:
- $ref: '#/components/parameters/abuseId'
- $ref: '#/components/parameters/abuseMessageId'
responses:
'204':
description: successful operation
Improve abuse api doc
2020-04-21 08:24:19 -05:00
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
'/videos/{id}/blacklist':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
post:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
summary: Block a video
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: addVideoBlock
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- admin
- moderator
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
- Video Blocks
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
delete:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
summary: Unblock a video by its id
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: delVideoBlock
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- admin
- moderator
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
- Video Blocks
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
'404':
description: block not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Api doc improvement (#252) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file
2018-01-25 11:39:51 -06:00
/videos/blacklist:
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
tags:
- Video Blocks
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
summary: List video blocks
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: getVideoBlocks
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2:
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
- admin
- moderator
Apidoc (#302) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file * api documentation improvement
2018-02-17 12:24:56 -06:00
parameters:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- name: type
in: query
description: >
list only blocks that match this type:
- `1`: manual block
- `2`: automatic block that needs review
schema:
type: integer
enum:
- 1
- 2
- name: search
in: query
description: plain search that will match with video titles, and more
schema:
type: string
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
- $ref: '#/components/parameters/blacklistsSort'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
type: object
properties:
total:
type: integer
example: 1
data:
type: array
items:
$ref: '#/components/schemas/VideoBlacklist'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
/videos/{id}/captions:
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List captions of a video
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: getVideoCaptions
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
tags:
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
- Video Captions
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
total:
type: integer
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: 1
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
data:
type: array
items:
$ref: '#/components/schemas/VideoCaption'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
/videos/{id}/captions/{captionLanguage}:
put:
summary: Add or replace a video caption
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: addVideoCaption
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
security:
- OAuth2:
- user
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
tags:
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
- Video Captions
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
- $ref: '#/components/parameters/captionLanguage'
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
captionfile:
description: The file to upload.
type: string
format: binary
Improved description of all file uploads (#2053) * Add format:binary for file uploads * Fix wrongly named field for encoding * Fix typo in field name * Add contentType for torrentfile and captionfile * Add contentType for videofile
2019-08-21 01:32:15 -05:00
encoding:
captionfile:
Add video caption upload documentation and improve error message fixes #2038
2020-01-09 07:10:23 -06:00
contentType: text/vtt, application/x-subrip, text/plain
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
'404':
description: video or language not found
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
delete:
summary: Delete a video caption
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: delVideoCaption
remove outdated badges, add authorization to caption routes
2020-11-20 04:29:33 -06:00
security:
- OAuth2:
- user
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
tags:
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
- Video Captions
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
- $ref: '#/components/parameters/captionLanguage'
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
'404':
description: video or language or caption for that language not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Update video channel routes
2018-04-24 10:05:32 -05:00
/video-channels:
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List video channels
add response content for createVideoChannel endpoint in openapi spec closes #4077
2021-05-12 06:44:32 -05:00
operationId: getVideoChannels
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Channels
Apidoc (#302) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition * openapi fix typo + improvement on video/comment endpoints * removed misplaced openapi file * api documentation improvement
2018-02-17 12:24:56 -06:00
parameters:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
refactor subscriptions response from list to totalDataList in openapi spec closes #4067
2021-05-10 07:39:01 -05:00
$ref: '#/components/schemas/VideoChannelList'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
post:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Create a video channel
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: addVideoChannel
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Channels
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
add response content for createVideoChannel endpoint in openapi spec closes #4077
2021-05-12 06:44:32 -05:00
content:
application/json:
schema:
type: object
properties:
videoChannel:
type: object
properties:
id:
Implement avatar miniatures (#4639) * client: remove unused file * refactor(client/my-actor-avatar): size from input Read size from component input instead of scss, to make it possible to use smaller avatar images when implemented. * implement avatar miniatures close #4560 * fix(test): max file size * fix(search-index): normalize res acc to avatarMini * refactor avatars to an array * client/search: resize channel avatar to 120 * refactor(client/videos): remove unused function * client(actor-avatar): set default size * fix tests and avatars full result When findOne is used only an array containting one avatar is returned. * update migration version and version notations * server/search: harmonize normalizing * Cleanup avatar miniature PR Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-02-28 01:34:43 -06:00
$ref: '#/components/schemas/id'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
requestBody:
Server: Bulk update videos support field
2019-05-31 09:30:11 -05:00
content:
application/json:
schema:
$ref: '#/components/schemas/VideoChannelCreate'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Fix video channel API route param in doc
2019-04-24 09:57:23 -05:00
'/video-channels/{channelHandle}':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get a video channel
add response content for createVideoChannel endpoint in openapi spec closes #4077
2021-05-12 06:44:32 -05:00
operationId: getVideoChannel
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Channels
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
parameters:
Fix video channel API route param in doc
2019-04-24 09:57:23 -05:00
- $ref: '#/components/parameters/channelHandle'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
$ref: '#/components/schemas/VideoChannel'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
put:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Update a video channel
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: putVideoChannel
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Channels
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
parameters:
Fix video channel API route param in doc
2019-04-24 09:57:23 -05:00
- $ref: '#/components/parameters/channelHandle'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
requestBody:
Server: Bulk update videos support field
2019-05-31 09:30:11 -05:00
content:
application/json:
schema:
$ref: '#/components/schemas/VideoChannelUpdate'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
delete:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Delete a video channel
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: delVideoChannel
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Channels
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
parameters:
Fix video channel API route param in doc
2019-04-24 09:57:23 -05:00
- $ref: '#/components/parameters/channelHandle'
Update video-channel routes (again) Use /video-channels now, it's more simple for clients
2018-04-25 09:15:39 -05:00
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Fix video channel API route param in doc
2019-04-24 09:57:23 -05:00
'/video-channels/{channelHandle}/videos':
Update video-channel routes (again) Use /video-channels now, it's more simple for clients
2018-04-25 09:15:39 -05:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List videos of a video channel
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
operationId: getVideoChannelVideos
Update video-channel routes (again) Use /video-channels now, it's more simple for clients
2018-04-25 09:15:39 -05:00
tags:
Fix videos list response in rest api doc
2019-05-24 03:17:54 -05:00
- Video
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Channels
Update video-channel routes (again) Use /video-channels now, it's more simple for clients
2018-04-25 09:15:39 -05:00
parameters:
Fix video channel API route param in doc
2019-04-24 09:57:23 -05:00
- $ref: '#/components/parameters/channelHandle'
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
- $ref: '#/components/parameters/categoryOneOf'
Add ability to filter my videos by live
2021-05-03 04:06:19 -05:00
- $ref: '#/components/parameters/isLive'
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
- $ref: '#/components/parameters/tagsOneOf'
- $ref: '#/components/parameters/tagsAllOf'
- $ref: '#/components/parameters/licenceOneOf'
- $ref: '#/components/parameters/languageOneOf'
- $ref: '#/components/parameters/nsfw'
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
- $ref: '#/components/parameters/isLocal'
- $ref: '#/components/parameters/include'
Add ability to filter out public videos from admin
2021-11-12 07:19:56 -06:00
- $ref: '#/components/parameters/privacyOneOf'
Add ability to filter by file type
2021-11-03 05:32:41 -05:00
- $ref: '#/components/parameters/hasHLSFiles'
- $ref: '#/components/parameters/hasWebtorrentFiles'
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
- $ref: '#/components/parameters/skipCount'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/videosSort'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
Update video-channel routes (again) Use /video-channels now, it's more simple for clients
2018-04-25 09:15:39 -05:00
'200':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
Fix videos list response in rest api doc
2019-05-24 03:17:54 -05:00
$ref: '#/components/schemas/VideoListResponse'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Split check user params tests
2021-10-19 08:02:43 -05:00
'/video-channels/{channelHandle}/followers':
get:
tags:
- Video Channels
summary: 'List followers of a video channel'
security:
- OAuth2: []
operationId: getVideoChannelFollowers
parameters:
- $ref: '#/components/parameters/channelHandle'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/followersSort'
- $ref: '#/components/parameters/search'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
total:
type: integer
example: 1
data:
type: array
items:
$ref: '#/components/schemas/Follow'
Update avatar/banner API doc
2021-04-08 02:34:32 -05:00
'/video-channels/{channelHandle}/avatar/pick':
post:
summary: Update channel avatar
security:
- OAuth2: []
tags:
- Video Channels
parameters:
- $ref: '#/components/parameters/channelHandle'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
Implement avatar miniatures (#4639) * client: remove unused file * refactor(client/my-actor-avatar): size from input Read size from component input instead of scss, to make it possible to use smaller avatar images when implemented. * implement avatar miniatures close #4560 * fix(test): max file size * fix(search-index): normalize res acc to avatarMini * refactor avatars to an array * client/search: resize channel avatar to 120 * refactor(client/videos): remove unused function * client(actor-avatar): set default size * fix tests and avatars full result When findOne is used only an array containting one avatar is returned. * update migration version and version notations * server/search: harmonize normalizing * Cleanup avatar miniature PR Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-02-28 01:34:43 -06:00
avatars:
type: array
items:
$ref: '#/components/schemas/ActorImage'
Update avatar/banner API doc
2021-04-08 02:34:32 -05:00
'413':
description: image file too large
headers:
X-File-Maximum-Size:
schema:
type: string
format: Nginx size
description: Maximum file size for the avatar
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
avatarfile:
description: The file to upload.
type: string
format: binary
encoding:
avatarfile:
contentType: image/png, image/jpeg
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Update avatar/banner API doc
2021-04-08 02:34:32 -05:00
'/video-channels/{channelHandle}/avatar':
delete:
summary: Delete channel avatar
security:
- OAuth2: []
tags:
- Video Channels
parameters:
- $ref: '#/components/parameters/channelHandle'
responses:
'204':
description: successful operation
'/video-channels/{channelHandle}/banner/pick':
post:
summary: Update channel banner
security:
- OAuth2: []
tags:
- Video Channels
parameters:
- $ref: '#/components/parameters/channelHandle'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
Implement avatar miniatures (#4639) * client: remove unused file * refactor(client/my-actor-avatar): size from input Read size from component input instead of scss, to make it possible to use smaller avatar images when implemented. * implement avatar miniatures close #4560 * fix(test): max file size * fix(search-index): normalize res acc to avatarMini * refactor avatars to an array * client/search: resize channel avatar to 120 * refactor(client/videos): remove unused function * client(actor-avatar): set default size * fix tests and avatars full result When findOne is used only an array containting one avatar is returned. * update migration version and version notations * server/search: harmonize normalizing * Cleanup avatar miniature PR Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-02-28 01:34:43 -06:00
banners:
type: array
items:
$ref: '#/components/schemas/ActorImage'
Update avatar/banner API doc
2021-04-08 02:34:32 -05:00
'413':
description: image file too large
headers:
X-File-Maximum-Size:
schema:
type: string
format: Nginx size
description: Maximum file size for the banner
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
bannerfile:
description: The file to upload.
type: string
format: binary
encoding:
bannerfile:
contentType: image/png, image/jpeg
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Update avatar/banner API doc
2021-04-08 02:34:32 -05:00
'/video-channels/{channelHandle}/banner':
delete:
summary: Delete channel banner
security:
- OAuth2: []
tags:
- Video Channels
parameters:
- $ref: '#/components/parameters/channelHandle'
responses:
'204':
description: successful operation
Add API doc for playlists
2020-04-21 08:04:39 -05:00
/video-playlists/privacies:
get:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
summary: List available playlist privacy policies
operationId: getPlaylistPrivacyPolicies
Add API doc for playlists
2020-04-21 08:04:39 -05:00
tags:
- Video Playlists
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/api/v1/video-playlists/privacies
Add API doc for playlists
2020-04-21 08:04:39 -05:00
Update OpenAPI documentation to include basic playlists and new comment sorting
2019-12-27 10:52:53 -06:00
/video-playlists:
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List video playlists
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
operationId: getPlaylists
Update OpenAPI documentation to include basic playlists and new comment sorting
2019-12-27 10:52:53 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Playlists
Update OpenAPI documentation to include basic playlists and new comment sorting
2019-12-27 10:52:53 -06:00
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
responses:
'200':
description: successful operation
content:
application/json:
schema:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
type: object
properties:
total:
type: integer
example: 1
data:
type: array
items:
$ref: '#/components/schemas/VideoPlaylist'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
post:
summary: Create a video playlist
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: If the video playlist is set as public, `videoChannelId` is mandatory.
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: addPlaylist
Add API doc for playlists
2020-04-21 08:04:39 -05:00
security:
- OAuth2: []
tags:
- Video Playlists
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
videoPlaylist:
type: object
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/VideoPlaylist/properties/id'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
uuid:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/VideoPlaylist/properties/uuid'
Support short uuid for GET video/playlist
2021-06-28 10:30:59 -05:00
shortUUID:
$ref: '#/components/schemas/VideoPlaylist/properties/shortUUID'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
displayName:
description: Video playlist display name
type: string
fix name limit for video in openapi spec
2021-05-03 05:17:30 -05:00
minLength: 1
maxLength: 120
Add API doc for playlists
2020-04-21 08:04:39 -05:00
thumbnailfile:
description: Video playlist thumbnail file
type: string
format: binary
privacy:
$ref: '#/components/schemas/VideoPlaylistPrivacySet'
description:
description: Video playlist description
type: string
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
minLength: 3
maxLength: 1000
Add API doc for playlists
2020-04-21 08:04:39 -05:00
videoChannelId:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
allOf:
- $ref: '#/components/schemas/id'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: Video channel in which the playlist will be published
required:
- displayName
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
encoding:
thumbnailfile:
contentType: image/jpeg
Add API doc for playlists
2020-04-21 08:04:39 -05:00
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
/video-playlists/{playlistId}:
Add API doc for playlists
2020-04-21 08:04:39 -05:00
get:
summary: Get a video playlist
tags:
- Video Playlists
parameters:
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
- $ref: '#/components/parameters/playlistId'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/VideoPlaylist'
put:
summary: Update a video playlist
description: 'If the video playlist is set as public, the playlist must have a assigned channel.'
security:
- OAuth2: []
tags:
- Video Playlists
responses:
'204':
description: successful operation
parameters:
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
- $ref: '#/components/parameters/playlistId'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
displayName:
description: Video playlist display name
type: string
fix name limit for video in openapi spec
2021-05-03 05:17:30 -05:00
minLength: 1
maxLength: 120
Add API doc for playlists
2020-04-21 08:04:39 -05:00
thumbnailfile:
description: Video playlist thumbnail file
type: string
format: binary
privacy:
$ref: '#/components/schemas/VideoPlaylistPrivacySet'
description:
description: Video playlist description
type: string
videoChannelId:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
allOf:
- $ref: '#/components/schemas/id'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: Video channel in which the playlist will be published
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
encoding:
thumbnailfile:
contentType: image/jpeg
Add API doc for playlists
2020-04-21 08:04:39 -05:00
delete:
summary: Delete a video playlist
security:
- OAuth2: []
tags:
- Video Playlists
parameters:
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
- $ref: '#/components/parameters/playlistId'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
responses:
'204':
description: successful operation
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
/video-playlists/{playlistId}/videos:
Add API doc for playlists
2020-04-21 08:04:39 -05:00
get:
summary: 'List videos of a playlist'
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: getVideoPlaylistVideos
Add API doc for playlists
2020-04-21 08:04:39 -05:00
tags:
- Videos
- Video Playlists
parameters:
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
- $ref: '#/components/parameters/playlistId'
Add missing start and count parameters to playlist video list API endpoint documentation
2021-10-19 12:22:45 -05:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/VideoListResponse'
post:
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
summary: Add a video in a playlist
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: addVideoPlaylistVideo
Add API doc for playlists
2020-04-21 08:04:39 -05:00
security:
- OAuth2: []
tags:
- Videos
- Video Playlists
parameters:
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
- $ref: '#/components/parameters/playlistId'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
videoPlaylistElement:
type: object
properties:
id:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
example: 2
Add API doc for playlists
2020-04-21 08:04:39 -05:00
requestBody:
content:
application/json:
schema:
type: object
properties:
videoId:
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
oneOf:
- $ref: '#/components/schemas/Video/properties/uuid'
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
- $ref: '#/components/schemas/Video/properties/id'
description: Video to add in the playlist
Add API doc for playlists
2020-04-21 08:04:39 -05:00
startTimestamp:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
format: seconds
description: Start the video at this specific timestamp
Add API doc for playlists
2020-04-21 08:04:39 -05:00
stopTimestamp:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
format: seconds
description: Stop the video at this specific timestamp
Add API doc for playlists
2020-04-21 08:04:39 -05:00
required:
- videoId
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
/video-playlists/{playlistId}/videos/reorder:
Add API doc for playlists
2020-04-21 08:04:39 -05:00
post:
summary: 'Reorder a playlist'
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: reorderVideoPlaylist
Add API doc for playlists
2020-04-21 08:04:39 -05:00
security:
- OAuth2: []
tags:
- Video Playlists
parameters:
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
- $ref: '#/components/parameters/playlistId'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
responses:
'204':
description: successful operation
requestBody:
content:
application/json:
schema:
type: object
properties:
startPosition:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
description: 'Start position of the element to reorder'
minimum: 1
Add API doc for playlists
2020-04-21 08:04:39 -05:00
insertAfterPosition:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
description: 'New position for the block to reorder, to add the block before the first element'
minimum: 0
Add API doc for playlists
2020-04-21 08:04:39 -05:00
reorderLength:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
description: 'How many element from `startPosition` to reorder'
minimum: 1
Add API doc for playlists
2020-04-21 08:04:39 -05:00
required:
- startPosition
- insertAfterPosition
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
/video-playlists/{playlistId}/videos/{playlistElementId}:
Add API doc for playlists
2020-04-21 08:04:39 -05:00
put:
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
summary: Update a playlist element
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: putVideoPlaylistVideo
Add API doc for playlists
2020-04-21 08:04:39 -05:00
security:
- OAuth2: []
tags:
- Video Playlists
parameters:
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
- $ref: '#/components/parameters/playlistId'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
- $ref: '#/components/parameters/playlistElementId'
responses:
'204':
description: successful operation
requestBody:
content:
application/json:
schema:
type: object
properties:
startTimestamp:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
format: seconds
description: Start the video at this specific timestamp
Add API doc for playlists
2020-04-21 08:04:39 -05:00
stopTimestamp:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
format: seconds
description: Stop the video at this specific timestamp
Add API doc for playlists
2020-04-21 08:04:39 -05:00
delete:
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
summary: Delete an element from a playlist
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: delVideoPlaylistVideo
Add API doc for playlists
2020-04-21 08:04:39 -05:00
security:
- OAuth2: []
tags:
- Video Playlists
parameters:
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
- $ref: '#/components/parameters/playlistId'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
- $ref: '#/components/parameters/playlistElementId'
responses:
'204':
description: successful operation
Add playlist exist api doc
2020-04-21 09:41:31 -05:00
'/users/me/video-playlists/videos-exist':
get:
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
summary: Check video exists in my playlists
Add playlist exist api doc
2020-04-21 09:41:31 -05:00
security:
- OAuth2: []
tags:
- Video Playlists
parameters:
- name: videoIds
in: query
required: true
description: The video ids to check
schema:
type: array
items:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/Video/properties/id'
Add playlist exist api doc
2020-04-21 09:41:31 -05:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
videoId:
type: array
items:
type: object
properties:
playlistElementId:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
Add playlist exist api doc
2020-04-21 09:41:31 -05:00
playlistId:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
Add playlist exist api doc
2020-04-21 09:41:31 -05:00
startTimestamp:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
format: seconds
Add playlist exist api doc
2020-04-21 09:41:31 -05:00
stopTimestamp:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
format: seconds
Add playlist exist api doc
2020-04-21 09:41:31 -05:00
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
'/accounts/{name}/video-channels':
Video channel API routes refractor
2018-04-25 03:21:38 -05:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List video channels of an account
Video channel API routes refractor
2018-04-25 03:21:38 -05:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Channels
- Accounts
Video channel API routes refractor
2018-04-25 03:21:38 -05:00
parameters:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/name'
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- name: withStats
in: query
Added "total views" in the my channels list (#5007) * Added "total views" in the my channels list Implements https://github.com/Chocobozzz/PeerTube/issues/4331 * Fix lint * applied suggested change * updated openAPI spec for the use "withStats" when getting video channels * applied code change * removed GROUP BY in query * Fixed test
2022-05-31 09:01:11 -05:00
description: include daily view statistics for the last 30 days and total views (only if authentified as the account user)
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
schema:
type: boolean
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
Video channel API routes refractor
2018-04-25 03:21:38 -05:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
refactor subscriptions response from list to totalDataList in openapi spec closes #4067
2021-05-10 07:39:01 -05:00
$ref: '#/components/schemas/VideoChannelList'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Add /accounts/:username/ratings endpoint (#1756) * Add /users/me/videos/ratings endpoint * Move ratings endpoint from users to accounts * /accounts/:name/ratings: add support for rating= and sort= * Restrict ratings list to owner * Wording and better way to ensure current account
2019-04-09 04:02:02 -05:00
'/accounts/{name}/ratings':
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List ratings of an account
Add /accounts/:username/ratings endpoint (#1756) * Add /users/me/videos/ratings endpoint * Move ratings endpoint from users to accounts * /accounts/:name/ratings: add support for rating= and sort= * Restrict ratings list to owner * Wording and better way to ensure current account
2019-04-09 04:02:02 -05:00
security:
- OAuth2: []
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Accounts
Add /accounts/:username/ratings endpoint (#1756) * Add /users/me/videos/ratings endpoint * Move ratings endpoint from users to accounts * /accounts/:name/ratings: add support for rating= and sort= * Restrict ratings list to owner * Wording and better way to ensure current account
2019-04-09 04:02:02 -05:00
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/name'
Add /accounts/:username/ratings endpoint (#1756) * Add /users/me/videos/ratings endpoint * Move ratings endpoint from users to accounts * /accounts/:name/ratings: add support for rating= and sort= * Restrict ratings list to owner * Wording and better way to ensure current account
2019-04-09 04:02:02 -05:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
- name: rating
in: query
required: false
Fixed 2 typos
2019-08-07 03:26:46 -05:00
description: Optionally filter which ratings to retrieve
Add /accounts/:username/ratings endpoint (#1756) * Add /users/me/videos/ratings endpoint * Move ratings endpoint from users to accounts * /accounts/:name/ratings: add support for rating= and sort= * Restrict ratings list to owner * Wording and better way to ensure current account
2019-04-09 04:02:02 -05:00
schema:
type: string
enum:
- like
- dislike
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VideoRating'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
'/videos/{id}/comment-threads':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: List threads of a video
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Comments
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
Update OpenAPI documentation to include basic playlists and new comment sorting
2019-12-27 10:52:53 -06:00
- $ref: '#/components/parameters/commentsSort'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
$ref: '#/components/schemas/CommentThreadResponse'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
post:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Create a thread
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Comments
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
$ref: '#/components/schemas/CommentThreadPostResponse'
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
'404':
description: video does not exist
Fix comment body api doc
2020-04-21 08:28:17 -05:00
requestBody:
content:
application/json:
schema:
type: object
properties:
text:
add missing video comment fields in openapi spec closes #4079
2021-05-11 13:19:26 -05:00
allOf:
- $ref: '#/components/schemas/VideoComment/properties/text'
format: markdown
maxLength: 10000
Fix comment body api doc
2020-04-21 08:28:17 -05:00
required:
- text
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
'/videos/{id}/comment-threads/{threadId}':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
get:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Get a thread
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Comments
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
- $ref: '#/components/parameters/threadId'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
$ref: '#/components/schemas/VideoCommentThreadTree'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
'/videos/{id}/comments/{commentId}':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
post:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Reply to a thread of a video
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Comments
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/commentId'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
$ref: '#/components/schemas/CommentThreadPostResponse'
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
'404':
description: thread or video does not exist
Fix comment body api doc
2020-04-21 08:28:17 -05:00
requestBody:
content:
application/json:
schema:
type: object
properties:
text:
add missing video comment fields in openapi spec closes #4079
2021-05-11 13:19:26 -05:00
allOf:
- $ref: '#/components/schemas/VideoComment/properties/text'
format: markdown
maxLength: 10000
Fix comment body api doc
2020-04-21 08:28:17 -05:00
required:
- text
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
delete:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Delete a comment or a reply
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Comments
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/commentId'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
'403':
description: cannot remove comment of another user
'404':
description: comment or video does not exist
'409':
description: comment is already deleted
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
'/videos/{id}/rate':
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
put:
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Like/dislike a video
Add auth documentation
2018-04-16 03:48:17 -05:00
security:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- OAuth2: []
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
tags:
Openapi consistency
2020-04-21 05:09:54 -05:00
- Video Rates
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
parameters:
Fix openapi schema
2019-07-03 10:28:09 -05:00
- $ref: '#/components/parameters/idOrUUID'
add rating field for video like endpoint in openapi spec closes #4080
2021-05-11 14:44:27 -05:00
requestBody:
content:
application/json:
schema:
type: object
properties:
rating:
type: string
enum:
- like
- dislike
add response content for createVideoChannel endpoint in openapi spec closes #4077
2021-05-12 06:44:32 -05:00
required:
- rating
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
responses:
Add ability to run transcoding jobs
2021-11-18 07:35:08 -06:00
'204':
description: successful operation
'404':
description: video does not exist
'/videos/{id}/hls':
delete:
summary: Delete video HLS files
security:
- OAuth2:
- admin
tags:
- Video Files
operationId: delVideoHLS
parameters:
- $ref: '#/components/parameters/idOrUUID'
responses:
'204':
description: successful operation
'404':
description: video does not exist
'/videos/{id}/webtorrent':
delete:
summary: Delete video WebTorrent files
security:
- OAuth2:
- admin
tags:
- Video Files
operationId: delVideoWebTorrent
parameters:
- $ref: '#/components/parameters/idOrUUID'
responses:
'204':
description: successful operation
'404':
description: video does not exist
'/videos/{id}/transcoding':
post:
summary: Create a transcoding job
security:
- OAuth2:
- admin
tags:
- Video Transcoding
operationId: createVideoTranscoding
parameters:
- $ref: '#/components/parameters/idOrUUID'
requestBody:
content:
application/json:
schema:
type: object
properties:
transcodingType:
type: string
enum:
- hls
- webtorrent
required:
- transcodingType
responses:
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
'204':
Add API doc for playlists
2020-04-21 08:04:39 -05:00
description: successful operation
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
'404':
description: video does not exist
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Correct API documentation for search (#878)
2018-07-28 13:38:49 -05:00
/search/videos:
get:
tags:
- Search
Openapi consistency
2020-04-21 05:09:54 -05:00
summary: Search videos
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: searchVideos
Correct API documentation for search (#878)
2018-07-28 13:38:49 -05:00
parameters:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- name: search
in: query
required: true
allowEmptyValue: false
description: >
String to search. If the user can make a remote URI search, and the string is an URI then the
PeerTube instance will fetch the remote object and add it to its database. Then,
you can use the REST API to fetch the complete video information and interact with it.
schema:
type: string
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
- $ref: '#/components/parameters/categoryOneOf'
Add ability to filter my videos by live
2021-05-03 04:06:19 -05:00
- $ref: '#/components/parameters/isLive'
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
- $ref: '#/components/parameters/tagsOneOf'
- $ref: '#/components/parameters/tagsAllOf'
- $ref: '#/components/parameters/licenceOneOf'
- $ref: '#/components/parameters/languageOneOf'
- $ref: '#/components/parameters/nsfw'
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
- $ref: '#/components/parameters/isLocal'
- $ref: '#/components/parameters/include'
Add ability to filter out public videos from admin
2021-11-12 07:19:56 -06:00
- $ref: '#/components/parameters/privacyOneOf'
Add ability to filter by file type
2021-11-03 05:32:41 -05:00
- $ref: '#/components/parameters/hasHLSFiles'
- $ref: '#/components/parameters/hasWebtorrentFiles'
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
- $ref: '#/components/parameters/skipCount'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
Add rest api doc for index search
2020-06-10 08:18:15 -05:00
- $ref: '#/components/parameters/searchTarget'
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
- $ref: '#/components/parameters/videosSearchSort'
Add rest api doc for index search
2020-06-10 08:18:15 -05:00
- name: startDate
in: query
description: Get videos that are published after this date
schema:
type: string
format: date-time
- name: endDate
in: query
description: Get videos that are published before this date
schema:
type: string
format: date-time
- name: originallyPublishedStartDate
in: query
description: Get videos that are originally published after this date
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
schema:
type: string
Add rest api doc for index search
2020-06-10 08:18:15 -05:00
format: date-time
- name: originallyPublishedEndDate
in: query
description: Get videos that are originally published before this date
schema:
type: string
format: date-time
- name: durationMin
in: query
description: Get videos that have this minimum duration
schema:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
Add rest api doc for index search
2020-06-10 08:18:15 -05:00
- name: durationMax
in: query
description: Get videos that have this maximum duration
schema:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
callbacks:
'searchTarget === search-index':
$ref: '#/components/callbacks/searchIndex'
Correct API documentation for search (#878)
2018-07-28 13:38:49 -05:00
responses:
'200':
description: successful operation
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
content:
application/json:
schema:
Fix videos list response in rest api doc
2019-05-24 03:17:54 -05:00
$ref: '#/components/schemas/VideoListResponse'
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
'500':
description: search index unavailable
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
Add rest api doc for index search
2020-06-10 08:18:15 -05:00
/search/video-channels:
get:
tags:
- Search
summary: Search channels
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: searchChannels
Add rest api doc for index search
2020-06-10 08:18:15 -05:00
parameters:
- name: search
in: query
required: true
description: >
String to search. If the user can make a remote URI search, and the string is an URI then the
PeerTube instance will fetch the remote object and add it to its database. Then,
you can use the REST API to fetch the complete channel information and interact with it.
schema:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/searchTarget'
- $ref: '#/components/parameters/sort'
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
callbacks:
'searchTarget === search-index':
$ref: '#/components/callbacks/searchIndex'
Add rest api doc for index search
2020-06-10 08:18:15 -05:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
refactor subscriptions response from list to totalDataList in openapi spec closes #4067
2021-05-10 07:39:01 -05:00
$ref: '#/components/schemas/VideoChannelList'
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
'500':
description: search index unavailable
Add ability to search playlists
2021-06-17 09:02:38 -05:00
/search/video-playlists:
get:
tags:
- Search
summary: Search playlists
operationId: searchPlaylists
parameters:
- name: search
in: query
required: true
description: >
String to search. If the user can make a remote URI search, and the string is an URI then the
PeerTube instance will fetch the remote object and add it to its database. Then,
you can use the REST API to fetch the complete playlist information and interact with it.
schema:
type: string
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/searchTarget'
- $ref: '#/components/parameters/sort'
callbacks:
'searchTarget === search-index':
$ref: '#/components/callbacks/searchIndex'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
total:
type: integer
example: 1
data:
type: array
items:
$ref: '#/components/schemas/VideoPlaylist'
'500':
description: search index unavailable
fix route prefix for blocklist routes in openapi spec closes #4091
2021-05-13 07:19:59 -05:00
Add account block status in openapi
2021-12-07 04:30:53 -06:00
/blocklist/status:
get:
tags:
- Account Blocks
- Server Blocks
summary: Get block status of accounts/hosts
parameters:
-
name: 'accounts'
in: query
description: 'Check if these accounts are blocked'
example: [ 'goofy@example.com', 'donald@example.com' ]
schema:
type: array
items:
type: string
-
name: 'hosts'
in: query
description: 'Check if these hosts are blocked'
example: [ 'example.com' ]
schema:
type: array
items:
type: string
responses:
'200':
description: successful operation
content:
'application/json':
schema:
$ref: '#/components/schemas/BlockStatus'
fix route prefix for blocklist routes in openapi spec closes #4091
2021-05-13 07:19:59 -05:00
/server/blocklist/accounts:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
get:
tags:
- Account Blocks
summary: List account blocks
security:
- OAuth2:
- admin
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
responses:
'200':
description: successful operation
post:
tags:
- Account Blocks
summary: Block an account
security:
- OAuth2:
- admin
requestBody:
content:
application/json:
schema:
type: object
properties:
accountName:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: chocobozzz@example.org
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: account to block, in the form `username@domain`
required:
- accountName
responses:
'200':
description: successful operation
'409':
description: self-blocking forbidden
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
fix route prefix for blocklist routes in openapi spec closes #4091
2021-05-13 07:19:59 -05:00
'/server/blocklist/accounts/{accountName}':
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
delete:
tags:
- Account Blocks
summary: Unblock an account by its handle
security:
- OAuth2:
- admin
parameters:
- name: accountName
in: path
required: true
description: account to unblock, in the form `username@domain`
schema:
type: string
responses:
'201':
description: successful operation
'404':
description: account or account block does not exist
fix route prefix for blocklist routes in openapi spec closes #4091
2021-05-13 07:19:59 -05:00
/server/blocklist/servers:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
get:
tags:
- Server Blocks
summary: List server blocks
security:
- OAuth2:
- admin
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
responses:
'200':
description: successful operation
post:
tags:
- Server Blocks
summary: Block a server
security:
- OAuth2:
- admin
requestBody:
content:
application/json:
schema:
type: object
properties:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
host:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: hostname
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: server domain to block
required:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- host
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
responses:
modify return code for adding/removing blocked servers in openapi spec closes #4095
2021-05-13 16:32:28 -05:00
'204':
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: successful operation
'409':
description: self-blocking forbidden
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
fix route prefix for blocklist routes in openapi spec closes #4091
2021-05-13 07:19:59 -05:00
'/server/blocklist/servers/{host}':
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
delete:
tags:
- Server Blocks
summary: Unblock a server by its domain
security:
- OAuth2:
- admin
parameters:
- name: host
in: path
required: true
description: server domain to unblock
schema:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: hostname
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
responses:
modify return code for adding/removing blocked servers in openapi spec closes #4095
2021-05-13 16:32:28 -05:00
'204':
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: successful operation
'404':
description: account block does not exist
fix route prefix for blocklist routes in openapi spec closes #4091
2021-05-13 07:19:59 -05:00
fix route prefix for video redundancy routes in openapi spec closes #4090
2021-05-13 07:17:56 -05:00
/server/redundancy/{host}:
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
put:
tags:
- Instance Redundancy
summary: Update a server redundancy policy
security:
- OAuth2:
- admin
parameters:
- name: host
in: path
required: true
description: server domain to mirror
schema:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: hostname
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
requestBody:
content:
application/json:
schema:
type: object
properties:
redundancyAllowed:
type: boolean
description: allow mirroring of the host's local videos
required:
- redundancyAllowed
responses:
'204':
description: successful operation
'404':
description: server is not already known
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
fix route prefix for video redundancy routes in openapi spec closes #4090
2021-05-13 07:17:56 -05:00
/server/redundancy/videos:
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
get:
tags:
- Video Mirroring
summary: List videos being mirrored
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: getMirroredVideos
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
security:
- OAuth2:
- admin
parameters:
- name: target
in: query
required: true
description: direction of the mirror
schema:
type: string
enum:
- my-videos
- remote-videos
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/videoRedundanciesSort'
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/VideoRedundancy'
post:
tags:
- Video Mirroring
summary: Mirror a video
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: putMirroredVideo
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
security:
- OAuth2:
- admin
requestBody:
content:
application/json:
schema:
type: object
properties:
videoId:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/Video/properties/id'
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
required:
- videoId
responses:
'204':
description: successful operation
'400':
description: cannot mirror a local video
'404':
description: video does not exist
'409':
description: video is already mirrored
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
fix route prefix for video redundancy routes in openapi spec closes #4090
2021-05-13 07:17:56 -05:00
/server/redundancy/videos/{redundancyId}:
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
delete:
tags:
- Video Mirroring
summary: Delete a mirror done on a video
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: delMirroredVideo
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
security:
- OAuth2:
- admin
parameters:
- name: redundancyId
in: path
required: true
description: id of an existing redundancy on a video
schema:
type: string
responses:
'204':
description: successful operation
'404':
description: video redundancy not found
fix route prefix for blocklist routes in openapi spec closes #4091
2021-05-13 07:19:59 -05:00
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
'/feeds/video-comments.{format}':
get:
tags:
- Feeds
summary: List comments on videos
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: getSyndicatedComments
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
parameters:
- name: format
in: path
required: true
allow limiting video-comments rss feeds to an account or video channel
2020-06-27 06:12:30 -05:00
description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
schema:
type: string
enum:
- xml
- rss
- rss2
- atom
- atom1
- json
- json1
- name: videoId
fix openapi path for feeds examples
2020-06-24 08:13:24 -05:00
in: query
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: 'limit listing to a specific video'
schema:
type: string
allow limiting video-comments rss feeds to an account or video channel
2020-06-27 06:12:30 -05:00
- name: accountId
in: query
description: 'limit listing to a specific account'
schema:
type: string
- name: accountName
in: query
description: 'limit listing to a specific account'
schema:
type: string
- name: videoChannelId
in: query
description: 'limit listing to a specific video channel'
schema:
type: string
- name: videoChannelName
in: query
description: 'limit listing to a specific video channel'
schema:
type: string
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
responses:
'204':
description: successful operation
headers:
Cache-Control:
schema:
type: string
default: 'max-age=900' # 15 min cache
content:
application/xml:
schema:
$ref: '#/components/schemas/VideoCommentsForXML'
add subscriptions feed api to openapi spec
2021-05-06 19:15:02 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/feeds/video-comments.xml?filter=local
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
application/rss+xml:
schema:
$ref: '#/components/schemas/VideoCommentsForXML'
add subscriptions feed api to openapi spec
2021-05-06 19:15:02 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/feeds/video-comments.rss?filter=local
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
text/xml:
schema:
$ref: '#/components/schemas/VideoCommentsForXML'
add subscriptions feed api to openapi spec
2021-05-06 19:15:02 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/feeds/video-comments.xml?filter=local
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
application/atom+xml:
schema:
$ref: '#/components/schemas/VideoCommentsForXML'
add subscriptions feed api to openapi spec
2021-05-06 19:15:02 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/feeds/video-comments.atom?filter=local
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
application/json:
schema:
type: object
add subscriptions feed api to openapi spec
2021-05-06 19:15:02 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/feeds/video-comments.json?filter=local
allow limiting video-comments rss feeds to an account or video channel
2020-06-27 06:12:30 -05:00
'400':
x-summary: field inconsistencies
description: >
Arises when:
- videoId filter is mixed with a channel filter
'404':
description: video, video channel or account not found
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
'406':
description: accept header unsupported
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
'/feeds/videos.{format}':
get:
tags:
- Feeds
summary: List videos
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: getSyndicatedVideos
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
parameters:
- name: format
in: path
required: true
allow limiting video-comments rss feeds to an account or video channel
2020-06-27 06:12:30 -05:00
description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
schema:
type: string
enum:
- xml
- rss
- rss2
- atom
- atom1
- json
- json1
- name: accountId
fix openapi path for feeds examples
2020-06-24 08:13:24 -05:00
in: query
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: 'limit listing to a specific account'
schema:
type: string
- name: accountName
fix openapi path for feeds examples
2020-06-24 08:13:24 -05:00
in: query
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: 'limit listing to a specific account'
schema:
type: string
- name: videoChannelId
fix openapi path for feeds examples
2020-06-24 08:13:24 -05:00
in: query
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: 'limit listing to a specific video channel'
schema:
type: string
- name: videoChannelName
fix openapi path for feeds examples
2020-06-24 08:13:24 -05:00
in: query
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: 'limit listing to a specific video channel'
schema:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/nsfw'
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
- $ref: '#/components/parameters/isLocal'
- $ref: '#/components/parameters/include'
Add ability to filter out public videos from admin
2021-11-12 07:19:56 -06:00
- $ref: '#/components/parameters/privacyOneOf'
Add ability to filter by file type
2021-11-03 05:32:41 -05:00
- $ref: '#/components/parameters/hasHLSFiles'
- $ref: '#/components/parameters/hasWebtorrentFiles'
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
responses:
'204':
description: successful operation
headers:
Cache-Control:
schema:
type: string
default: 'max-age=900' # 15 min cache
content:
application/xml:
schema:
$ref: '#/components/schemas/VideosForXML'
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
application/rss+xml:
schema:
$ref: '#/components/schemas/VideosForXML'
add subscriptions feed api to openapi spec
2021-05-06 19:15:02 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/feeds/videos.rss?filter=local
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
text/xml:
schema:
$ref: '#/components/schemas/VideosForXML'
add subscriptions feed api to openapi spec
2021-05-06 19:15:02 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
application/atom+xml:
schema:
$ref: '#/components/schemas/VideosForXML'
add subscriptions feed api to openapi spec
2021-05-06 19:15:02 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/feeds/videos.atom?filter=local
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
application/json:
schema:
type: object
add subscriptions feed api to openapi spec
2021-05-06 19:15:02 -05:00
examples:
nightly:
externalValue: https://peertube2.cpy.re/feeds/videos.json?filter=local
allow limiting video-comments rss feeds to an account or video channel
2020-06-27 06:12:30 -05:00
'404':
description: video channel or account not found
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
'406':
description: accept header unsupported
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add subscriptions feed api to openapi spec
2021-05-06 19:15:02 -05:00
'/feeds/subscriptions.{format}':
get:
tags:
- Feeds
- Account
summary: List videos of subscriptions tied to a token
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: getSyndicatedSubscriptionVideos
add subscriptions feed api to openapi spec
2021-05-06 19:15:02 -05:00
parameters:
- name: format
in: path
required: true
description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
schema:
type: string
enum:
- xml
- rss
- rss2
- atom
- atom1
- json
- json1
- name: accountId
in: query
description: limit listing to a specific account
schema:
type: string
required: true
- name: token
in: query
description: private token allowing access
schema:
type: string
required: true
- $ref: '#/components/parameters/sort'
- $ref: '#/components/parameters/nsfw'
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
- $ref: '#/components/parameters/isLocal'
- $ref: '#/components/parameters/include'
Add ability to filter out public videos from admin
2021-11-12 07:19:56 -06:00
- $ref: '#/components/parameters/privacyOneOf'
Add ability to filter by file type
2021-11-03 05:32:41 -05:00
- $ref: '#/components/parameters/hasHLSFiles'
- $ref: '#/components/parameters/hasWebtorrentFiles'
add subscriptions feed api to openapi spec
2021-05-06 19:15:02 -05:00
responses:
'204':
description: successful operation
headers:
Cache-Control:
schema:
type: string
default: 'max-age=900' # 15 min cache
content:
application/xml:
schema:
$ref: '#/components/schemas/VideosForXML'
application/rss+xml:
schema:
$ref: '#/components/schemas/VideosForXML'
text/xml:
schema:
$ref: '#/components/schemas/VideosForXML'
application/atom+xml:
schema:
$ref: '#/components/schemas/VideosForXML'
application/json:
schema:
type: object
'406':
description: accept header unsupported
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
/plugins:
get:
tags:
- Plugins
summary: List plugins
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: getPlugins
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
security:
- OAuth2:
- admin
parameters:
- name: pluginType
in: query
schema:
type: integer
- name: uninstalled
in: query
schema:
type: boolean
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PluginResponse'
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
/plugins/available:
get:
tags:
- Plugins
summary: List available plugins
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: getAvailablePlugins
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
security:
- OAuth2:
- admin
parameters:
- name: search
in: query
schema:
type: string
- name: pluginType
in: query
schema:
type: integer
- name: currentPeerTubeEngine
in: query
schema:
type: string
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort'
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PluginResponse'
'503':
description: plugin index unavailable
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
/plugins/install:
post:
tags:
- Plugins
summary: Install a plugin
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: addPlugin
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
security:
- OAuth2:
- admin
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
properties:
npmName:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: peertube-plugin-auth-ldap
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
required:
- npmName
additionalProperties: false
- type: object
properties:
path:
type: string
required:
- path
additionalProperties: false
responses:
'204':
description: successful operation
'400':
description: should have either `npmName` or `path` set
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
/plugins/update:
post:
tags:
- Plugins
summary: Update a plugin
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: updatePlugin
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
security:
- OAuth2:
- admin
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
properties:
npmName:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: peertube-plugin-auth-ldap
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
required:
- npmName
additionalProperties: false
- type: object
properties:
path:
type: string
required:
- path
additionalProperties: false
responses:
'204':
description: successful operation
'400':
description: should have either `npmName` or `path` set
'404':
description: existing plugin not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
/plugins/uninstall:
post:
tags:
- Plugins
summary: Uninstall a plugin
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: uninstallPlugin
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
security:
- OAuth2:
- admin
requestBody:
content:
application/json:
schema:
type: object
properties:
npmName:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
description: name of the plugin/theme in its package.json
example: peertube-plugin-auth-ldap
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
required:
- npmName
responses:
'204':
description: successful operation
'404':
description: existing plugin not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
/plugins/{npmName}:
get:
tags:
- Plugins
summary: Get a plugin
add operationId to common operations
2021-05-24 12:38:26 -05:00
operationId: getPlugin
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
security:
- OAuth2:
- admin
parameters:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- $ref: '#/components/parameters/npmName'
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Plugin'
'404':
description: plugin not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
/plugins/{npmName}/settings:
put:
tags:
- Plugins
summary: Set a plugin's settings
security:
- OAuth2:
- admin
parameters:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- $ref: '#/components/parameters/npmName'
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
requestBody:
content:
application/json:
schema:
type: object
properties:
settings:
type: object
additionalProperties: true
responses:
'204':
description: successful operation
'404':
description: plugin not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
/plugins/{npmName}/public-settings:
get:
tags:
- Plugins
summary: Get a plugin's public settings
parameters:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- $ref: '#/components/parameters/npmName'
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
additionalProperties: true
'404':
description: plugin not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
/plugins/{npmName}/registered-settings:
get:
tags:
- Plugins
summary: Get a plugin's registered settings
security:
- OAuth2:
- admin
parameters:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- $ref: '#/components/parameters/npmName'
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
additionalProperties: true
'404':
description: plugin not found
fix typo in operationId in openapi spec
2021-05-14 12:31:24 -05:00
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
servers:
fix API spec on POST /videos/upload and provide Shell example
2018-11-15 10:08:42 -06:00
- url: 'https://peertube2.cpy.re/api/v1'
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
description: Live Test Server (live data - latest nightly version)
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
- url: 'https://peertube3.cpy.re/api/v1'
Openapi consistency
2020-04-21 05:09:54 -05:00
description: Live Test Server (live data - latest RC version)
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- url: 'https://peertube.cpy.re/api/v1'
description: Live Test Server (live data - stable version)
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
components:
parameters:
start:
name: start
in: query
required: false
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: Offset used to paginate results
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
schema:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
minimum: 0
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
count:
name: count
in: query
required: false
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: "Number of items to return"
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
schema:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
default: 15
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
maximum: 100
minimum: 1
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
sort:
name: sort
in: query
required: false
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
description: Sort column
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
schema:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: -createdAt
add blocked filter in users list to filter banned users fixes #2914
2020-07-02 15:49:51 -05:00
search:
name: search
in: query
required: false
description: Plain text search, applied to various parts of the model depending on endpoint
schema:
type: string
Add rest api doc for index search
2020-06-10 08:18:15 -05:00
searchTarget:
name: searchTarget
in: query
required: false
description: >
If the administrator enabled search index support, you can override the default search target.
**Warning**: If you choose to make an index search, PeerTube will get results from a third party service.
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
It means the instance may not yet know the objects you fetched. If you want to load video/channel information:
Add rest api doc for index search
2020-06-10 08:18:15 -05:00
* If the current user has the ability to make a remote URI search (this information is available in the config endpoint),
then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.
After that, you can use the classic REST API endpoints to fetch the complete object or interact with it
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
* If the current user doesn't have the ability to make a remote URI search, then redirect the user on the origin instance or fetch
Add rest api doc for index search
2020-06-10 08:18:15 -05:00
the data from the origin instance API
schema:
type: string
enum:
- 'local'
- 'search-index'
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
videosSort:
name: sort
in: query
required: false
schema:
type: string
enum:
Improve videos sort documentation
2022-04-15 07:50:09 -05:00
- name
- -duration
- -createdAt
- -publishedAt
- -views
- -likes
- -trending
- -hot
- -best
description: >
Sort videos by criteria (prefixing with `-` means `DESC` order):
* `hot` - Adaptation of Reddit "hot" algorithm taking into account video views, likes, dislikes and comments and publication date
* `best` - Same than `hot`, but also takes into account user video history
* `trending` - Sort videos by recent views ("recent" is defined by the admin)
* `views` - Sort videos using their `views` counter
* `publishedAt` - Sort by video publication date (when it became publicly available)
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
videosSearchSort:
name: sort
in: query
required: false
Improve videos sort documentation
2022-04-15 07:50:09 -05:00
description: >
Sort videos by criteria (prefixing with `-` means `DESC` order):
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
schema:
type: string
enum:
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
- name
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
- -duration
- -createdAt
- -publishedAt
- -views
- -likes
- -match
Update OpenAPI documentation to include basic playlists and new comment sorting
2019-12-27 10:52:53 -06:00
commentsSort:
name: sort
in: query
required: false
description: Sort comments by criteria
schema:
type: string
enum:
- -createdAt
- -totalReplies
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
blacklistsSort:
name: sort
in: query
required: false
add video upload types, add doc middleware to more routes
2021-06-06 03:21:06 -05:00
description: Sort blocklists by criteria
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
schema:
type: string
enum:
- -id
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
- name
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
- -duration
- -views
- -likes
- -dislikes
- -uuid
- -createdAt
add blocked filter in users list to filter banned users fixes #2914
2020-07-02 15:49:51 -05:00
usersSearch:
name: search
in: query
required: false
description: Plain text search that will match with user usernames or emails
schema:
type: string
usersBlocked:
name: blocked
in: query
required: false
description: Filter results down to (un)banned users
schema:
type: boolean
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
usersSort:
name: sort
in: query
required: false
description: Sort users by criteria
schema:
type: string
enum:
- -id
- -username
- -createdAt
abusesSort:
name: sort
in: query
required: false
description: Sort abuses by criteria
schema:
type: string
enum:
- -id
- -createdAt
- -state
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
videoRedundanciesSort:
name: sort
in: query
required: false
description: Sort abuses by criteria
schema:
type: string
enum:
- name
Split check user params tests
2021-10-19 08:02:43 -05:00
followersSort:
name: sort
in: query
required: false
description: Sort followers by criteria
schema:
type: string
enum:
- createdAt
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
name:
name: name
in: path
required: true
emit more specific status codes on video upload (#3423) - reduce http status codes list to potentially useful codes - convert more codes to typed ones - factorize html generator for error responses
2020-12-08 14:16:10 -06:00
description: The username or handle of the account
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
schema:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: chocobozzz | chocobozzz@example.org
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
id:
name: id
in: path
required: true
Add ability to cancel & delete video imports
2022-01-19 07:23:00 -06:00
description: Entity id
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
schema:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
Fix openapi schema
2019-07-03 10:28:09 -05:00
idOrUUID:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
name: id
in: path
required: true
Support short uuid for GET video/playlist
2021-06-28 10:30:59 -05:00
description: The object id, uuid or short uuid
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
schema:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
oneOf:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
- $ref: '#/components/schemas/id'
factorize uuid type in openapi spec
2021-05-04 03:44:33 -05:00
- $ref: '#/components/schemas/UUIDv4'
Support short uuid for GET video/playlist
2021-06-28 10:30:59 -05:00
- $ref: '#/components/schemas/shortUUID'
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
playlistId:
name: playlistId
in: path
required: true
description: Playlist id
schema:
$ref: '#/components/schemas/VideoPlaylist/properties/id'
Add API doc for playlists
2020-04-21 08:04:39 -05:00
playlistElementId:
name: playlistElementId
in: path
required: true
description: Playlist element id
schema:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
Improve abuse api doc
2020-04-21 08:24:19 -05:00
abuseId:
name: abuseId
in: path
required: true
Add new abuses tests
2020-07-08 08:51:46 -05:00
description: Abuse id
Improve abuse api doc
2020-04-21 08:24:19 -05:00
schema:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/Abuse/properties/id'
Add openapi doc
2020-07-28 04:12:16 -05:00
abuseMessageId:
name: abuseMessageId
in: path
required: true
description: Abuse message id
schema:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/AbuseMessage/properties/id'
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
captionLanguage:
name: captionLanguage
in: path
required: true
description: The caption language
schema:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/VideoLanguageSet'
Fix video channel API route param in doc
2019-04-24 09:57:23 -05:00
channelHandle:
name: channelHandle
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
in: path
required: true
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
description: The video channel handle
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
schema:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: my_username | my_username@example.com
Fix openapi schema
2019-07-03 10:28:09 -05:00
subscriptionHandle:
name: subscriptionHandle
in: path
required: true
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
description: The subscription handle
Fix openapi schema
2019-07-03 10:28:09 -05:00
schema:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: my_username | my_username@example.com
Fix openapi schema
2019-07-03 10:28:09 -05:00
threadId:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
name: threadId
in: path
required: true
Fix openapi schema
2019-07-03 10:28:09 -05:00
description: The thread id (root comment id)
schema:
Fix broken openapi schema
2021-05-27 04:52:03 -05:00
type: integer
Fix openapi schema
2019-07-03 10:28:09 -05:00
commentId:
name: commentId
in: path
required: true
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
description: The comment id
schema:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/VideoComment/properties/id'
Add ability to filter my videos by live
2021-05-03 04:06:19 -05:00
isLive:
name: isLive
in: query
required: false
description: whether or not the video is a live
schema:
type: boolean
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
categoryOneOf:
name: categoryOneOf
in: query
required: false
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
description: category id of the video (see [/videos/categories](#operation/getCategories))
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
schema:
oneOf:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
- $ref: '#/components/schemas/VideoCategorySet'
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
- type: array
items:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/VideoCategorySet'
change type of languageOneOf query parameter
2018-12-04 06:50:50 -06:00
style: form
explode: false
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
tagsOneOf:
name: tagsOneOf
in: query
required: false
description: tag(s) of the video
schema:
oneOf:
- type: string
- type: array
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
maxItems: 5
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
items:
type: string
change type of languageOneOf query parameter
2018-12-04 06:50:50 -06:00
style: form
explode: false
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
tagsAllOf:
name: tagsAllOf
in: query
required: false
description: tag(s) of the video, where all should be present in the video
schema:
oneOf:
- type: string
- type: array
items:
type: string
change type of languageOneOf query parameter
2018-12-04 06:50:50 -06:00
style: form
explode: false
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
languageOneOf:
name: languageOneOf
in: query
required: false
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
description: language id of the video (see [/videos/languages](#operation/getLanguages)). Use `_unknown` to filter on videos that don't have a video language
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
schema:
oneOf:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
- $ref: '#/components/schemas/VideoLanguageSet'
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
- type: array
items:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/VideoLanguageSet'
change type of languageOneOf query parameter
2018-12-04 06:50:50 -06:00
style: form
explode: false
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
licenceOneOf:
name: licenceOneOf
in: query
required: false
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
description: licence id of the video (see [/videos/licences](#operation/getLicences))
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
schema:
oneOf:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
- $ref: '#/components/schemas/VideoLicenceSet'
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
- type: array
items:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/VideoLicenceSet'
change type of languageOneOf query parameter
2018-12-04 06:50:50 -06:00
style: form
explode: false
Add videos list filters param in api doc
2020-04-21 09:03:51 -05:00
skipCount:
name: skipCount
in: query
required: false
description: if you don't need the `total` in the response
schema:
type: string
enum:
- 'true'
- 'false'
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
default: 'false'
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
nsfw:
name: nsfw
in: query
required: false
description: whether to include nsfw videos, if any
schema:
type: string
enum:
- 'true'
- 'false'
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
isLocal:
name: isLocal
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
in: query
required: false
schema:
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
type: boolean
Some fixes for admin videos list
2021-11-02 05:00:40 -05:00
description: '**PeerTube >= 4.0** Display only local or remote videos'
Add ability to filter by file type
2021-11-03 05:32:41 -05:00
hasHLSFiles:
name: hasHLSFiles
in: query
required: false
schema:
type: boolean
description: '**PeerTube >= 4.0** Display only videos that have HLS files'
hasWebtorrentFiles:
name: hasWebtorrentFiles
in: query
required: false
schema:
type: boolean
description: '**PeerTube >= 4.0** Display only videos that have WebTorrent files'
Add ability to filter out public videos from admin
2021-11-12 07:19:56 -06:00
privacyOneOf:
name: privacyOneOf
in: query
required: false
schema:
$ref: '#/components/schemas/VideoPrivacySet'
description: '**PeerTube >= 4.0** Display only videos in this specific privacy/privacies'
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
include:
name: include
in: query
required: false
schema:
type: integer
add parameters to GET /videos route spec
2018-11-24 11:18:56 -06:00
enum:
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
- 0
- 1
- 2
- 4
- 8
description: >
Some fixes for admin videos list
2021-11-02 05:00:40 -05:00
**PeerTube >= 4.0** Include additional videos in results (can be combined using bitwise or operator)
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
- `0` NONE
- `1` NOT_PUBLISHED_STATE
Add ability to filter out public videos from admin
2021-11-12 07:19:56 -06:00
- `2` BLACKLISTED
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
Add ability to filter out public videos from admin
2021-11-12 07:19:56 -06:00
- `4` BLOCKED_OWNER
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
Add ability to filter out public videos from admin
2021-11-12 07:19:56 -06:00
- `8` FILES
(doc) update API spec to include user subscription routes
2019-01-03 10:34:24 -06:00
subscriptionsUris:
name: uris
in: query
required: true
description: list of uris to check if each is part of the user subscriptions
schema:
type: array
items:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: uri
npmName:
name: npmName
in: path
required: true
description: name of the plugin/theme on npmjs.com or in its package.json
schema:
type: string
example: peertube-plugin-auth-ldap
add display of logs matching any state
2020-12-13 12:27:25 -06:00
jobType:
name: jobType
in: query
required: false
description: job type
schema:
type: string
enum:
- activitypub-follow
- activitypub-http-broadcast
- activitypub-http-fetcher
- activitypub-http-unicast
- email
- video-transcoding
- video-file-import
- video-import
Refactor video views Introduce viewers attribute for live videos Count views for live videos Reduce delay to see the viewer update for lives Add ability to configure video views buffer interval and view ip expiration
2021-11-09 03:11:20 -06:00
- videos-views-stats
add display of logs matching any state
2020-12-13 12:27:25 -06:00
- activitypub-refresher
- video-redundancy
- video-live-ending
add accept/reject routes for server followers in openapi spec
2021-05-13 07:50:26 -05:00
followState:
name: state
in: query
schema:
type: string
enum:
- pending
- accepted
actorType:
name: actorType
in: query
schema:
type: string
enum:
- Person
- Application
- Group
- Service
- Organization
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
securitySchemes:
OAuth2:
add rate limit table to openapi spec
2021-05-06 18:40:21 -05:00
description: |
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
Authenticating via OAuth requires the following steps:
add rate limit table to openapi spec
2021-05-06 18:40:21 -05:00
- Have an activated account
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
- [Generate] an access token for that account at `/api/v1/users/token`.
- Make requests with the *Authorization: Bearer <token\>* header
add rate limit table to openapi spec
2021-05-06 18:40:21 -05:00
- Profit, depending on the role assigned to the account
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
Note that the __access token is valid for 1 day__ and is given
add rate limit table to openapi spec
2021-05-06 18:40:21 -05:00
along with a __refresh token valid for 2 weeks__.
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
[Generate]: https://docs.joinpeertube.org/api-rest-getting-started
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
type: oauth2
flows:
password:
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
tokenUrl: /api/v1/users/token
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
scopes:
admin: Admin scope
moderator: Moderator scope
user: User scope
schemas:
Fix various typos Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
# Reusable core properties
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
id:
type: integer
minimum: 1
example: 42
factorize uuid type in openapi spec
2021-05-04 03:44:33 -05:00
UUIDv4:
type: string
format: uuid
example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
minLength: 36
maxLength: 36
Support short uuid for GET video/playlist
2021-06-28 10:30:59 -05:00
shortUUID:
type: string
description: translation of a uuid v4 with a bigger alphabet to have a shorter uuid
example: 2y84q2MQUMWPbiEcxNXMgC
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
username:
type: string
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
description: immutable name of the user, used to find or mention its actor
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: chocobozzz
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
pattern: '/^[a-z0-9._]+$/'
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
minLength: 1
maxLength: 50
usernameChannel:
type: string
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
description: immutable name of the channel, used to interact with its actor
add response content for createVideoChannel endpoint in openapi spec closes #4077
2021-05-12 06:44:32 -05:00
example: framasoft_videos
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
pattern: '/^[a-zA-Z0-9\\-_.:]+$/'
minLength: 1
maxLength: 50
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
password:
type: string
format: password
minLength: 6
maxLength: 255
factorize uuid type in openapi spec
2021-05-04 03:44:33 -05:00
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
VideoCategorySet:
type: integer
description: category id of the video (see [/videos/categories](#operation/getCategories))
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: 15
add description with operation link to category/licence/language constants
2021-05-03 07:34:46 -05:00
VideoConstantNumber-Category:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
properties:
id:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
$ref: '#/components/schemas/VideoCategorySet'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
label:
type: string
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: Science & Technology
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
VideoLicenceSet:
type: integer
description: licence id of the video (see [/videos/licences](#operation/getLicences))
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: 2
add description with operation link to category/licence/language constants
2021-05-03 07:34:46 -05:00
VideoConstantNumber-Licence:
properties:
id:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
$ref: '#/components/schemas/VideoLicenceSet'
add description with operation link to category/licence/language constants
2021-05-03 07:34:46 -05:00
label:
type: string
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: Attribution - Share Alike
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
VideoLanguageSet:
type: string
description: language id of the video (see [/videos/languages](#operation/getLanguages))
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: en
add description with operation link to category/licence/language constants
2021-05-03 07:34:46 -05:00
VideoConstantString-Language:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
properties:
id:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
$ref: '#/components/schemas/VideoLanguageSet'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
label:
type: string
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: English
Add API doc for playlists
2020-04-21 08:04:39 -05:00
VideoPlaylistPrivacySet:
type: integer
enum:
- 1
- 2
- 3
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
description: Video playlist privacy policy (see [/video-playlists/privacies])
Add API doc for playlists
2020-04-21 08:04:39 -05:00
VideoPlaylistPrivacyConstant:
properties:
id:
$ref: '#/components/schemas/VideoPlaylistPrivacySet'
label:
type: string
VideoPlaylistTypeSet:
type: integer
enum:
- 1
- 2
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
description: The video playlist type (Regular = `1`, Watch Later = `2`)
Add API doc for playlists
2020-04-21 08:04:39 -05:00
VideoPlaylistTypeConstant:
properties:
id:
$ref: '#/components/schemas/VideoPlaylistTypeSet'
label:
type: string
Fix video privacy in rest api documentation
2019-05-24 03:09:27 -05:00
VideoPrivacySet:
type: integer
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
enum:
Fix video privacy in rest api documentation
2019-05-24 03:09:27 -05:00
- 1
- 2
- 3
Add API doc for playlists
2020-04-21 08:04:39 -05:00
- 4
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
description: privacy id of the video (see [/videos/privacies](#operation/getPrivacyPolicies))
Fix video privacy in rest api documentation
2019-05-24 03:09:27 -05:00
VideoPrivacyConstant:
properties:
id:
Add API doc for playlists
2020-04-21 08:04:39 -05:00
$ref: '#/components/schemas/VideoPrivacySet'
Fix video privacy in rest api documentation
2019-05-24 03:09:27 -05:00
label:
type: string
Improve abuse api doc
2020-04-21 08:24:19 -05:00
Add account block status in openapi
2021-12-07 04:30:53 -06:00
BlockStatus:
properties:
accounts:
type: object
additionalProperties:
x-additionalPropertiesName: account
type: object
properties:
blockedByServer:
type: boolean
blockedByUser:
type: boolean
hosts:
type: object
additionalProperties:
x-additionalPropertiesName: host
type: object
properties:
blockedByServer:
type: boolean
blockedByUser:
type: boolean
Add playlist exist api doc
2020-04-21 09:41:31 -05:00
NSFWPolicy:
type: string
enum:
- display
- blur
- do_not_list
UserRole:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
Add playlist exist api doc
2020-04-21 09:41:31 -05:00
enum:
- 0
- 1
- 2
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: 'The user role (Admin = `0`, Moderator = `1`, User = `2`)'
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
example: 2
Add ability to update plugin auth
2021-02-01 08:39:13 -06:00
UserAdminFlags:
type: integer
enum:
- 0
- 1
add video upload types, add doc middleware to more routes
2021-06-06 03:21:06 -05:00
description: 'Admin flags for the user (None = `0`, Bypass video blocklist = `1`)'
Add ability to update plugin auth
2021-02-01 08:39:13 -06:00
example: 1
Add playlist exist api doc
2020-04-21 09:41:31 -05:00
Add latency setting support
2022-03-04 06:40:02 -06:00
LiveVideoLatencyMode:
type: integer
enum:
- 1
- 2
- 3
Fix various typos Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
description: 'The live latency mode (Default = `1`, High latency = `2`, Small Latency = `3`)'
Add latency setting support
2022-03-04 06:40:02 -06:00
Improve video REST documentation
2019-06-11 03:01:13 -05:00
VideoStateConstant:
properties:
id:
type: integer
enum:
- 1
- 2
- 3
Add missing video states to rest api doc
2022-04-19 01:57:24 -05:00
- 4
- 5
- 6
- 7
- 8
- 9
description: |
The video state:
- `1`: Published
- `2`: To transcode
- `3`: To import
- `4`: Waiting for live stream
- `5`: Live ended
- `6`: To move to an external storage (object storage...)
- `7`: Transcoding failed
- `8`: Moving to an external storage failed
- `9`: To edit using studio edition feature
Improve video REST documentation
2019-06-11 03:01:13 -05:00
label:
type: string
Improve abuse api doc
2020-04-21 08:24:19 -05:00
Add migrations
2020-07-07 07:34:16 -05:00
AbuseStateSet:
Improve abuse api doc
2020-04-21 08:24:19 -05:00
type: integer
enum:
- 1
- 2
- 3
Add openapi doc
2020-07-28 04:12:16 -05:00
description: 'The abuse state (Pending = `1`, Rejected = `2`, Accepted = `3`)'
Add migrations
2020-07-07 07:34:16 -05:00
AbuseStateConstant:
Improve abuse api doc
2020-04-21 08:24:19 -05:00
properties:
id:
Add migrations
2020-07-07 07:34:16 -05:00
$ref: '#/components/schemas/AbuseStateSet'
Improve abuse api doc
2020-04-21 08:24:19 -05:00
label:
type: string
Add migrations
2020-07-07 07:34:16 -05:00
AbusePredefinedReasons:
predefined report reasons & improved reporter UI (#2842) - added `startAt` and `endAt` optional timestamps to help pin down reported sections of a video - added predefined report reasons - added video player with report modal
2020-06-22 06:00:39 -05:00
type: array
items:
type: string
enum:
- violentOrAbusive
- hatefulOrAbusive
- spamOrMisleading
- privacy
- rights
- serverRules
- thumbnails
- captions
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: [spamOrMisleading]
Improve abuse api doc
2020-04-21 08:24:19 -05:00
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
VideoResolutionSet:
type: integer
description: |
Video resolution (`0`, `240`, `360`, `720`, `1080`, `1440` or `2160`)
`0` is used as a special value for stillimage videos dedicated to audio, a.k.a. audio-only videos.
example: 240
Improve video REST documentation
2019-06-11 03:01:13 -05:00
VideoResolutionConstant:
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
description: resolutions and their labels for the video
Improve video REST documentation
2019-06-11 03:01:13 -05:00
properties:
id:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
$ref: '#/components/schemas/VideoResolutionSet'
Improve video REST documentation
2019-06-11 03:01:13 -05:00
label:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: 240p
Improve video REST documentation
2019-06-11 03:01:13 -05:00
VideoScheduledUpdate:
properties:
privacy:
$ref: '#/components/schemas/VideoPrivacySet'
updateAt:
type: string
format: date
description: When to update the video
required:
- updateAt
Add API doc for playlists
2020-04-21 08:04:39 -05:00
AccountSummary:
Improve video REST documentation
2019-06-11 03:01:13 -05:00
properties:
id:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
Improve video REST documentation
2019-06-11 03:01:13 -05:00
name:
type: string
displayName:
type: string
url:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
Improve video REST documentation
2019-06-11 03:01:13 -05:00
host:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: hostname
Implement avatar miniatures (#4639) * client: remove unused file * refactor(client/my-actor-avatar): size from input Read size from component input instead of scss, to make it possible to use smaller avatar images when implemented. * implement avatar miniatures close #4560 * fix(test): max file size * fix(search-index): normalize res acc to avatarMini * refactor avatars to an array * client/search: resize channel avatar to 120 * refactor(client/videos): remove unused function * client(actor-avatar): set default size * fix tests and avatars full result When findOne is used only an array containting one avatar is returned. * update migration version and version notations * server/search: harmonize normalizing * Cleanup avatar miniature PR Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-02-28 01:34:43 -06:00
avatars:
type: array
items:
$ref: '#/components/schemas/ActorImage'
Improve video REST documentation
2019-06-11 03:01:13 -05:00
VideoChannelSummary:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
Improve video REST documentation
2019-06-11 03:01:13 -05:00
name:
type: string
displayName:
type: string
url:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
Improve video REST documentation
2019-06-11 03:01:13 -05:00
host:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: hostname
Implement avatar miniatures (#4639) * client: remove unused file * refactor(client/my-actor-avatar): size from input Read size from component input instead of scss, to make it possible to use smaller avatar images when implemented. * implement avatar miniatures close #4560 * fix(test): max file size * fix(search-index): normalize res acc to avatarMini * refactor avatars to an array * client/search: resize channel avatar to 120 * refactor(client/videos): remove unused function * client(actor-avatar): set default size * fix tests and avatars full result When findOne is used only an array containting one avatar is returned. * update migration version and version notations * server/search: harmonize normalizing * Cleanup avatar miniature PR Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-02-28 01:34:43 -06:00
avatars:
type: array
items:
$ref: '#/components/schemas/ActorImage'
Improve video REST documentation
2019-06-11 03:01:13 -05:00
PlaylistElement:
properties:
position:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
Improve video REST documentation
2019-06-11 03:01:13 -05:00
startTimestamp:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
format: seconds
Improve video REST documentation
2019-06-11 03:01:13 -05:00
stopTimestamp:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
format: seconds
Fix broken playlist api
2019-07-31 08:57:32 -05:00
video:
nullable: true
Add API doc for playlists
2020-04-21 08:04:39 -05:00
allOf:
- $ref: '#/components/schemas/Video'
Improve video REST documentation
2019-06-11 03:01:13 -05:00
VideoFile:
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
readOnly: true
Improve video REST documentation
2019-06-11 03:01:13 -05:00
properties:
magnetUri:
type: string
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
format: uri
description: magnet URI allowing to resolve the video via BitTorrent without a metainfo file
pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
Improve video REST documentation
2019-06-11 03:01:13 -05:00
resolution:
$ref: '#/components/schemas/VideoResolutionConstant'
size:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
description: Video file size in bytes
Improve video REST documentation
2019-06-11 03:01:13 -05:00
torrentUrl:
type: string
Update VideoFile structure in the API doc Explain the difference between the 4 URL fields in the VideoFile structure.
2021-04-13 15:45:54 -05:00
description: Direct URL of the torrent file
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
Improved description of all file uploads (#2053) * Add format:binary for file uploads * Fix wrongly named field for encoding * Fix typo in field name * Add contentType for torrentfile and captionfile * Add contentType for videofile
2019-08-21 01:32:15 -05:00
torrentDownloadUrl:
Improve video REST documentation
2019-06-11 03:01:13 -05:00
type: string
Update VideoFile structure in the API doc Explain the difference between the 4 URL fields in the VideoFile structure.
2021-04-13 15:45:54 -05:00
description: URL endpoint that transfers the torrent file as an attachment (so that the browser opens a download dialog)
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
Improve video REST documentation
2019-06-11 03:01:13 -05:00
fileUrl:
type: string
Update VideoFile structure in the API doc Explain the difference between the 4 URL fields in the VideoFile structure.
2021-04-13 15:45:54 -05:00
description: Direct URL of the video
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
Improve video REST documentation
2019-06-11 03:01:13 -05:00
fileDownloadUrl:
type: string
Update VideoFile structure in the API doc Explain the difference between the 4 URL fields in the VideoFile structure.
2021-04-13 15:45:54 -05:00
description: URL endpoint that transfers the video file as an attachment (so that the browser opens a download dialog)
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
Improve video REST documentation
2019-06-11 03:01:13 -05:00
fps:
type: number
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
description: Frames per second of the video file
Add files section to streaming playlists openapi doc
2020-05-13 04:57:38 -05:00
metadataUrl:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
description: URL dereferencing the output of ffprobe on the file
Improve video REST documentation
2019-06-11 03:01:13 -05:00
VideoStreamingPlaylists:
make streaming playlists pivotable objects in openapi spec
2021-05-04 03:25:05 -05:00
allOf:
- type: object
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
make streaming playlists pivotable objects in openapi spec
2021-05-04 03:25:05 -05:00
type:
type: integer
enum:
- 1
description: |
Playlist type:
- `1`: HLS
- $ref: '#/components/schemas/VideoStreamingPlaylists-HLS'
VideoStreamingPlaylists-HLS:
Improve video REST documentation
2019-06-11 03:01:13 -05:00
properties:
playlistUrl:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
Improve video REST documentation
2019-06-11 03:01:13 -05:00
segmentsSha256Url:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
Add files section to streaming playlists openapi doc
2020-05-13 04:57:38 -05:00
files:
type: array
make hls/webtorrent fields closely documented in the openapi spec
2021-05-04 02:13:21 -05:00
description: |
Video files associated to this playlist.
The difference with the root `files` property is that these files are fragmented, so they can be used in this streaming playlist (HLS, etc.)
Add files section to streaming playlists openapi doc
2020-05-13 04:57:38 -05:00
items:
$ref: '#/components/schemas/VideoFile'
Improve video REST documentation
2019-06-11 03:01:13 -05:00
redundancies:
type: array
items:
type: object
properties:
baseUrl:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
VideoInfo:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/Video/properties/id'
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
uuid:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/Video/properties/uuid'
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
name:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/Video/properties/name'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
Video:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: object id for the video
allOf:
- $ref: '#/components/schemas/id'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
uuid:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: universal identifier for the video, that can be used across instances
allOf:
- $ref: '#/components/schemas/UUIDv4'
Support short uuid for GET video/playlist
2021-06-28 10:30:59 -05:00
shortUUID:
allOf:
- $ref: '#/components/schemas/shortUUID'
Add open api doc for live
2020-11-09 04:21:08 -06:00
isLive:
type: boolean
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
createdAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
add examples and descriptions to some video fields in openapi spec
2021-05-04 04:18:46 -05:00
example: 2017-10-01T10:52:46.396Z
description: time at which the video object was first drafted
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
publishedAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
add examples and descriptions to some video fields in openapi spec
2021-05-04 04:18:46 -05:00
example: 2018-10-01T10:52:46.396Z
description: time at which the video was marked as ready for playback (with restrictions depending on `privacy`). Usually set after a `state` evolution.
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
updatedAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
add examples and descriptions to some video fields in openapi spec
2021-05-04 04:18:46 -05:00
example: 2021-05-04T08:01:01.502Z
description: last time the video's metadata was modified
Improve video REST documentation
2019-06-11 03:01:13 -05:00
originallyPublishedAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
add examples and descriptions to some video fields in openapi spec
2021-05-04 04:18:46 -05:00
example: 2010-10-01T10:52:46.396Z
description: used to represent a date of first publication, prior to the practical publication date of `publishedAt`
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
category:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
allOf:
- $ref: '#/components/schemas/VideoConstantNumber-Category'
description: category in which the video is classified
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
licence:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
allOf:
- $ref: '#/components/schemas/VideoConstantNumber-Licence'
description: licence under which the video is distributed
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
language:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
allOf:
- $ref: '#/components/schemas/VideoConstantString-Language'
description: main language used in the video
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
privacy:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
allOf:
- $ref: '#/components/schemas/VideoPrivacyConstant'
description: privacy policy used to distribute the video
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
description:
type: string
add examples and descriptions to some video fields in openapi spec
2021-05-04 04:18:46 -05:00
example: |
**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n
**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\r\n*A decentralized video hosting network, based on fr...
minLength: 3
maxLength: 250
description: |
truncated description of the video, written in Markdown.
Resolve `descriptionPath` to get the full description of maximum `10000` characters.
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
duration:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: 1419
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
format: seconds
add examples and descriptions to some video fields in openapi spec
2021-05-04 04:18:46 -05:00
description: duration of the video in seconds
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
isLocal:
type: boolean
name:
type: string
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: title of the video
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: What is PeerTube?
fix name limit for video in openapi spec
2021-05-03 05:17:30 -05:00
minLength: 3
maxLength: 120
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
thumbnailPath:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: /static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
previewPath:
type: string
Deprecate old static routes
2020-08-26 08:03:00 -05:00
example: /lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
embedPath:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: /videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
views:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: 1337
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
likes:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: 42
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
dislikes:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: 7
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
nsfw:
type: boolean
Improve video REST documentation
2019-06-11 03:01:13 -05:00
waitTranscoding:
type: boolean
nullable: true
state:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
allOf:
- $ref: '#/components/schemas/VideoStateConstant'
description: represents the internal state of the video processing within the PeerTube instance
Improve video REST documentation
2019-06-11 03:01:13 -05:00
scheduledUpdate:
nullable: true
Add API doc for playlists
2020-04-21 08:04:39 -05:00
allOf:
- $ref: '#/components/schemas/VideoScheduledUpdate'
Improve video REST documentation
2019-06-11 03:01:13 -05:00
blacklisted:
nullable: true
type: boolean
blacklistedReason:
nullable: true
type: string
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
account:
Add API doc for playlists
2020-04-21 08:04:39 -05:00
$ref: '#/components/schemas/AccountSummary'
Improve video REST documentation
2019-06-11 03:01:13 -05:00
channel:
$ref: '#/components/schemas/VideoChannelSummary'
userHistory:
nullable: true
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
type: object
properties:
Improve video REST documentation
2019-06-11 03:01:13 -05:00
currentTime:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
Improve video REST documentation
2019-06-11 03:01:13 -05:00
VideoDetails:
allOf:
- $ref: '#/components/schemas/Video'
- type: object
properties:
Refactor video views Introduce viewers attribute for live videos Count views for live videos Reduce delay to see the viewer update for lives Add ability to configure video views buffer interval and view ip expiration
2021-11-09 03:11:20 -06:00
viewers:
type: integer
description: If the video is a live, you have the amount of current viewers
Improve video REST documentation
2019-06-11 03:01:13 -05:00
descriptionPath:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
type: string
add examples and descriptions to some video fields in openapi spec
2021-05-04 04:18:46 -05:00
example: /api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180a6d/description
description: path at which to get the full description of maximum `10000` characters
Improve video REST documentation
2019-06-11 03:01:13 -05:00
support:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
type: string
allow limiting video-comments rss feeds to an account or video channel
2020-06-27 06:12:30 -05:00
description: A text tell the audience how to support the video creator
add response content for createVideoChannel endpoint in openapi spec closes #4077
2021-05-12 06:44:32 -05:00
example: Please support our work on https://soutenir.framasoft.org/en/ <3
make hls/webtorrent fields closely documented in the openapi spec
2021-05-04 02:13:21 -05:00
minLength: 3
maxLength: 1000
Improve video REST documentation
2019-06-11 03:01:13 -05:00
channel:
$ref: '#/components/schemas/VideoChannel'
account:
$ref: '#/components/schemas/Account'
tags:
fix name limit for video in openapi spec
2021-05-03 05:17:30 -05:00
example: [flowers, gardening]
Improve video REST documentation
2019-06-11 03:01:13 -05:00
type: array
fix name limit for video in openapi spec
2021-05-03 05:17:30 -05:00
minItems: 1
maxItems: 5
Improve video REST documentation
2019-06-11 03:01:13 -05:00
items:
type: string
fix name limit for video in openapi spec
2021-05-03 05:17:30 -05:00
minLength: 2
maxLength: 30
Improve video REST documentation
2019-06-11 03:01:13 -05:00
commentsEnabled:
type: boolean
downloadEnabled:
type: boolean
trackerUrls:
type: array
items:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
example:
- https://peertube2.cpy.re/tracker/announce
- wss://peertube2.cpy.re/tracker/socket
make hls/webtorrent fields closely documented in the openapi spec
2021-05-04 02:13:21 -05:00
files:
type: array
items:
$ref: '#/components/schemas/VideoFile'
description: |
WebTorrent/raw video files. If WebTorrent is disabled on the server:
- field will be empty
- video files will be found in `streamingPlaylists[].files` field
Improve video REST documentation
2019-06-11 03:01:13 -05:00
streamingPlaylists:
type: array
items:
$ref: '#/components/schemas/VideoStreamingPlaylists'
make hls/webtorrent fields closely documented in the openapi spec
2021-05-04 02:13:21 -05:00
description: |
HLS playlists/manifest files. If HLS is disabled on the server:
- field will be empty
- video files will be found in `files` field
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
FileRedundancyInformation:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
fileUrl:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
strategy:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
enum:
- manual
- most-views
- trending
- recently-added
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
size:
type: integer
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
expiresOn:
type: string
format: date-time
VideoRedundancy:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
name:
type: string
url:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
uuid:
factorize uuid type in openapi spec
2021-05-04 03:44:33 -05:00
$ref: '#/components/schemas/UUIDv4'
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
redundancies:
type: object
properties:
files:
type: array
items:
Fix users tests
2020-07-02 07:23:50 -05:00
$ref: '#/components/schemas/FileRedundancyInformation'
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
streamingPlaylists:
type: array
items:
Fix users tests
2020-07-02 07:23:50 -05:00
$ref: '#/components/schemas/FileRedundancyInformation'
Add video import in open api
2019-07-29 07:33:16 -05:00
VideoImportStateConstant:
properties:
id:
type: integer
enum:
- 1
- 2
- 3
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: 'The video import state (Pending = `1`, Success = `2`, Failed = `3`)'
Add video import in open api
2019-07-29 07:33:16 -05:00
label:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: Pending
factorized upload and import post fields in openapi spec closes #4075
2021-05-11 03:07:15 -05:00
VideoCreateImport:
allOf:
- type: object
additionalProperties: false
oneOf:
- properties:
targetUrl:
$ref: '#/components/schemas/VideoImport/properties/targetUrl'
required: [targetUrl]
- properties:
magnetUri:
$ref: '#/components/schemas/VideoImport/properties/magnetUri'
required: [magnetUri]
- properties:
torrentfile:
$ref: '#/components/schemas/VideoImport/properties/torrentfile'
required: [torrentfile]
- $ref: '#/components/schemas/VideoUploadRequestCommon'
required:
- channelId
- name
Add video import in open api
2019-07-29 07:33:16 -05:00
VideoImport:
properties:
id:
factorized upload and import post fields in openapi spec closes #4075
2021-05-11 03:07:15 -05:00
readOnly: true
allOf:
- $ref: '#/components/schemas/id'
Add video import in open api
2019-07-29 07:33:16 -05:00
targetUrl:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
description: remote URL where to find the import's source video
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d
Add video import in open api
2019-07-29 07:33:16 -05:00
magnetUri:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: uri
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
description: magnet URI allowing to resolve the import's source video
pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
factorized upload and import post fields in openapi spec closes #4075
2021-05-11 03:07:15 -05:00
torrentfile:
writeOnly: true
type: string
format: binary
description: Torrent file containing only the video file
Add video import in open api
2019-07-29 07:33:16 -05:00
torrentName:
factorized upload and import post fields in openapi spec closes #4075
2021-05-11 03:07:15 -05:00
readOnly: true
Add video import in open api
2019-07-29 07:33:16 -05:00
type: string
state:
factorized upload and import post fields in openapi spec closes #4075
2021-05-11 03:07:15 -05:00
readOnly: true
allOf:
- $ref: '#/components/schemas/VideoImportStateConstant'
Add video import in open api
2019-07-29 07:33:16 -05:00
error:
factorized upload and import post fields in openapi spec closes #4075
2021-05-11 03:07:15 -05:00
readOnly: true
Add video import in open api
2019-07-29 07:33:16 -05:00
type: string
createdAt:
factorized upload and import post fields in openapi spec closes #4075
2021-05-11 03:07:15 -05:00
readOnly: true
Add video import in open api
2019-07-29 07:33:16 -05:00
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
Add video import in open api
2019-07-29 07:33:16 -05:00
updatedAt:
factorized upload and import post fields in openapi spec closes #4075
2021-05-11 03:07:15 -05:00
readOnly: true
Add video import in open api
2019-07-29 07:33:16 -05:00
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
Add video import in open api
2019-07-29 07:33:16 -05:00
video:
factorized upload and import post fields in openapi spec closes #4075
2021-05-11 03:07:15 -05:00
readOnly: true
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
nullable: true
allOf:
- $ref: '#/components/schemas/Video'
fix imports list response in openapi spec closes #4063
2021-05-10 04:02:54 -05:00
VideoImportsList:
properties:
total:
type: integer
example: 1
data:
type: array
maxItems: 100
items:
$ref: '#/components/schemas/VideoImport'
Add openapi doc
2020-07-28 04:12:16 -05:00
Abuse:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
reason:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: The video is a spam
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
minLength: 2
maxLength: 3000
predefined report reasons & improved reporter UI (#2842) - added `startAt` and `endAt` optional timestamps to help pin down reported sections of a video - added predefined report reasons - added video player with report modal
2020-06-22 06:00:39 -05:00
predefinedReasons:
Add migrations
2020-07-07 07:34:16 -05:00
$ref: '#/components/schemas/AbusePredefinedReasons'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
reporterAccount:
$ref: '#/components/schemas/Account'
Improve abuse api doc
2020-04-21 08:24:19 -05:00
state:
Add migrations
2020-07-07 07:34:16 -05:00
$ref: '#/components/schemas/AbuseStateConstant'
Improve abuse api doc
2020-04-21 08:24:19 -05:00
moderationComment:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: Decided to ban the server since it spams us regularly
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
minLength: 2
maxLength: 3000
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
video:
fix name limit for video in openapi spec
2021-05-03 05:17:30 -05:00
$ref: '#/components/schemas/VideoInfo'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
createdAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
Add openapi doc
2020-07-28 04:12:16 -05:00
AbuseMessage:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
Add openapi doc
2020-07-28 04:12:16 -05:00
message:
type: string
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
minLength: 2
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
maxLength: 3000
Add openapi doc
2020-07-28 04:12:16 -05:00
byModerator:
type: boolean
createdAt:
type: string
format: date-time
account:
$ref: '#/components/schemas/AccountSummary'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
VideoBlacklist:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
videoId:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/Video/properties/id'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
createdAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
updatedAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
name:
type: string
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
minLength: 3
maxLength: 120
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
uuid:
factorize uuid type in openapi spec
2021-05-04 03:44:33 -05:00
$ref: '#/components/schemas/UUIDv4'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
description:
type: string
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
minLength: 3
maxLength: 10000
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
duration:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
views:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
likes:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
dislikes:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
nsfw:
type: boolean
Update OpenAPI documentation to include basic playlists and new comment sorting
2019-12-27 10:52:53 -06:00
VideoPlaylist:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
uuid:
$ref: '#/components/schemas/UUIDv4'
Support short uuid for GET video/playlist
2021-06-28 10:30:59 -05:00
shortUUID:
allOf:
- $ref: '#/components/schemas/shortUUID'
Update OpenAPI documentation to include basic playlists and new comment sorting
2019-12-27 10:52:53 -06:00
createdAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
Update OpenAPI documentation to include basic playlists and new comment sorting
2019-12-27 10:52:53 -06:00
updatedAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
Update OpenAPI documentation to include basic playlists and new comment sorting
2019-12-27 10:52:53 -06:00
description:
type: string
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
minLength: 3
maxLength: 1000
Update OpenAPI documentation to include basic playlists and new comment sorting
2019-12-27 10:52:53 -06:00
displayName:
type: string
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
minLength: 1
maxLength: 120
Update OpenAPI documentation to include basic playlists and new comment sorting
2019-12-27 10:52:53 -06:00
isLocal:
type: boolean
videoLength:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
minimum: 0
Update OpenAPI documentation to include basic playlists and new comment sorting
2019-12-27 10:52:53 -06:00
thumbnailPath:
type: string
privacy:
Add API doc for playlists
2020-04-21 08:04:39 -05:00
$ref: '#/components/schemas/VideoPlaylistPrivacyConstant'
Update OpenAPI documentation to include basic playlists and new comment sorting
2019-12-27 10:52:53 -06:00
type:
Add API doc for playlists
2020-04-21 08:04:39 -05:00
$ref: '#/components/schemas/VideoPlaylistTypeConstant'
Update OpenAPI documentation to include basic playlists and new comment sorting
2019-12-27 10:52:53 -06:00
ownerAccount:
Add API doc for playlists
2020-04-21 08:04:39 -05:00
$ref: '#/components/schemas/AccountSummary'
videoChannel:
$ref: '#/components/schemas/VideoChannelSummary'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
VideoComment:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
url:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
text:
type: string
add missing video comment fields in openapi spec closes #4079
2021-05-11 13:19:26 -05:00
format: html
description: Text of the comment
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
minLength: 1
add missing video comment fields in openapi spec closes #4079
2021-05-11 13:19:26 -05:00
example: This video is wonderful!
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
threadId:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
add missing video comment fields in openapi spec closes #4079
2021-05-11 13:19:26 -05:00
inReplyToCommentId:
nullable: true
allOf:
- $ref: '#/components/schemas/id'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
videoId:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/Video/properties/id'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
createdAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
updatedAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
add missing video comment fields in openapi spec closes #4079
2021-05-11 13:19:26 -05:00
deletedAt:
nullable: true
type: string
format: date-time
default: null
isDeleted:
type: boolean
default: false
Add author indicator to the comment replies loader
2019-12-28 04:27:31 -06:00
totalRepliesFromVideoAuthor:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
minimum: 0
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
totalReplies:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
minimum: 0
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
account:
$ref: '#/components/schemas/Account'
VideoCommentThreadTree:
properties:
comment:
$ref: '#/components/schemas/VideoComment'
children:
type: array
items:
$ref: '#/components/schemas/VideoCommentThreadTree'
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
VideoCaption:
properties:
language:
add description with operation link to category/licence/language constants
2021-05-03 07:34:46 -05:00
$ref: '#/components/schemas/VideoConstantString-Language'
Add video caption rest api doc
2019-05-24 03:01:08 -05:00
captionPath:
type: string
Update avatar/banner API doc
2021-04-08 02:34:32 -05:00
ActorImage:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
properties:
path:
type: string
Implement avatar miniatures (#4639) * client: remove unused file * refactor(client/my-actor-avatar): size from input Read size from component input instead of scss, to make it possible to use smaller avatar images when implemented. * implement avatar miniatures close #4560 * fix(test): max file size * fix(search-index): normalize res acc to avatarMini * refactor avatars to an array * client/search: resize channel avatar to 120 * refactor(client/videos): remove unused function * client(actor-avatar): set default size * fix tests and avatars full result When findOne is used only an array containting one avatar is returned. * update migration version and version notations * server/search: harmonize normalizing * Cleanup avatar miniature PR Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-02-28 01:34:43 -06:00
width:
type: integer
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
createdAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
updatedAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
ActorInfo:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
name:
type: string
displayName:
type: string
host:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: hostname
Implement avatar miniatures (#4639) * client: remove unused file * refactor(client/my-actor-avatar): size from input Read size from component input instead of scss, to make it possible to use smaller avatar images when implemented. * implement avatar miniatures close #4560 * fix(test): max file size * fix(search-index): normalize res acc to avatarMini * refactor avatars to an array * client/search: resize channel avatar to 120 * refactor(client/videos): remove unused function * client(actor-avatar): set default size * fix tests and avatars full result When findOne is used only an array containting one avatar is returned. * update migration version and version notations * server/search: harmonize normalizing * Cleanup avatar miniature PR Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-02-28 01:34:43 -06:00
avatars:
type: array
items:
$ref: '#/components/schemas/ActorImage'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
Actor:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
url:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
name:
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
description: immutable name of the actor, used to find or mention it
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
allOf:
- $ref: '#/components/schemas/username'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
host:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: hostname
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
description: server on which the actor is resident
refactor subscriptions response from list to totalDataList in openapi spec closes #4067
2021-05-10 07:39:01 -05:00
hostRedundancyAllowed:
type: boolean
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
description: whether this actor's host allows redundancy of its videos
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
followingCount:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
minimum: 0
description: number of actors subscribed to by this actor, as seen by this instance
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
followersCount:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
minimum: 0
description: number of followers of this actor, as seen by this instance
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
createdAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
updatedAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
Account:
allOf:
- $ref: '#/components/schemas/Actor'
- properties:
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
userId:
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
description: object id for the user tied to this account
allOf:
- $ref: '#/components/schemas/User/properties/id'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
displayName:
type: string
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
description: editable name of the account, displayed in its representations
minLength: 3
maxLength: 120
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
description:
type: string
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
description: text or bio displayed on the account's profile
Update open api routes
2022-04-05 07:34:52 -05:00
UserViewingVideo:
Add event doc to view endpoint
2022-04-05 07:56:28 -05:00
required:
- currentTime
adding ownership and watching video APIs to the spec
2018-11-16 05:11:00 -06:00
properties:
currentTime:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
fix video playlistId/videoId for video playlists in openapi spec closes #4081
2021-05-12 07:33:04 -05:00
format: seconds
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
description: timestamp within the video, in seconds
example: 5
Add event doc to view endpoint
2022-04-05 07:56:28 -05:00
viewEvent:
type: string
enum:
- seek
description: >
Event since last viewing call:
* `seek` - If the user seeked the video
Update open api routes
2022-04-05 07:34:52 -05:00
VideoStatsOverall:
properties:
averageWatchTime:
type: number
totalWatchTime:
type: number
viewersPeak:
type: number
viewersPeakDate:
type: string
format: date-time
countries:
type: array
items:
type: object
properties:
isoCode:
type: string
viewers:
type: number
VideoStatsRetention:
properties:
data:
type: array
items:
type: object
properties:
second:
type: number
retentionPercent:
type: number
VideoStatsTimeserie:
properties:
data:
type: array
items:
type: object
properties:
date:
type: string
value:
type: number
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
ServerConfig:
properties:
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
instance:
type: object
properties:
name:
type: string
shortDescription:
type: string
defaultClientRoute:
type: string
isNSFW:
type: boolean
defaultNSFWPolicy:
type: string
customizations:
type: object
properties:
javascript:
type: string
css:
type: string
Minor update to the OpenAPI: instance config recent additions
2020-02-21 14:25:49 -06:00
search:
type: object
properties:
remoteUri:
type: object
properties:
users:
type: boolean
anonymous:
type: boolean
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
plugin:
type: object
properties:
registered:
type: array
items:
type: string
theme:
type: object
properties:
registered:
type: array
items:
type: string
email:
type: object
properties:
enabled:
type: boolean
contactForm:
type: object
properties:
enabled:
type: boolean
serverVersion:
type: string
serverCommit:
type: string
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
signup:
type: object
properties:
allowed:
type: boolean
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
allowedForCurrentIP:
type: boolean
requiresEmailVerification:
type: boolean
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
transcoding:
type: object
properties:
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
hls:
type: object
properties:
enabled:
type: boolean
Minor update to the OpenAPI: instance config recent additions
2020-02-21 14:25:49 -06:00
webtorrent:
type: object
properties:
enabled:
type: boolean
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
enabledResolutions:
type: array
items:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
$ref: '#/components/schemas/VideoResolutionSet'
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
import:
type: object
properties:
videos:
type: object
properties:
http:
type: object
properties:
enabled:
type: boolean
torrent:
type: object
properties:
enabled:
type: boolean
autoBlacklist:
type: object
properties:
videos:
type: object
properties:
ofUsers:
type: object
properties:
enabled:
type: boolean
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
avatar:
type: object
properties:
file:
type: object
properties:
size:
type: object
properties:
max:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
extensions:
type: array
items:
type: string
video:
type: object
properties:
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
image:
type: object
properties:
extensions:
type: array
items:
type: string
size:
type: object
properties:
max:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
file:
type: object
properties:
extensions:
type: array
items:
type: string
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
videoCaption:
type: object
properties:
file:
type: object
properties:
size:
type: object
properties:
max:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
extensions:
type: array
items:
type: string
user:
type: object
properties:
videoQuota:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: 16810141515
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
videoQuotaDaily:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: 1681014151
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
trending:
type: object
properties:
videos:
type: object
properties:
intervalDays:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
tracker:
Fix openapi
2019-10-29 02:26:24 -05:00
type: object
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
properties:
enabled:
type: boolean
Minor update to the OpenAPI: instance config recent additions
2020-02-21 14:25:49 -06:00
followings:
type: object
properties:
instance:
type: object
properties:
autoFollowIndex:
type: object
properties:
indexUrl:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
Instance homepage support (#4007) * Prepare homepage parsers * Add ability to update instance hompage * Add ability to set homepage as landing page * Add homepage preview in admin * Dynamically update left menu for homepage * Inject home content in homepage * Add videos list and channel miniature custom markup * Remove unused elements in markup service
2021-05-27 08:59:55 -05:00
homepage:
type: object
properties:
enabled:
type: boolean
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
ServerConfigAbout:
properties:
instance:
type: object
properties:
name:
type: string
shortDescription:
type: string
description:
type: string
terms:
type: string
ServerConfigCustom:
properties:
instance:
type: object
properties:
name:
type: string
shortDescription:
type: string
description:
type: string
terms:
type: string
defaultClientRoute:
type: string
isNSFW:
type: boolean
defaultNSFWPolicy:
type: string
customizations:
type: object
properties:
javascript:
type: string
css:
type: string
theme:
type: object
properties:
default:
type: string
services:
type: object
properties:
twitter:
type: object
properties:
username:
type: string
whitelisted:
type: boolean
cache:
type: object
properties:
previews:
type: object
properties:
size:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
captions:
type: object
properties:
size:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
signup:
type: object
properties:
enabled:
type: boolean
limit:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
requiresEmailVerification:
type: boolean
admin:
type: object
properties:
email:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: email
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
contactForm:
type: object
properties:
enabled:
type: boolean
user:
type: object
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
description: Settings that apply to new users, if registration is enabled
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
properties:
videoQuota:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: 16810141515
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
videoQuotaDaily:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: 1681014151
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
transcoding:
type: object
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
description: Settings pertaining to transcoding jobs
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
properties:
enabled:
type: boolean
allowAdditionalExtensions:
type: boolean
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
description: Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
allowAudioFiles:
type: boolean
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
description: If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
threads:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
description: Amount of threads used by ffmpeg for 1 transcoding job
concurrency:
type: number
description: Amount of transcoding jobs to execute in parallel
profile:
type: string
enum:
- default
description: |
New profiles can be added by plugins ; available in core PeerTube: 'default'.
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
resolutions:
type: object
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
description: Resolutions to transcode _new videos_ to
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
properties:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
0p:
type: boolean
Added 144p encoding (#4492) * Added 144p encoding Implements https://github.com/Chocobozzz/PeerTube/issues/4428 * Fixed typo in core-utils * Increased BitPerPixel for 144p * Disabled 144p by default in test.yaml * Another try at fixing tests * Fixed test in video-transcoder (api-3) * Fixed test in video-imports (api-4) * Fixed test in live-constraints (api-2) * Tried to fix tests in api-3 again * Revert "Tried to fix tests in api-3 again" This reverts commit 266e1143fa37f333d149c2c2791c7bd33621ac14. * Fixed test in config.ts (api-2) * Try to fix test in video-hls.ts (api-3) * Fixed test in video-transcoder.ts (api-3) * Fix tests Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-11-05 04:23:02 -05:00
144p:
type: boolean
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
240p:
type: boolean
360p:
type: boolean
480p:
type: boolean
720p:
type: boolean
1080p:
type: boolean
add support for 1440p (Quad HD/QHD/WQHD) videos
2020-12-24 11:02:04 -06:00
1440p:
type: boolean
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
2160p:
type: boolean
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
webtorrent:
type: object
description: WebTorrent-specific settings
properties:
enabled:
type: boolean
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
hls:
type: object
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
description: HLS-specific settings
Update API documentation for accounts and config (#2072) * Update Actor and Account schemas * Fix mixed up paramaters for /accounts * Update ServerConfig schema * Add ServerConfigAbout and ServerConfigCustom schemas
2019-08-22 06:33:07 -05:00
properties:
enabled:
type: boolean
import:
type: object
properties:
videos:
type: object
properties:
http:
type: object
properties:
enabled:
type: boolean
torrent:
type: object
properties:
enabled:
type: boolean
autoBlacklist:
type: object
properties:
videos:
type: object
properties:
ofUsers:
type: object
properties:
enabled:
type: boolean
followers:
type: object
properties:
instance:
type: object
properties:
enabled:
type: boolean
manualApproval:
type: boolean
Instance homepage support (#4007) * Prepare homepage parsers * Add ability to update instance hompage * Add ability to set homepage as landing page * Add homepage preview in admin * Dynamically update left menu for homepage * Inject home content in homepage * Add videos list and channel miniature custom markup * Remove unused elements in markup service
2021-05-27 08:59:55 -05:00
CustomHomepage:
properties:
content:
type: string
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
Follow:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
follower:
$ref: '#/components/schemas/Actor'
following:
$ref: '#/components/schemas/Actor'
score:
type: number
add redundancy to the openapi spec
2020-06-25 04:14:43 -05:00
description: score reflecting the reachability of the actor, with steps of `10` and a base score of `1000`.
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
state:
type: string
enum:
- pending
- accepted
createdAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
updatedAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
Update openapi
2020-07-10 02:51:56 -05:00
PredefinedAbuseReasons:
description: Reason categories that help triage reports
type: array
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
maxItems: 8
Update openapi
2020-07-10 02:51:56 -05:00
items:
type: string
enum:
- violentOrAbusive
- hatefulOrAbusive
- spamOrMisleading
- privacy
- rights
- serverRules
- thumbnails
- captions
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
Job:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
state:
type: string
enum:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- active
- completed
- failed
- waiting
- delayed
type:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
type: string
enum:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- activitypub-http-unicast
- activitypub-http-broadcast
- activitypub-http-fetcher
- activitypub-follow
- video-file-import
- video-transcoding
- email
- video-import
Refactor video views Introduce viewers attribute for live videos Count views for live videos Reduce delay to see the viewer update for lives Add ability to configure video views buffer interval and view ip expiration
2021-11-09 03:11:20 -06:00
- videos-views-stats
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
- activitypub-refresher
- video-redundancy
data:
type: object
additionalProperties: true
error:
type: object
additionalProperties: true
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
createdAt:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
finishedOn:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: date-time
processedOn:
type: string
format: date-time
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
AddUserResponse:
properties:
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
user:
type: object
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
account:
type: object
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
VideoUploadRequestCommon:
properties:
name:
description: Video name
type: string
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: What is PeerTube?
minLength: 3
maxLength: 120
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
channelId:
description: Channel id that will contain this video
type: integer
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: 3
minimum: 1
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
privacy:
$ref: '#/components/schemas/VideoPrivacySet'
category:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
$ref: '#/components/schemas/VideoCategorySet'
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
licence:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
$ref: '#/components/schemas/VideoLicenceSet'
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
language:
specify operationId in openapi spec and factorize videoconstant ids
2021-05-10 07:17:26 -05:00
$ref: '#/components/schemas/VideoLanguageSet'
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
description:
description: Video description
type: string
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: |
**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
waitTranscoding:
description: Whether or not we wait transcoding before publish the video
type: boolean
support:
description: A text tell the audience how to support the video creator
add response content for createVideoChannel endpoint in openapi spec closes #4077
2021-05-12 06:44:32 -05:00
example: Please support our work on https://soutenir.framasoft.org/en/ <3
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
type: string
nsfw:
description: Whether or not this video contains sensitive content
type: boolean
tags:
description: Video tags (maximum 5 tags each between 2 and 30 characters)
type: array
minItems: 1
maxItems: 5
uniqueItems: true
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example:
- framasoft
- peertube
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
items:
type: string
minLength: 2
maxLength: 30
commentsEnabled:
description: Enable or disable comments for this video
type: boolean
downloadEnabled:
description: Enable or disable downloading for this video
type: boolean
originallyPublishedAt:
description: Date when the content was originally published
type: string
format: date-time
scheduleUpdate:
$ref: '#/components/schemas/VideoScheduledUpdate'
thumbnailfile:
description: Video thumbnail file
type: string
format: binary
previewfile:
description: Video preview file
type: string
format: binary
required:
- channelId
- name
VideoUploadRequestLegacy:
allOf:
- $ref: '#/components/schemas/VideoUploadRequestCommon'
- type: object
required:
- videofile
properties:
videofile:
description: Video file
type: string
format: binary
VideoUploadRequestResumable:
allOf:
- $ref: '#/components/schemas/VideoUploadRequestCommon'
- type: object
required:
- filename
properties:
filename:
description: Video filename including extension
type: string
format: filename
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
example: what_is_peertube.mp4
Resumable video uploads (#3933) * WIP: resumable video uploads relates to #324 * fix review comments * video upload: error handling * fix audio upload * fixes after self review * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/middlewares/validators/videos/videos.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * Update server/controllers/api/videos/index.ts Co-authored-by: Rigel Kent <par@rigelk.eu> * update after code review * refactor upload route - restore multipart upload route - move resumable to dedicated upload-resumable route - move checks to middleware - do not leak internal fs structure in response * fix yarn.lock upon rebase * factorize addVideo for reuse in both endpoints * add resumable upload API to openapi spec * add initial test and test helper for resumable upload * typings for videoAddResumable middleware * avoid including aws and google packages via node-uploadx, by only including uploadx/core * rename ex-isAudioBg to more explicit name mentioning it is a preview file for audio * add video-upload-tmp-folder-cleaner job * stronger typing of video upload middleware * reduce dependency to @uploadx/core * add audio upload test * refactor resumable uploads cleanup from job to scheduler * refactor resumable uploads scheduler to compare to last execution time * make resumable upload validator to always cleanup on failure * move legacy upload request building outside of uploadVideo test helper * filter upload-resumable middlewares down to POST, PUT, DELETE also begin to type metadata * merge add duration functions * stronger typings and documentation for uploadx behaviour, move init validator up * refactor(client/video-edit): options > uploadxOptions * refactor(client/video-edit): remove obsolete else * scheduler/remove-dangling-resum: rename tag * refactor(server/video): add UploadVideoFiles type * refactor(mw/validators): restructure eslint disable * refactor(mw/validators/videos): rename import * refactor(client/vid-upload): rename html elem id * refactor(sched/remove-dangl): move fn to method * refactor(mw/async): add method typing * refactor(mw/vali/video): double quote > single * refactor(server/upload-resum): express use > all * proper http methud enum server/middlewares/async.ts * properly type http methods * factorize common video upload validation steps * add check for maximum partially uploaded file size * fix audioBg use * fix extname(filename) in addVideo * document parameters for uploadx's resumable protocol * clear META files in scheduler * last audio refactor before cramming preview in the initial POST form data * refactor as mulitpart/form-data initial post request this allows preview/thumbnail uploads alongside the initial request, and cleans up the upload form * Add more tests for resumable uploads * Refactor remove dangling resumable uploads * Prepare changelog * Add more resumable upload tests * Remove user quota check for resumable uploads * Fix upload error handler * Update nginx template for upload-resumable * Cleanup comment * Remove unused express methods * Prefer to use got instead of raw http * Don't retry on error 500 Co-authored-by: Rigel Kent <par@rigelk.eu> Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Chocobozzz <me@florianbigard.com>
2021-05-10 04:13:41 -05:00
thumbnailfile:
description: Video thumbnail file
type: string
format: binary
previewfile:
description: Video preview file
type: string
format: binary
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
VideoUploadResponse:
properties:
video:
type: object
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/Video/properties/id'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
uuid:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/Video/properties/uuid'
Support short uuid for GET video/playlist
2021-06-28 10:30:59 -05:00
shortUUID:
$ref: '#/components/schemas/Video/properties/shortUUID'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
CommentThreadResponse:
properties:
total:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: 1
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
data:
type: array
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
maxItems: 100
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
items:
$ref: '#/components/schemas/VideoComment'
CommentThreadPostResponse:
properties:
comment:
$ref: '#/components/schemas/VideoComment'
Fix videos list response in rest api doc
2019-05-24 03:17:54 -05:00
VideoListResponse:
properties:
total:
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
type: integer
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: 1
Fix videos list response in rest api doc
2019-05-24 03:17:54 -05:00
data:
type: array
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
maxItems: 100
Fix videos list response in rest api doc
2019-05-24 03:17:54 -05:00
items:
$ref: '#/components/schemas/Video'
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
User:
properties:
specify getUserId variant in openapi spec closes #4062
2021-05-10 05:01:40 -05:00
account:
$ref: '#/components/schemas/Account'
autoPlayNextVideo:
type: boolean
description: Automatically start playing the upcoming video after the currently playing video
autoPlayNextVideoPlaylist:
type: boolean
description: Automatically start playing the video on the playlist after the currently playing video
autoPlayVideo:
type: boolean
description: Automatically start playing the video on the watch page
blocked:
type: boolean
blockedReason:
type: string
createdAt:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
type: string
email:
type: string
format: email
description: The user email
specify getUserId variant in openapi spec closes #4062
2021-05-10 05:01:40 -05:00
emailVerified:
type: boolean
description: Has the user confirmed their email address?
id:
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
allOf:
- $ref: '#/components/schemas/id'
specify getUserId variant in openapi spec closes #4062
2021-05-10 05:01:40 -05:00
readOnly: true
Add ability to update plugin auth
2021-02-01 08:39:13 -06:00
pluginAuth:
type: string
description: Auth plugin to use to authenticate the user
specify getUserId variant in openapi spec closes #4062
2021-05-10 05:01:40 -05:00
lastLoginDate:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
type: string
specify getUserId variant in openapi spec closes #4062
2021-05-10 05:01:40 -05:00
format: date-time
noInstanceConfigWarningModal:
type: boolean
Allow accounts to skip account setup modal
2021-08-27 03:15:55 -05:00
noAccountSetupWarningModal:
type: boolean
specify getUserId variant in openapi spec closes #4062
2021-05-10 05:01:40 -05:00
noWelcomeModal:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
type: boolean
nsfwPolicy:
$ref: '#/components/schemas/NSFWPolicy'
role:
$ref: '#/components/schemas/UserRole'
roleLabel:
type: string
enum:
- User
- Moderator
- Administrator
specify getUserId variant in openapi spec closes #4062
2021-05-10 05:01:40 -05:00
theme:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
type: string
specify getUserId variant in openapi spec closes #4062
2021-05-10 05:01:40 -05:00
description: Theme enabled by this user
username:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/username'
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
videoChannels:
type: array
items:
$ref: '#/components/schemas/VideoChannel'
specify getUserId variant in openapi spec closes #4062
2021-05-10 05:01:40 -05:00
videoQuota:
type: integer
description: The user video quota in bytes
example: -1
videoQuotaDaily:
type: integer
description: The user daily video quota in bytes
example: -1
Add ability for admins to set default p2p policy
2021-12-15 08:58:10 -06:00
p2pEnabled:
specify getUserId variant in openapi spec closes #4062
2021-05-10 05:01:40 -05:00
type: boolean
description: Enable P2P in the player
UserWithStats:
allOf:
- $ref: '#/components/schemas/User'
- properties:
# optionally present fields: they require WITH_STATS scope
videosCount:
type: integer
Fix broken openapi schema
2021-05-27 04:52:03 -05:00
description: Count of videos published
specify getUserId variant in openapi spec closes #4062
2021-05-10 05:01:40 -05:00
abusesCount:
type: integer
description: Count of reports/abuses of which the user is a target
abusesAcceptedCount:
type: integer
description: Count of reports/abuses created by the user and accepted/acted upon by the moderation team
abusesCreatedCount:
type: integer
description: Count of reports/abuses created by the user
videoCommentsCount:
type: integer
description: Count of comments published
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
AddUser:
properties:
username:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/username'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
password:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/password'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
email:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: email
description: The user email
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
videoQuota:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
type: integer
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: The user video quota in bytes
example: -1
Add videoQuotaDaily in documentation
2019-04-24 09:54:17 -05:00
videoQuotaDaily:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
type: integer
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: The user daily video quota in bytes
example: -1
Add ability to update plugin auth
2021-02-01 08:39:13 -06:00
channelName:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/usernameChannel'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
role:
Add playlist exist api doc
2020-04-21 09:41:31 -05:00
$ref: '#/components/schemas/UserRole'
Add ability to update plugin auth
2021-02-01 08:39:13 -06:00
adminFlags:
$ref: '#/components/schemas/UserAdminFlags'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
required:
- username
- password
- email
- videoQuota
Add videoQuotaDaily in documentation
2019-04-24 09:54:17 -05:00
- videoQuotaDaily
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
- role
UpdateUser:
properties:
email:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
description: The updated email of the user
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
allOf:
- $ref: '#/components/schemas/User/properties/email'
Add ability to update plugin auth
2021-02-01 08:39:13 -06:00
emailVerified:
type: boolean
description: Set the email as verified
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
videoQuota:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
type: integer
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: The updated video quota of the user in bytes
Add videoQuotaDaily in documentation
2019-04-24 09:54:17 -05:00
videoQuotaDaily:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
type: integer
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: The updated daily video quota of the user in bytes
Add ability to update plugin auth
2021-02-01 08:39:13 -06:00
pluginAuth:
type: string
nullable: true
description: The auth plugin to use to authenticate the user
example: 'peertube-plugin-auth-saml2'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
role:
Add playlist exist api doc
2020-04-21 09:41:31 -05:00
$ref: '#/components/schemas/UserRole'
Add ability to update plugin auth
2021-02-01 08:39:13 -06:00
adminFlags:
$ref: '#/components/schemas/UserAdminFlags'
Add missing password field to update user api doc
2022-01-10 02:17:28 -06:00
password:
$ref: '#/components/schemas/password'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
UpdateMe:
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
# see shared/models/users/user-update-me.model.ts:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
properties:
password:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/password'
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
currentPassword:
$ref: '#/components/schemas/password'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
email:
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
description: new email used for login and service communications
allOf:
- $ref: '#/components/schemas/User/properties/email'
displayName:
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
type: string
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
description: new name of the user in its representations
minLength: 3
maxLength: 120
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
displayNSFW:
type: string
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
description: new NSFW display policy
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
enum:
- 'true'
- 'false'
- both
Add ability for admins to set default p2p policy
2021-12-15 08:58:10 -06:00
p2pEnabled:
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
type: boolean
description: whether to enable P2P in the player or not
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
autoPlayVideo:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
type: boolean
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
description: new preference regarding playing videos automatically
autoPlayNextVideo:
type: boolean
description: new preference regarding playing following videos automatically
autoPlayNextVideoPlaylist:
type: boolean
description: new preference regarding playing following playlist videos automatically
videosHistoryEnabled:
type: boolean
description: whether to keep track of watched history or not
videoLanguages:
type: array
items:
type: string
description: list of languages to filter videos down to
theme:
type: string
noInstanceConfigWarningModal:
type: boolean
Allow accounts to skip account setup modal
2021-08-27 03:15:55 -05:00
noAccountSetupWarningModal:
type: boolean
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
noWelcomeModal:
type: boolean
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
GetMeVideoRating:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
rating:
fix response in openapi spec for quota and video ratings closes #4064 closes #4065
2021-05-10 03:26:50 -05:00
type: string
enum:
- like
- dislike
- none
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
description: Rating of the video
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
required:
- id
- rating
Add /accounts/:username/ratings endpoint (#1756) * Add /users/me/videos/ratings endpoint * Move ratings endpoint from users to accounts * /accounts/:name/ratings: add support for rating= and sort= * Restrict ratings list to owner * Wording and better way to ensure current account
2019-04-09 04:02:02 -05:00
VideoRating:
properties:
video:
$ref: '#/components/schemas/Video'
rating:
fix response in openapi spec for quota and video ratings closes #4064 closes #4065
2021-05-10 03:26:50 -05:00
type: string
enum:
- like
- dislike
- none
description: Rating of the video
Add /accounts/:username/ratings endpoint (#1756) * Add /users/me/videos/ratings endpoint * Move ratings endpoint from users to accounts * /accounts/:name/ratings: add support for rating= and sort= * Restrict ratings list to owner * Wording and better way to ensure current account
2019-04-09 04:02:02 -05:00
required:
- video
- rating
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
RegisterUser:
properties:
username:
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
description: immutable name of the user, used to find or mention its actor
allOf:
- $ref: '#/components/schemas/username'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
password:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/password'
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
email:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: email
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
description: email of the user, used for login or service communications
Improve registration * Add ability to set the user display name * Use display name to guess the username/channel name * Add explanations about what is the purpose of a username/channel name * Add a loader at the "done" step
2019-06-07 09:59:53 -05:00
displayName:
type: string
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
description: editable name of the user, displayed in its representations
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
minLength: 1
maxLength: 120
Improve registration * Add ability to set the user display name * Use display name to guess the username/channel name * Add explanations about what is the purpose of a username/channel name * Add a loader at the "done" step
2019-06-07 09:59:53 -05:00
channel:
type: object
add missing user update me fields in openapi spec
2021-05-11 14:38:33 -05:00
description: channel base information used to create the first channel of the user
Improve registration * Add ability to set the user display name * Use display name to guess the username/channel name * Add explanations about what is the purpose of a username/channel name * Add a loader at the "done" step
2019-06-07 09:59:53 -05:00
properties:
name:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/usernameChannel'
Improve registration * Add ability to set the user display name * Use display name to guess the username/channel name * Add explanations about what is the purpose of a username/channel name * Add a loader at the "done" step
2019-06-07 09:59:53 -05:00
displayName:
Implement avatar miniatures (#4639) * client: remove unused file * refactor(client/my-actor-avatar): size from input Read size from component input instead of scss, to make it possible to use smaller avatar images when implemented. * implement avatar miniatures close #4560 * fix(test): max file size * fix(search-index): normalize res acc to avatarMini * refactor avatars to an array * client/search: resize channel avatar to 120 * refactor(client/videos): remove unused function * client(actor-avatar): set default size * fix tests and avatars full result When findOne is used only an array containting one avatar is returned. * update migration version and version notations * server/search: harmonize normalizing * Cleanup avatar miniature PR Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-02-28 01:34:43 -06:00
type: string
migrate Swagger 2.0 spec to OpenAPI 3.0.0
2018-11-15 07:10:15 -06:00
required:
- username
- password
- email
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
add login/logout routes in openapi spec
2021-05-12 14:23:54 -05:00
OAuthClient:
properties:
client_id:
type: string
pattern: /^[a-z0-9]$/
maxLength: 32
minLength: 32
example: v1ikx5hnfop4mdpnci8nsqh93c45rldf
client_secret:
type: string
pattern: /^[a-zA-Z0-9]$/
maxLength: 32
minLength: 32
example: AjWiOapPltI6EnsWQwlFarRtLh4u8tDt
OAuthToken-password:
allOf:
- $ref: '#/components/schemas/OAuthClient'
- type: object
properties:
grant_type:
type: string
enum:
- password
- refresh_token
default: password
username:
$ref: '#/components/schemas/User/properties/username'
password:
$ref: '#/components/schemas/password'
required:
- client_id
- client_secret
- grant_type
- username
- password
OAuthToken-refresh_token:
allOf:
- $ref: '#/components/schemas/OAuthClient'
- type: object
properties:
grant_type:
type: string
enum:
- password
- refresh_token
default: password
refresh_token:
type: string
example: 2e0d675df9fc96d2e4ec8a3ebbbf45eca9137bb7
required:
- client_id
- client_secret
- grant_type
- refresh_token
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
VideoChannel:
Implement avatar miniatures (#4639) * client: remove unused file * refactor(client/my-actor-avatar): size from input Read size from component input instead of scss, to make it possible to use smaller avatar images when implemented. * implement avatar miniatures close #4560 * fix(test): max file size * fix(search-index): normalize res acc to avatarMini * refactor avatars to an array * client/search: resize channel avatar to 120 * refactor(client/videos): remove unused function * client(actor-avatar): set default size * fix tests and avatars full result When findOne is used only an array containting one avatar is returned. * update migration version and version notations * server/search: harmonize normalizing * Cleanup avatar miniature PR Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-02-28 01:34:43 -06:00
allOf:
- $ref: '#/components/schemas/Actor'
- type: object
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
properties:
Implement avatar miniatures (#4639) * client: remove unused file * refactor(client/my-actor-avatar): size from input Read size from component input instead of scss, to make it possible to use smaller avatar images when implemented. * implement avatar miniatures close #4560 * fix(test): max file size * fix(search-index): normalize res acc to avatarMini * refactor avatars to an array * client/search: resize channel avatar to 120 * refactor(client/videos): remove unused function * client(actor-avatar): set default size * fix tests and avatars full result When findOne is used only an array containting one avatar is returned. * update migration version and version notations * server/search: harmonize normalizing * Cleanup avatar miniature PR Co-authored-by: Chocobozzz <me@florianbigard.com>
2022-02-28 01:34:43 -06:00
displayName:
type: string
description: editable name of the channel, displayed in its representations
example: Videos of Framasoft
minLength: 1
maxLength: 120
description:
type: string
example: Videos made with <3 by Framasoft
minLength: 3
maxLength: 1000
support:
type: string
description: text shown by default on all videos of this channel, to tell the audience how to support it
example: Please support our work on https://soutenir.framasoft.org/en/ <3
minLength: 3
maxLength: 1000
isLocal:
readOnly: true
type: boolean
updatedAt:
readOnly: true
type: string
format: date-time
banners:
type: array
items:
$ref: '#/components/schemas/ActorImage'
ownerAccount:
readOnly: true
nullable: true
type: object
properties:
id:
type: integer
uuid:
$ref: '#/components/schemas/UUIDv4'
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
VideoChannelCreate:
allOf:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
- $ref: '#/components/schemas/VideoChannel'
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
- properties:
name:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: username of the channel to create
allOf:
- $ref: '#/components/schemas/usernameChannel'
Server: Bulk update videos support field
2019-05-31 09:30:11 -05:00
required:
- name
- displayName
VideoChannelUpdate:
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
allOf:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
- $ref: '#/components/schemas/VideoChannel'
fix video channel parameters limit in openapi spec
2021-05-03 07:14:45 -05:00
- properties:
bulkVideosSupportUpdate:
type: boolean
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
description: Update the support field for all videos of this channel
refactor subscriptions response from list to totalDataList in openapi spec closes #4067
2021-05-10 07:39:01 -05:00
VideoChannelList:
properties:
total:
type: integer
example: 1
data:
type: array
items:
allOf:
- $ref: '#/components/schemas/VideoChannel'
- $ref: '#/components/schemas/Actor'
Basic api documentation #7 (#220) * Basic api documentation * fix styling issue * fix styling issue * gitignore unecessary folders * openApi 2.0 first draft * solved conflicts * solved errors in openapi file * added missing doc on video + deleted apidoc comments * fix last warnings and errors inopenapi definition
2018-01-24 03:44:52 -06:00
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
MRSSPeerLink:
type: object
xml:
name: 'media:peerLink'
properties:
href:
type: string
xml:
attribute: true
type:
type: string
enum:
- application/x-bittorrent
xml:
attribute: true
MRSSGroupContent:
type: object
xml:
name: 'media:content'
properties:
url:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
xml:
attribute: true
fileSize:
type: integer
xml:
attribute: true
type:
type: string
xml:
attribute: true
framerate:
type: integer
xml:
attribute: true
duration:
type: integer
xml:
attribute: true
height:
type: integer
xml:
attribute: true
lang:
type: string
xml:
attribute: true
VideoCommentsForXML:
type: array
xml:
wrapped: true
name: 'channel'
items:
type: object
xml:
name: 'item'
properties:
link:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
guid:
type: string
pubDate:
type: string
format: date-time
'content:encoded':
type: string
'dc:creator':
type: string
VideosForXML:
type: array
xml:
wrapped: true
name: 'channel'
items:
type: object
xml:
name: 'item'
properties:
link:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: video watch page URL
guid:
type: string
description: video canonical URL
pubDate:
type: string
format: date-time
description: video publication date
description:
type: string
description: video description
'content:encoded':
type: string
description: video description
'dc:creator':
type: string
description: publisher user name
'media:category':
type: integer
description: video category (MRSS)
'media:community':
type: object
description: see [media:community](https://www.rssboard.org/media-rss#media-community) (MRSS)
properties:
'media:statistics':
type: object
properties:
views:
type: integer
xml:
attribute: true
'media:embed':
type: object
properties:
url:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: video embed path, relative to the canonical URL domain (MRSS)
xml:
attribute: true
'media:player':
type: object
properties:
url:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
description: video watch path, relative to the canonical URL domain (MRSS)
xml:
attribute: true
'media:thumbnail':
type: object
properties:
url:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
xml:
attribute: true
height:
type: integer
xml:
attribute: true
width:
type: integer
xml:
attribute: true
'media:title':
type: string
description: see [media:title](https://www.rssboard.org/media-rss#media-title) (MRSS). We only use `plain` titles.
'media:description':
type: string
'media:rating':
type: string
enum:
- nonadult
- adult
description: see [media:rating](https://www.rssboard.org/media-rss#media-rating) (MRSS)
'enclosure':
type: object
description: main streamable file for the video
properties:
url:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
add feeds to the openapi spec
2020-06-24 07:16:25 -05:00
xml:
attribute: true
type:
type: string
enum:
- application/x-bittorrent
xml:
attribute: true
length:
type: integer
xml:
attribute: true
'media:group':
type: array
description: list of streamable files for the video. see [media:peerLink](https://www.rssboard.org/media-rss#media-peerlink) and [media:content](https://www.rssboard.org/media-rss#media-content) or (MRSS)
items:
anyOf:
- $ref: '#/components/schemas/MRSSPeerLink'
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- $ref: '#/components/schemas/MRSSGroupContent'
NotificationSettingValue:
type: integer
description: >
Notification type
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `0` NONE
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `1` WEB
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `2` EMAIL
enum:
- 0
- 1
Deprecate filter video query Introduce include and isLocal instead
2021-10-27 07:37:04 -05:00
- 2
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
Notification:
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
type:
type: integer
description: >
Notification type, following the `UserNotificationType` enum:
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `1` NEW_VIDEO_FROM_SUBSCRIPTION
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `2` NEW_COMMENT_ON_MY_VIDEO
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
Add new abuses tests
2020-07-08 08:51:46 -05:00
- `3` NEW_ABUSE_FOR_MODERATORS
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `4` BLACKLIST_ON_MY_VIDEO
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `5` UNBLACKLIST_ON_MY_VIDEO
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `6` MY_VIDEO_PUBLISHED
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `7` MY_VIDEO_IMPORT_SUCCESS
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `8` MY_VIDEO_IMPORT_ERROR
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `9` NEW_USER_REGISTRATION
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `10` NEW_FOLLOW
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `11` COMMENT_MENTION
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `12` VIDEO_AUTO_BLACKLIST_FOR_MODERATORS
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `13` NEW_INSTANCE_FOLLOWER
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
- `14` AUTO_INSTANCE_FOLLOWING
Add missing password field to update user api doc
2022-01-10 02:17:28 -06:00
Updated notification types in openapi reference Relates to https://github.com/Chocobozzz/PeerTube/issues/1565
2021-12-22 04:01:24 -06:00
- `15` ABUSE_STATE_CHANGE
Add missing password field to update user api doc
2022-01-10 02:17:28 -06:00
Updated notification types in openapi reference Relates to https://github.com/Chocobozzz/PeerTube/issues/1565
2021-12-22 04:01:24 -06:00
- `16` ABUSE_NEW_MESSAGE
Add missing password field to update user api doc
2022-01-10 02:17:28 -06:00
Updated notification types in openapi reference Relates to https://github.com/Chocobozzz/PeerTube/issues/1565
2021-12-22 04:01:24 -06:00
- `17` NEW_PLUGIN_VERSION
Add missing password field to update user api doc
2022-01-10 02:17:28 -06:00
Updated notification types in openapi reference Relates to https://github.com/Chocobozzz/PeerTube/issues/1565
2021-12-22 04:01:24 -06:00
- `18` NEW_PEERTUBE_VERSION
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
read:
type: boolean
video:
nullable: true
allOf:
- $ref: '#/components/schemas/VideoInfo'
- type: object
properties:
channel:
$ref: '#/components/schemas/ActorInfo'
videoImport:
nullable: true
type: object
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
video:
nullable: true
$ref: '#/components/schemas/VideoInfo'
torrentName:
type: string
nullable: true
magnetUri:
added descriptions for video files/import fields in openapi spec
2021-05-10 18:50:36 -05:00
$ref: '#/components/schemas/VideoImport/properties/magnetUri'
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
targetUri:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: uri
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
nullable: true
comment:
nullable: true
type: object
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
threadId:
type: integer
video:
$ref: '#/components/schemas/VideoInfo'
account:
$ref: '#/components/schemas/ActorInfo'
videoAbuse:
nullable: true
type: object
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
video:
allOf:
- $ref: '#/components/schemas/VideoInfo'
videoBlacklist:
nullable: true
type: object
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
video:
allOf:
- $ref: '#/components/schemas/VideoInfo'
account:
nullable: true
allOf:
- $ref: '#/components/schemas/ActorInfo'
actorFollow:
type: object
nullable: true
properties:
id:
provide more schema examples in openapi spec
2021-05-10 09:09:59 -05:00
$ref: '#/components/schemas/id'
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
follower:
$ref: '#/components/schemas/ActorInfo'
state:
type: string
enum:
- pending
- accepted
following:
type: object
properties:
type:
type: string
enum:
- account
- channel
- instance
name:
type: string
displayName:
type: string
host:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: hostname
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
NotificationListResponse:
properties:
total:
type: integer
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: 1
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
data:
type: array
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
maxItems: 100
add notifications to the openapi spec
2020-06-24 15:25:05 -05:00
items:
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
$ref: '#/components/schemas/Notification'
Plugin:
properties:
name:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: peertube-plugin-auth-ldap
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
type:
type: integer
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
description: >
- `1`: PLUGIN
- `2`: THEME
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
enum:
- 1
- 2
latestVersion:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: 0.0.3
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
version:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: 0.0.1
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
enabled:
type: boolean
uninstalled:
type: boolean
peertubeEngine:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: 2.2.0
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
description:
type: string
homepage:
type: string
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
format: url
example: https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
settings:
type: object
additionalProperties: true
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
PluginResponse:
properties:
total:
type: integer
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
example: 1
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
data:
type: array
add examples and descriptions, missing filters for abuses in openapi spec
2020-06-26 06:43:27 -05:00
maxItems: 100
add plugins to the openapi spec
2020-06-25 05:16:08 -05:00
items:
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
$ref: '#/components/schemas/Plugin'
Add open api doc for live
2020-11-09 04:21:08 -06:00
LiveVideoUpdate:
properties:
saveReplay:
type: boolean
Add permanent live support
2020-12-03 07:10:54 -06:00
permanentLive:
description: User can stream multiple times in a permanent live
type: boolean
Add latency setting support
2022-03-04 06:40:02 -06:00
latencyMode:
description: User can select live latency mode if enabled by the instance
$ref: '#/components/schemas/LiveVideoLatencyMode'
Add open api doc for live
2020-11-09 04:21:08 -06:00
LiveVideoResponse:
properties:
rtmpUrl:
type: string
Fix getting live by anonymous user
2022-04-22 02:50:20 -05:00
description: Included in the response if an appropriate token is provided
Support RTMPS
2021-11-05 05:36:03 -05:00
rtmpsUrl:
type: string
Fix getting live by anonymous user
2022-04-22 02:50:20 -05:00
description: Included in the response if an appropriate token is provided
Add open api doc for live
2020-11-09 04:21:08 -06:00
streamKey:
type: string
Fix getting live by anonymous user
2022-04-22 02:50:20 -05:00
description: RTMP stream key to use to stream into this live video. Included in the response if an appropriate token is provided
Add open api doc for live
2020-11-09 04:21:08 -06:00
saveReplay:
type: boolean
Add permanent live support
2020-12-03 07:10:54 -06:00
permanentLive:
description: User can stream multiple times in a permanent live
type: boolean
Add latency setting support
2022-03-04 06:40:02 -06:00
latencyMode:
description: User can select live latency mode if enabled by the instance
$ref: '#/components/schemas/LiveVideoLatencyMode'
Update avatar/banner API doc
2021-04-08 02:34:32 -05:00
Support live session in server
2022-05-03 04:38:07 -05:00
LiveVideoSessionResponse:
properties:
id:
type: integer
startDate:
type: string
format: date-time
description: Start date of the live session
endDate:
type: string
format: date-time
nullable: true
description: End date of the live session
error:
type: integer
enum:
- 1
- 2
- 3
- 4
- 5
nullable: true
description: >
Fix various typos Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
Error type if an error occurred during the live session:
Support live session in server
2022-05-03 04:38:07 -05:00
- `1`: Bad socket health (transcoding is too slow)
- `2`: Max duration exceeded
- `3`: Quota exceeded
- `4`: Quota FFmpeg error
- `5`: Video has been blacklisted during the live
replayVideo:
type: object
description: Video replay information
properties:
id:
type: number
uuid:
$ref: '#/components/schemas/UUIDv4'
shortUUID:
$ref: '#/components/schemas/shortUUID'
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
callbacks:
searchIndex:
Fix openapi schema variable interpolation
2020-08-03 02:12:51 -05:00
'https://search.example.org/api/v1/search/videos':
update openapi spec with links and callback for search
2020-06-27 04:43:43 -05:00
post:
summary: third-party search index MAY be used instead of the local index, if enabled by the instance admin. see `searchTarget`
responses:
'200':
description: successful operation
content:
application/json:
schema:
Fix users tests
2020-07-02 07:23:50 -05:00
$ref: '#/components/schemas/VideoListResponse'