diff options
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/openapi.yaml | 71 |
1 files changed, 68 insertions, 3 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 8d85f9c77..e3931a36e 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -257,6 +257,8 @@ tags: | |||
257 | description: Operations dealing with synchronizing PeerTube user's channel with channels of other platforms | 257 | description: Operations dealing with synchronizing PeerTube user's channel with channels of other platforms |
258 | - name: Video Captions | 258 | - name: Video Captions |
259 | description: Operations dealing with listing, adding and removing closed captions of a video. | 259 | description: Operations dealing with listing, adding and removing closed captions of a video. |
260 | - name: Video Chapters | ||
261 | description: Operations dealing with managing chapters of a video. | ||
260 | - name: Video Channels | 262 | - name: Video Channels |
261 | description: Operations dealing with the creation, modification and listing of videos within a channel. | 263 | description: Operations dealing with the creation, modification and listing of videos within a channel. |
262 | - name: Video Comments | 264 | - name: Video Comments |
@@ -328,6 +330,7 @@ x-tagGroups: | |||
328 | - Video Upload | 330 | - Video Upload |
329 | - Video Imports | 331 | - Video Imports |
330 | - Video Captions | 332 | - Video Captions |
333 | - Video Chapters | ||
331 | - Video Channels | 334 | - Video Channels |
332 | - Video Comments | 335 | - Video Comments |
333 | - Video Rates | 336 | - Video Rates |
@@ -3242,7 +3245,7 @@ paths: | |||
3242 | '/api/v1/videos/{id}/source/replace-resumable': | 3245 | '/api/v1/videos/{id}/source/replace-resumable': |
3243 | post: | 3246 | post: |
3244 | summary: Initialize the resumable replacement of a video | 3247 | summary: Initialize the resumable replacement of a video |
3245 | description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to initialize the replacement of a video | 3248 | description: "**PeerTube >= 6.0** Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to initialize the replacement of a video" |
3246 | operationId: replaceVideoSourceResumableInit | 3249 | operationId: replaceVideoSourceResumableInit |
3247 | security: | 3250 | security: |
3248 | - OAuth2: [] | 3251 | - OAuth2: [] |
@@ -3281,7 +3284,7 @@ paths: | |||
3281 | description: video type unsupported | 3284 | description: video type unsupported |
3282 | put: | 3285 | put: |
3283 | summary: Send chunk for the resumable replacement of a video | 3286 | summary: Send chunk for the resumable replacement of a video |
3284 | description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to continue, pause or resume the replacement of a video | 3287 | description: "**PeerTube >= 6.0** Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to continue, pause or resume the replacement of a video" |
3285 | operationId: replaceVideoSourceResumable | 3288 | operationId: replaceVideoSourceResumable |
3286 | security: | 3289 | security: |
3287 | - OAuth2: [] | 3290 | - OAuth2: [] |
@@ -3331,7 +3334,7 @@ paths: | |||
3331 | example: 300 | 3334 | example: 300 |
3332 | delete: | 3335 | delete: |
3333 | summary: Cancel the resumable replacement of a video | 3336 | summary: Cancel the resumable replacement of a video |
3334 | description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the replacement of a video | 3337 | description: "**PeerTube >= 6.0** Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the replacement of a video" |
3335 | operationId: replaceVideoSourceResumableCancel | 3338 | operationId: replaceVideoSourceResumableCancel |
3336 | security: | 3339 | security: |
3337 | - OAuth2: [] | 3340 | - OAuth2: [] |
@@ -3742,6 +3745,7 @@ paths: | |||
3742 | /api/v1/videos/{id}/storyboards: | 3745 | /api/v1/videos/{id}/storyboards: |
3743 | get: | 3746 | get: |
3744 | summary: List storyboards of a video | 3747 | summary: List storyboards of a video |
3748 | description: "**PeerTube** >= 6.0" | ||
3745 | operationId: listVideoStoryboards | 3749 | operationId: listVideoStoryboards |
3746 | tags: | 3750 | tags: |
3747 | - Video | 3751 | - Video |
@@ -3832,9 +3836,59 @@ paths: | |||
3832 | '404': | 3836 | '404': |
3833 | description: video or language or caption for that language not found | 3837 | description: video or language or caption for that language not found |
3834 | 3838 | ||
3839 | /api/v1/videos/{id}/chapters: | ||
3840 | get: | ||
3841 | summary: Get chapters of a video | ||
3842 | description: "**PeerTube** >= 6.0" | ||
3843 | operationId: getVideoChapters | ||
3844 | tags: | ||
3845 | - Video Chapters | ||
3846 | parameters: | ||
3847 | - $ref: '#/components/parameters/idOrUUID' | ||
3848 | - $ref: '#/components/parameters/videoPasswordHeader' | ||
3849 | responses: | ||
3850 | '200': | ||
3851 | description: successful operation | ||
3852 | content: | ||
3853 | application/json: | ||
3854 | schema: | ||
3855 | $ref: '#/components/schemas/VideoChapters' | ||
3856 | put: | ||
3857 | summary: Replace video chapters | ||
3858 | description: "**PeerTube** >= 6.0" | ||
3859 | operationId: replaceVideoChapters | ||
3860 | security: | ||
3861 | - OAuth2: | ||
3862 | - user | ||
3863 | tags: | ||
3864 | - Video Chapters | ||
3865 | parameters: | ||
3866 | - $ref: '#/components/parameters/idOrUUID' | ||
3867 | requestBody: | ||
3868 | content: | ||
3869 | application/json: | ||
3870 | schema: | ||
3871 | type: object | ||
3872 | properties: | ||
3873 | chapters: | ||
3874 | type: array | ||
3875 | items: | ||
3876 | type: object | ||
3877 | properties: | ||
3878 | title: | ||
3879 | type: string | ||
3880 | timecode: | ||
3881 | type: integer | ||
3882 | responses: | ||
3883 | '204': | ||
3884 | description: successful operation | ||
3885 | '404': | ||
3886 | description: video not found | ||
3887 | |||
3835 | /api/v1/videos/{id}/passwords: | 3888 | /api/v1/videos/{id}/passwords: |
3836 | get: | 3889 | get: |
3837 | summary: List video passwords | 3890 | summary: List video passwords |
3891 | description: "**PeerTube** >= 6.0" | ||
3838 | security: | 3892 | security: |
3839 | - OAuth2: | 3893 | - OAuth2: |
3840 | - user | 3894 | - user |
@@ -3856,6 +3910,7 @@ paths: | |||
3856 | description: video is not password protected | 3910 | description: video is not password protected |
3857 | put: | 3911 | put: |
3858 | summary: Update video passwords | 3912 | summary: Update video passwords |
3913 | description: "**PeerTube** >= 6.0" | ||
3859 | security: | 3914 | security: |
3860 | - OAuth2: | 3915 | - OAuth2: |
3861 | - user | 3916 | - user |
@@ -3880,6 +3935,7 @@ paths: | |||
3880 | /api/v1/videos/{id}/passwords/{videoPasswordId}: | 3935 | /api/v1/videos/{id}/passwords/{videoPasswordId}: |
3881 | delete: | 3936 | delete: |
3882 | summary: Delete a video password | 3937 | summary: Delete a video password |
3938 | description: "**PeerTube** >= 6.0" | ||
3883 | security: | 3939 | security: |
3884 | - OAuth2: | 3940 | - OAuth2: |
3885 | - user | 3941 | - user |
@@ -7704,6 +7760,15 @@ components: | |||
7704 | $ref: '#/components/schemas/VideoConstantString-Language' | 7760 | $ref: '#/components/schemas/VideoConstantString-Language' |
7705 | captionPath: | 7761 | captionPath: |
7706 | type: string | 7762 | type: string |
7763 | VideoChapters: | ||
7764 | properties: | ||
7765 | chapters: | ||
7766 | type: object | ||
7767 | properties: | ||
7768 | title: | ||
7769 | type: string | ||
7770 | timecode: | ||
7771 | type: integer | ||
7707 | VideoSource: | 7772 | VideoSource: |
7708 | properties: | 7773 | properties: |
7709 | filename: | 7774 | filename: |