forks/peertube
1
0
Fork 0
Code Releases Activity

fix typo in operationId in openapi spec

Browse source
This commit is contained in:
Rigel Kent 2021-05-14 19:31:24 +02:00
parent 3cf8874f1a
commit 3f71c4c068
No known key found for this signature in database
GPG key ID: 5E53E96A494E452F
1 changed files with 111 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

118
support/doc/api/openapi.yaml
View file

@ -65,7 +65,7 @@ info:
{ {
"errors": { "errors": {
"id": { // "id": {
"value": "a117eb-c6a9-4756-bb09-2a956239f", "value": "a117eb-c6a9-4756-bb09-2a956239f",
"msg": "Should have a valid id", "msg": "Should have a valid id",
"param": "id", "param": "id",
@ -302,6 +302,7 @@ paths:
tags: tags:
- Accounts - Accounts
summary: Get an account summary: Get an account
operationId: getAccount
parameters: parameters:
- $ref: '#/components/parameters/name' - $ref: '#/components/parameters/name'
responses: responses:
@ -313,12 +314,14 @@ paths:
$ref: '#/components/schemas/Account' $ref: '#/components/schemas/Account'
'404': '404':
description: account not found description: account not found
'/accounts/{name}/videos': '/accounts/{name}/videos':
get: get:
tags: tags:
- Accounts - Accounts
- Video - Video
summary: 'List videos of an account' summary: 'List videos of an account'
operationId: getAccountVideos
parameters: parameters:
- $ref: '#/components/parameters/name' - $ref: '#/components/parameters/name'
- $ref: '#/components/parameters/categoryOneOf' - $ref: '#/components/parameters/categoryOneOf'
@ -374,11 +377,13 @@ paths:
json = r.json() json = r.json()
print(json) print(json)
/accounts: /accounts:
get: get:
tags: tags:
- Accounts - Accounts
summary: List accounts summary: List accounts
operationId: getAccounts
parameters: parameters:
- $ref: '#/components/parameters/start' - $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count' - $ref: '#/components/parameters/count'
@ -392,11 +397,13 @@ paths:
type: array type: array
items: items:
$ref: '#/components/schemas/Account' $ref: '#/components/schemas/Account'
/config: /config:
get: get:
tags: tags:
- Config - Config
summary: Get instance public configuration summary: Get instance public configuration
operationId: getConfig
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -407,9 +414,11 @@ paths:
examples: examples:
nightly: nightly:
externalValue: https://peertube2.cpy.re/api/v1/config externalValue: https://peertube2.cpy.re/api/v1/config
/config/about: /config/about:
get: get:
summary: Get instance "About" information summary: Get instance "About" information
operationId: getAbout
tags: tags:
- Config - Config
responses: responses:
@ -422,9 +431,11 @@ paths:
examples: examples:
nightly: nightly:
externalValue: https://peertube2.cpy.re/api/v1/config/about externalValue: https://peertube2.cpy.re/api/v1/config/about
/config/custom: /config/custom:
get: get:
summary: Get instance runtime configuration summary: Get instance runtime configuration
operationId: getCustomConfig
tags: tags:
- Config - Config
security: security:
@ -439,6 +450,7 @@ paths:
$ref: '#/components/schemas/ServerConfigCustom' $ref: '#/components/schemas/ServerConfigCustom'
put: put:
summary: Set instance runtime configuration summary: Set instance runtime configuration
operationId: putCustomConfig
tags: tags:
- Config - Config
security: security:
@ -455,6 +467,7 @@ paths:
- webtorrent and hls are disabled with transcoding enabled - you need at least one enabled - webtorrent and hls are disabled with transcoding enabled - you need at least one enabled
delete: delete:
summary: Delete instance runtime configuration summary: Delete instance runtime configuration
operationId: delCustomConfig
tags: tags:
- Config - Config
security: security:
@ -463,9 +476,11 @@ paths:
responses: responses:
'200': '200':
description: successful operation description: successful operation
/jobs/{state}: /jobs/{state}:
get: get:
summary: List instance jobs summary: List instance jobs
operationId: getJobs
security: security:
- OAuth2: - OAuth2:
- admin - admin
@ -532,6 +547,7 @@ paths:
type: array type: array
items: items:
$ref: '#/components/schemas/Follow' $ref: '#/components/schemas/Follow'
'/server/followers/{nameWithHost}': '/server/followers/{nameWithHost}':
delete: delete:
summary: Remove or reject a follower to your server summary: Remove or reject a follower to your server
@ -553,6 +569,7 @@ paths:
description: successful operation description: successful operation
'404': '404':
description: follower not found description: follower not found
'/server/followers/{nameWithHost}/reject': '/server/followers/{nameWithHost}/reject':
post: post:
summary: Reject a pending follower to your server summary: Reject a pending follower to your server
@ -574,6 +591,7 @@ paths:
description: successful operation description: successful operation
'404': '404':
description: follower not found description: follower not found
'/server/followers/{nameWithHost}/accept': '/server/followers/{nameWithHost}/accept':
post: post:
summary: Accept a pending follower to your server summary: Accept a pending follower to your server
@ -646,6 +664,7 @@ paths:
type: string type: string
format: hostname format: hostname
uniqueItems: true uniqueItems: true
'/server/following/{host}': '/server/following/{host}':
delete: delete:
summary: Unfollow a server summary: Unfollow a server
@ -713,6 +732,7 @@ paths:
required: true required: true
get: get:
summary: List users summary: List users
operationId: getUsers
security: security:
- OAuth2: - OAuth2:
- admin - admin
@ -733,6 +753,7 @@ paths:
type: array type: array
items: items:
$ref: '#/components/schemas/User' $ref: '#/components/schemas/User'
'/users/{id}': '/users/{id}':
parameters: parameters:
- $ref: '#/components/parameters/id' - $ref: '#/components/parameters/id'
@ -792,7 +813,7 @@ paths:
/oauth-clients/local: /oauth-clients/local:
get: get:
summary: Login prerequisite summary: Login prerequisite
description: You need to retrieve a client id and secret before [logging in](#operation/getOauthToken). description: You need to retrieve a client id and secret before [logging in](#operation/getOAuthToken).
operationId: getOAuthClient operationId: getOAuthClient
tags: tags:
- Session - Session
@ -816,6 +837,7 @@ paths:
## AUTH ## AUTH
curl -s "$API/oauth-clients/local" curl -s "$API/oauth-clients/local"
/users/token: /users/token:
post: post:
summary: Login summary: Login
@ -880,6 +902,7 @@ paths:
--data username="$USERNAME" \ --data username="$USERNAME" \
--data password="$PASSWORD" \ --data password="$PASSWORD" \
| jq -r ".access_token" | jq -r ".access_token"
/users/revoke-token: /users/revoke-token:
post: post:
summary: Logout summary: Logout
@ -896,6 +919,7 @@ paths:
/users/register: /users/register:
post: post:
summary: Register a user summary: Register a user
operationId: registerUser
tags: tags:
- Users - Users
- Register - Register
@ -908,9 +932,11 @@ paths:
schema: schema:
$ref: '#/components/schemas/RegisterUser' $ref: '#/components/schemas/RegisterUser'
required: true required: true
/users/{id}/verify-email: /users/{id}/verify-email:
post: post:
summary: Verify a user summary: Verify a user
operationId: verifyUser
description: | description: |
Following a user registration, the new user will receive an email asking to click a link Following a user registration, the new user will receive an email asking to click a link
containing a secret. containing a secret.
@ -939,9 +965,11 @@ paths:
description: invalid verification string description: invalid verification string
'404': '404':
description: user not found description: user not found
/users/ask-send-verify-email: /users/ask-send-verify-email:
post: post:
summary: Resend user verification link summary: Resend user verification link
operationId: resendEmailToVerifyUser
tags: tags:
- Users - Users
- Register - Register
@ -952,6 +980,7 @@ paths:
/users/me: /users/me:
get: get:
summary: Get my user information summary: Get my user information
operationId: getUserInfo
security: security:
- OAuth2: - OAuth2:
- user - user
@ -968,6 +997,7 @@ paths:
$ref: '#/components/schemas/User' $ref: '#/components/schemas/User'
put: put:
summary: Update my user information summary: Update my user information
operationId: putUserInfo
security: security:
- OAuth2: - OAuth2:
- user - user
@ -982,6 +1012,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/UpdateMe' $ref: '#/components/schemas/UpdateMe'
required: true required: true
/users/me/videos/imports: /users/me/videos/imports:
get: get:
summary: Get video imports of my user summary: Get video imports of my user
@ -1002,6 +1033,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/VideoImportsList' $ref: '#/components/schemas/VideoImportsList'
/users/me/video-quota-used: /users/me/video-quota-used:
get: get:
summary: Get my user used quota summary: Get my user used quota
@ -1026,6 +1058,7 @@ paths:
type: number type: number
description: The user video quota used today in bytes description: The user video quota used today in bytes
example: 1681014151 example: 1681014151
'/users/me/videos/{videoId}/rating': '/users/me/videos/{videoId}/rating':
get: get:
summary: Get rate of my user for a video summary: Get rate of my user for a video
@ -1048,6 +1081,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/GetMeVideoRating' $ref: '#/components/schemas/GetMeVideoRating'
/users/me/videos: /users/me/videos:
get: get:
summary: Get videos of my user summary: Get videos of my user
@ -1068,6 +1102,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/VideoListResponse' $ref: '#/components/schemas/VideoListResponse'
/users/me/subscriptions: /users/me/subscriptions:
get: get:
summary: Get my user subscriptions summary: Get my user subscriptions
@ -1113,6 +1148,7 @@ paths:
responses: responses:
'200': '200':
description: successful operation description: successful operation
/users/me/subscriptions/exist: /users/me/subscriptions/exist:
get: get:
summary: Get if subscriptions exist for my user summary: Get if subscriptions exist for my user
@ -1130,6 +1166,7 @@ paths:
application/json: application/json:
schema: schema:
type: object type: object
/users/me/subscriptions/videos: /users/me/subscriptions/videos:
get: get:
summary: List videos of subscriptions of my user summary: List videos of subscriptions of my user
@ -1159,6 +1196,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/VideoListResponse' $ref: '#/components/schemas/VideoListResponse'
'/users/me/subscriptions/{subscriptionHandle}': '/users/me/subscriptions/{subscriptionHandle}':
get: get:
summary: Get subscription of my user summary: Get subscription of my user
@ -1188,6 +1226,7 @@ paths:
responses: responses:
'200': '200':
description: successful operation description: successful operation
/users/me/notifications: /users/me/notifications:
get: get:
summary: List my notifications summary: List my notifications
@ -1211,6 +1250,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/NotificationListResponse' $ref: '#/components/schemas/NotificationListResponse'
/users/me/notifications/read: /users/me/notifications/read:
post: post:
summary: Mark notifications as read by their id summary: Mark notifications as read by their id
@ -1234,6 +1274,7 @@ paths:
responses: responses:
'204': '204':
description: successful operation description: successful operation
/users/me/notifications/read-all: /users/me/notifications/read-all:
post: post:
summary: Mark all my notification as read summary: Mark all my notification as read
@ -1244,6 +1285,7 @@ paths:
responses: responses:
'204': '204':
description: successful operation description: successful operation
/users/me/notification-settings: /users/me/notification-settings:
put: put:
summary: Update my notification settings summary: Update my notification settings
@ -1284,6 +1326,7 @@ paths:
responses: responses:
'204': '204':
description: successful operation description: successful operation
/users/me/history/videos: /users/me/history/videos:
get: get:
summary: List watched videos history summary: List watched videos history
@ -1302,6 +1345,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/VideoListResponse' $ref: '#/components/schemas/VideoListResponse'
/users/me/history/videos/remove: /users/me/history/videos/remove:
post: post:
summary: Clear video history summary: Clear video history
@ -1322,6 +1366,7 @@ paths:
responses: responses:
'204': '204':
description: successful operation description: successful operation
/users/me/avatar/pick: /users/me/avatar/pick:
post: post:
summary: Update my user avatar summary: Update my user avatar
@ -1360,6 +1405,7 @@ paths:
encoding: encoding:
avatarfile: avatarfile:
contentType: image/png, image/jpeg contentType: image/png, image/jpeg
/users/me/avatar: /users/me/avatar:
delete: delete:
summary: Delete my avatar summary: Delete my avatar
@ -1381,6 +1427,7 @@ paths:
responses: responses:
'200': '200':
description: successful operation description: successful operation
'/videos/ownership/{id}/accept': '/videos/ownership/{id}/accept':
post: post:
summary: Accept ownership change request summary: Accept ownership change request
@ -1397,6 +1444,7 @@ paths:
description: cannot terminate an ownership change of another user description: cannot terminate an ownership change of another user
'404': '404':
description: video owneship change not found description: video owneship change not found
'/videos/ownership/{id}/refuse': '/videos/ownership/{id}/refuse':
post: post:
summary: Refuse ownership change request summary: Refuse ownership change request
@ -1413,6 +1461,7 @@ paths:
description: cannot terminate an ownership change of another user description: cannot terminate an ownership change of another user
'404': '404':
description: video owneship change not found description: video owneship change not found
'/videos/{id}/give-ownership': '/videos/{id}/give-ownership':
post: post:
summary: Request ownership change summary: Request ownership change
@ -1440,6 +1489,7 @@ paths:
description: changing video ownership to a remote account is not supported yet description: changing video ownership to a remote account is not supported yet
'404': '404':
description: video not found description: video not found
/videos: /videos:
get: get:
summary: List videos summary: List videos
@ -1465,6 +1515,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/VideoListResponse' $ref: '#/components/schemas/VideoListResponse'
/videos/categories: /videos/categories:
get: get:
summary: List available video categories summary: List available video categories
@ -1483,6 +1534,7 @@ paths:
examples: examples:
nightly: nightly:
externalValue: https://peertube2.cpy.re/api/v1/videos/categories externalValue: https://peertube2.cpy.re/api/v1/videos/categories
/videos/licences: /videos/licences:
get: get:
summary: List available video licences summary: List available video licences
@ -1501,6 +1553,7 @@ paths:
examples: examples:
nightly: nightly:
externalValue: https://peertube2.cpy.re/api/v1/videos/licences externalValue: https://peertube2.cpy.re/api/v1/videos/licences
/videos/languages: /videos/languages:
get: get:
summary: List available video languages summary: List available video languages
@ -1519,6 +1572,7 @@ paths:
examples: examples:
nightly: nightly:
externalValue: https://peertube2.cpy.re/api/v1/videos/languages externalValue: https://peertube2.cpy.re/api/v1/videos/languages
/videos/privacies: /videos/privacies:
get: get:
summary: List available video privacy policies summary: List available video privacy policies
@ -1537,9 +1591,11 @@ paths:
examples: examples:
nightly: nightly:
externalValue: https://peertube2.cpy.re/api/v1/videos/privacies externalValue: https://peertube2.cpy.re/api/v1/videos/privacies
'/videos/{id}': '/videos/{id}':
put: put:
summary: Update a video summary: Update a video
operationId: putVideo
security: security:
- OAuth2: [] - OAuth2: []
tags: tags:
@ -1614,6 +1670,7 @@ paths:
contentType: image/jpeg contentType: image/jpeg
get: get:
summary: Get a video summary: Get a video
operationId: getVideo
tags: tags:
- Video - Video
parameters: parameters:
@ -1627,6 +1684,7 @@ paths:
$ref: '#/components/schemas/VideoDetails' $ref: '#/components/schemas/VideoDetails'
delete: delete:
summary: Delete a video summary: Delete a video
operationId: delVideo
security: security:
- OAuth2: [] - OAuth2: []
tags: tags:
@ -1636,9 +1694,11 @@ paths:
responses: responses:
'204': '204':
description: successful operation description: successful operation
'/videos/{id}/description': '/videos/{id}/description':
get: get:
summary: Get complete video description summary: Get complete video description
operationId: getVideoDesc
tags: tags:
- Video - Video
parameters: parameters:
@ -1655,6 +1715,7 @@ paths:
maxLength: 10000 maxLength: 10000
example: | 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)** **[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)**
'/videos/{id}/views': '/videos/{id}/views':
post: post:
summary: Add a view to a video summary: Add a view to a video
@ -1665,6 +1726,7 @@ paths:
responses: responses:
'204': '204':
description: successful operation description: successful operation
'/videos/{id}/watching': '/videos/{id}/watching':
put: put:
summary: Set watching progress of a video summary: Set watching progress of a video
@ -1683,6 +1745,7 @@ paths:
responses: responses:
'204': '204':
description: successful operation description: successful operation
/videos/upload: /videos/upload:
post: post:
summary: Upload a video summary: Upload a video
@ -1759,6 +1822,7 @@ paths:
--form videofile=@"$FILE_PATH" \ --form videofile=@"$FILE_PATH" \
--form channelId=$CHANNEL_ID \ --form channelId=$CHANNEL_ID \
--form name="$NAME" --form name="$NAME"
/videos/upload-resumable: /videos/upload-resumable:
post: post:
summary: Initialize the resumable upload of a video summary: Initialize the resumable upload of a video
@ -1920,6 +1984,7 @@ paths:
schema: schema:
type: number type: number
example: 0 example: 0
/videos/imports: /videos/imports:
post: post:
summary: Import a video summary: Import a video
@ -2207,7 +2272,6 @@ paths:
type: array type: array
items: items:
$ref: '#/components/schemas/Abuse' $ref: '#/components/schemas/Abuse'
post: post:
summary: Report an abuse summary: Report an abuse
security: security:
@ -2275,6 +2339,7 @@ paths:
$ref: '#/components/schemas/id' $ref: '#/components/schemas/id'
'400': '400':
description: incorrect request parameters description: incorrect request parameters
'/abuses/{abuseId}': '/abuses/{abuseId}':
put: put:
summary: Update an abuse summary: Update an abuse
@ -2319,6 +2384,7 @@ paths:
description: successful operation description: successful operation
'404': '404':
description: block not found description: block not found
'/abuses/{abuseId}/messages': '/abuses/{abuseId}/messages':
get: get:
summary: List messages of an abuse summary: List messages of an abuse
@ -2343,7 +2409,6 @@ paths:
type: array type: array
items: items:
$ref: '#/components/schemas/AbuseMessage' $ref: '#/components/schemas/AbuseMessage'
post: post:
summary: Add message to an abuse summary: Add message to an abuse
security: security:
@ -2371,6 +2436,7 @@ paths:
description: successful operation description: successful operation
'400': '400':
description: incorrect request parameters description: incorrect request parameters
'/abuses/{abuseId}/messages/{abuseMessageId}': '/abuses/{abuseId}/messages/{abuseMessageId}':
delete: delete:
summary: Delete an abuse message summary: Delete an abuse message
@ -2388,6 +2454,7 @@ paths:
'/videos/{id}/blacklist': '/videos/{id}/blacklist':
post: post:
summary: Block a video summary: Block a video
operationId: addVideoBlock
security: security:
- OAuth2: - OAuth2:
- admin - admin
@ -2401,6 +2468,7 @@ paths:
description: successful operation description: successful operation
delete: delete:
summary: Unblock a video by its id summary: Unblock a video by its id
operationId: delVideoBlock
security: security:
- OAuth2: - OAuth2:
- admin - admin
@ -2414,11 +2482,13 @@ paths:
description: successful operation description: successful operation
'404': '404':
description: block not found description: block not found
/videos/blacklist: /videos/blacklist:
get: get:
tags: tags:
- Video Blocks - Video Blocks
summary: List video blocks summary: List video blocks
operationId: getVideoBlocks
security: security:
- OAuth2: - OAuth2:
- admin - admin
@ -2460,9 +2530,11 @@ paths:
type: array type: array
items: items:
$ref: '#/components/schemas/VideoBlacklist' $ref: '#/components/schemas/VideoBlacklist'
/videos/{id}/captions: /videos/{id}/captions:
get: get:
summary: List captions of a video summary: List captions of a video
operationId: getVideoCaptions
tags: tags:
- Video Captions - Video Captions
parameters: parameters:
@ -2482,9 +2554,11 @@ paths:
type: array type: array
items: items:
$ref: '#/components/schemas/VideoCaption' $ref: '#/components/schemas/VideoCaption'
/videos/{id}/captions/{captionLanguage}: /videos/{id}/captions/{captionLanguage}:
put: put:
summary: Add or replace a video caption summary: Add or replace a video caption
operationId: addVideoCaption
security: security:
- OAuth2: - OAuth2:
- user - user
@ -2513,6 +2587,7 @@ paths:
description: video or language not found description: video or language not found
delete: delete:
summary: Delete a video caption summary: Delete a video caption
operationId: delVideoCaption
security: security:
- OAuth2: - OAuth2:
- user - user
@ -2526,6 +2601,7 @@ paths:
description: successful operation description: successful operation
'404': '404':
description: video or language or caption for that language not found description: video or language or caption for that language not found
/video-channels: /video-channels:
get: get:
summary: List video channels summary: List video channels
@ -2545,7 +2621,7 @@ paths:
$ref: '#/components/schemas/VideoChannelList' $ref: '#/components/schemas/VideoChannelList'
post: post:
summary: Create a video channel summary: Create a video channel
operationId: createVideoChannel operationId: addVideoChannel
security: security:
- OAuth2: [] - OAuth2: []
tags: tags:
@ -2568,6 +2644,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/VideoChannelCreate' $ref: '#/components/schemas/VideoChannelCreate'
'/video-channels/{channelHandle}': '/video-channels/{channelHandle}':
get: get:
summary: Get a video channel summary: Get a video channel
@ -2585,6 +2662,7 @@ paths:
$ref: '#/components/schemas/VideoChannel' $ref: '#/components/schemas/VideoChannel'
put: put:
summary: Update a video channel summary: Update a video channel
operationId: putVideoChannel
security: security:
- OAuth2: [] - OAuth2: []
tags: tags:
@ -2601,6 +2679,7 @@ paths:
$ref: '#/components/schemas/VideoChannelUpdate' $ref: '#/components/schemas/VideoChannelUpdate'
delete: delete:
summary: Delete a video channel summary: Delete a video channel
operationId: delVideoChannel
security: security:
- OAuth2: [] - OAuth2: []
tags: tags:
@ -2610,9 +2689,11 @@ paths:
responses: responses:
'204': '204':
description: successful operation description: successful operation
'/video-channels/{channelHandle}/videos': '/video-channels/{channelHandle}/videos':
get: get:
summary: List videos of a video channel summary: List videos of a video channel
operationId: getVideoChannelVideos
tags: tags:
- Video - Video
- Video Channels - Video Channels
@ -2637,6 +2718,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/VideoListResponse' $ref: '#/components/schemas/VideoListResponse'
'/video-channels/{channelHandle}/avatar/pick': '/video-channels/{channelHandle}/avatar/pick':
post: post:
summary: Update channel avatar summary: Update channel avatar
@ -2677,6 +2759,7 @@ paths:
encoding: encoding:
avatarfile: avatarfile:
contentType: image/png, image/jpeg contentType: image/png, image/jpeg
'/video-channels/{channelHandle}/avatar': '/video-channels/{channelHandle}/avatar':
delete: delete:
summary: Delete channel avatar summary: Delete channel avatar
@ -2690,7 +2773,6 @@ paths:
'204': '204':
description: successful operation description: successful operation
'/video-channels/{channelHandle}/banner/pick': '/video-channels/{channelHandle}/banner/pick':
post: post:
summary: Update channel banner summary: Update channel banner
@ -2731,6 +2813,7 @@ paths:
encoding: encoding:
bannerfile: bannerfile:
contentType: image/png, image/jpeg contentType: image/png, image/jpeg
'/video-channels/{channelHandle}/banner': '/video-channels/{channelHandle}/banner':
delete: delete:
summary: Delete channel banner summary: Delete channel banner
@ -3105,6 +3188,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/VideoChannelList' $ref: '#/components/schemas/VideoChannelList'
'/accounts/{name}/ratings': '/accounts/{name}/ratings':
get: get:
summary: List ratings of an account summary: List ratings of an account
@ -3135,6 +3219,7 @@ paths:
type: array type: array
items: items:
$ref: '#/components/schemas/VideoRating' $ref: '#/components/schemas/VideoRating'
'/videos/{id}/comment-threads': '/videos/{id}/comment-threads':
get: get:
summary: List threads of a video summary: List threads of a video
@ -3198,6 +3283,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/VideoCommentThreadTree' $ref: '#/components/schemas/VideoCommentThreadTree'
'/videos/{id}/comments/{commentId}': '/videos/{id}/comments/{commentId}':
post: post:
summary: Reply to a thread of a video summary: Reply to a thread of a video
@ -3230,7 +3316,6 @@ paths:
maxLength: 10000 maxLength: 10000
required: required:
- text - text
delete: delete:
summary: Delete a comment or a reply summary: Delete a comment or a reply
security: security:
@ -3249,6 +3334,7 @@ paths:
description: comment or video does not exist description: comment or video does not exist
'409': '409':
description: comment is already deleted description: comment is already deleted
'/videos/{id}/rate': '/videos/{id}/rate':
put: put:
summary: Like/dislike a video summary: Like/dislike a video
@ -3276,6 +3362,7 @@ paths:
description: successful operation description: successful operation
'404': '404':
description: video does not exist description: video does not exist
/search/videos: /search/videos:
get: get:
tags: tags:
@ -3351,6 +3438,7 @@ paths:
$ref: '#/components/schemas/VideoListResponse' $ref: '#/components/schemas/VideoListResponse'
'500': '500':
description: search index unavailable description: search index unavailable
/search/video-channels: /search/video-channels:
get: get:
tags: tags:
@ -3422,6 +3510,7 @@ paths:
description: successful operation description: successful operation
'409': '409':
description: self-blocking forbidden description: self-blocking forbidden
'/server/blocklist/accounts/{accountName}': '/server/blocklist/accounts/{accountName}':
delete: delete:
tags: tags:
@ -3482,6 +3571,7 @@ paths:
description: successful operation description: successful operation
'409': '409':
description: self-blocking forbidden description: self-blocking forbidden
'/server/blocklist/servers/{host}': '/server/blocklist/servers/{host}':
delete: delete:
tags: tags:
@ -3536,6 +3626,7 @@ paths:
description: successful operation description: successful operation
'404': '404':
description: server is not already known description: server is not already known
/server/redundancy/videos: /server/redundancy/videos:
get: get:
tags: tags:
@ -3592,6 +3683,7 @@ paths:
description: video does not exist description: video does not exist
'409': '409':
description: video is already mirrored description: video is already mirrored
/server/redundancy/videos/{redundancyId}: /server/redundancy/videos/{redundancyId}:
delete: delete:
tags: tags:
@ -3706,6 +3798,7 @@ paths:
description: video, video channel or account not found description: video, video channel or account not found
'406': '406':
description: accept header unsupported description: accept header unsupported
'/feeds/videos.{format}': '/feeds/videos.{format}':
get: get:
tags: tags:
@ -3792,6 +3885,7 @@ paths:
description: video channel or account not found description: video channel or account not found
'406': '406':
description: accept header unsupported description: accept header unsupported
'/feeds/subscriptions.{format}': '/feeds/subscriptions.{format}':
get: get:
tags: tags:
@ -3854,6 +3948,7 @@ paths:
type: object type: object
'406': '406':
description: accept header unsupported description: accept header unsupported
/plugins: /plugins:
get: get:
tags: tags:
@ -3881,6 +3976,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/PluginResponse' $ref: '#/components/schemas/PluginResponse'
/plugins/available: /plugins/available:
get: get:
tags: tags:
@ -3914,6 +4010,7 @@ paths:
$ref: '#/components/schemas/PluginResponse' $ref: '#/components/schemas/PluginResponse'
'503': '503':
description: plugin index unavailable description: plugin index unavailable
/plugins/install: /plugins/install:
post: post:
tags: tags:
@ -3947,6 +4044,7 @@ paths:
description: successful operation description: successful operation
'400': '400':
description: should have either `npmName` or `path` set description: should have either `npmName` or `path` set
/plugins/update: /plugins/update:
post: post:
tags: tags:
@ -3982,6 +4080,7 @@ paths:
description: should have either `npmName` or `path` set description: should have either `npmName` or `path` set
'404': '404':
description: existing plugin not found description: existing plugin not found
/plugins/uninstall: /plugins/uninstall:
post: post:
tags: tags:
@ -4007,6 +4106,7 @@ paths:
description: successful operation description: successful operation
'404': '404':
description: existing plugin not found description: existing plugin not found
/plugins/{npmName}: /plugins/{npmName}:
get: get:
tags: tags:
@ -4026,6 +4126,7 @@ paths:
$ref: '#/components/schemas/Plugin' $ref: '#/components/schemas/Plugin'
'404': '404':
description: plugin not found description: plugin not found
/plugins/{npmName}/settings: /plugins/{npmName}/settings:
put: put:
tags: tags:
@ -4050,6 +4151,7 @@ paths:
description: successful operation description: successful operation
'404': '404':
description: plugin not found description: plugin not found
/plugins/{npmName}/public-settings: /plugins/{npmName}/public-settings:
get: get:
tags: tags:
@ -4067,6 +4169,7 @@ paths:
additionalProperties: true additionalProperties: true
'404': '404':
description: plugin not found description: plugin not found
/plugins/{npmName}/registered-settings: /plugins/{npmName}/registered-settings:
get: get:
tags: tags:
@ -4087,6 +4190,7 @@ paths:
additionalProperties: true additionalProperties: true
'404': '404':
description: plugin not found description: plugin not found
servers: servers:
- url: 'https://peertube2.cpy.re/api/v1' - url: 'https://peertube2.cpy.re/api/v1'
description: Live Test Server (live data - latest nightly version) description: Live Test Server (live data - latest nightly version)