aboutsummaryrefslogtreecommitdiffhomepage
path: root/support
diff options
context:
space:
mode:
Diffstat (limited to 'support')
-rw-r--r--support/doc/api/openapi.yaml59
1 files changed, 57 insertions, 2 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 5bf3f13cc..9e721be4b 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -252,6 +252,8 @@ tags:
252 252
253 The import function is practical when the desired video/audio is available online. It makes PeerTube 253 The import function is practical when the desired video/audio is available online. It makes PeerTube
254 download it for you, saving you as much bandwidth and avoiding any instability or limitation your network might have. 254 download it for you, saving you as much bandwidth and avoiding any instability or limitation your network might have.
255 - name: Video Imports
256 description: Operations dealing with listing, adding and removing video imports.
255 - name: Video Captions 257 - name: Video Captions
256 description: Operations dealing with listing, adding and removing closed captions of a video. 258 description: Operations dealing with listing, adding and removing closed captions of a video.
257 - name: Video Channels 259 - name: Video Channels
@@ -306,6 +308,7 @@ x-tagGroups:
306 tags: 308 tags:
307 - Video 309 - Video
308 - Video Upload 310 - Video Upload
311 - Video Imports
309 - Video Captions 312 - Video Captions
310 - Video Channels 313 - Video Channels
311 - Video Comments 314 - Video Comments
@@ -587,6 +590,30 @@ paths:
587 '204': 590 '204':
588 description: successful operation 591 description: successful operation
589 592
593 /jobs/pause:
594 post:
595 summary: Pause job queue
596 security:
597 - OAuth2:
598 - admin
599 tags:
600 - Job
601 responses:
602 '204':
603 description: successful operation
604
605 /jobs/resume:
606 post:
607 summary: Resume job queue
608 security:
609 - OAuth2:
610 - admin
611 tags:
612 - Job
613 responses:
614 '204':
615 description: successful operation
616
590 /jobs/{state}: 617 /jobs/{state}:
591 get: 618 get:
592 summary: List instance jobs 619 summary: List instance jobs
@@ -2166,7 +2193,7 @@ paths:
2166 security: 2193 security:
2167 - OAuth2: [] 2194 - OAuth2: []
2168 tags: 2195 tags:
2169 - Video 2196 - Video Imports
2170 - Video Upload 2197 - Video Upload
2171 requestBody: 2198 requestBody:
2172 content: 2199 content:
@@ -2194,6 +2221,34 @@ paths:
2194 '409': 2221 '409':
2195 description: HTTP or Torrent/magnetURI import not enabled 2222 description: HTTP or Torrent/magnetURI import not enabled
2196 2223
2224 /videos/imports/{id}/cancel:
2225 post:
2226 summary: Cancel video import
2227 description: Cancel a pending video import
2228 security:
2229 - OAuth2: []
2230 tags:
2231 - Video Imports
2232 parameters:
2233 - $ref: '#/components/parameters/id'
2234 responses:
2235 '204':
2236 description: successful operation
2237
2238 /videos/imports/{id}:
2239 delete:
2240 summary: Delete video import
2241 description: Delete ended video import
2242 security:
2243 - OAuth2: []
2244 tags:
2245 - Video Imports
2246 parameters:
2247 - $ref: '#/components/parameters/id'
2248 responses:
2249 '204':
2250 description: successful operation
2251
2197 /videos/live: 2252 /videos/live:
2198 post: 2253 post:
2199 summary: Create a live 2254 summary: Create a live
@@ -4767,7 +4822,7 @@ components:
4767 name: id 4822 name: id
4768 in: path 4823 in: path
4769 required: true 4824 required: true
4770 description: The user id 4825 description: Entity id
4771 schema: 4826 schema:
4772 $ref: '#/components/schemas/id' 4827 $ref: '#/components/schemas/id'
4773 idOrUUID: 4828 idOrUUID: