diff options
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/openapi.yaml | 103 |
1 files changed, 89 insertions, 14 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 24a9eb9c2..e448bc1c9 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -3190,13 +3190,6 @@ paths: | |||
3190 | tags: | 3190 | tags: |
3191 | - Feeds | 3191 | - Feeds |
3192 | summary: List comments on videos | 3192 | summary: List comments on videos |
3193 | servers: | ||
3194 | - url: 'https://peertube2.cpy.re' | ||
3195 | description: Live Test Server (live data - latest nightly version) | ||
3196 | - url: 'https://peertube3.cpy.re' | ||
3197 | description: Live Test Server (live data - latest RC version) | ||
3198 | - url: 'https://peertube.cpy.re' | ||
3199 | description: Live Test Server (live data - stable version) | ||
3200 | parameters: | 3193 | parameters: |
3201 | - name: format | 3194 | - name: format |
3202 | in: path | 3195 | in: path |
@@ -3249,18 +3242,33 @@ paths: | |||
3249 | application/xml: | 3242 | application/xml: |
3250 | schema: | 3243 | schema: |
3251 | $ref: '#/components/schemas/VideoCommentsForXML' | 3244 | $ref: '#/components/schemas/VideoCommentsForXML' |
3245 | examples: | ||
3246 | nightly: | ||
3247 | externalValue: https://peertube2.cpy.re/feeds/video-comments.xml?filter=local | ||
3252 | application/rss+xml: | 3248 | application/rss+xml: |
3253 | schema: | 3249 | schema: |
3254 | $ref: '#/components/schemas/VideoCommentsForXML' | 3250 | $ref: '#/components/schemas/VideoCommentsForXML' |
3251 | examples: | ||
3252 | nightly: | ||
3253 | externalValue: https://peertube2.cpy.re/feeds/video-comments.rss?filter=local | ||
3255 | text/xml: | 3254 | text/xml: |
3256 | schema: | 3255 | schema: |
3257 | $ref: '#/components/schemas/VideoCommentsForXML' | 3256 | $ref: '#/components/schemas/VideoCommentsForXML' |
3257 | examples: | ||
3258 | nightly: | ||
3259 | externalValue: https://peertube2.cpy.re/feeds/video-comments.xml?filter=local | ||
3258 | application/atom+xml: | 3260 | application/atom+xml: |
3259 | schema: | 3261 | schema: |
3260 | $ref: '#/components/schemas/VideoCommentsForXML' | 3262 | $ref: '#/components/schemas/VideoCommentsForXML' |
3263 | examples: | ||
3264 | nightly: | ||
3265 | externalValue: https://peertube2.cpy.re/feeds/video-comments.atom?filter=local | ||
3261 | application/json: | 3266 | application/json: |
3262 | schema: | 3267 | schema: |
3263 | type: object | 3268 | type: object |
3269 | examples: | ||
3270 | nightly: | ||
3271 | externalValue: https://peertube2.cpy.re/feeds/video-comments.json?filter=local | ||
3264 | '400': | 3272 | '400': |
3265 | x-summary: field inconsistencies | 3273 | x-summary: field inconsistencies |
3266 | description: > | 3274 | description: > |
@@ -3275,13 +3283,6 @@ paths: | |||
3275 | tags: | 3283 | tags: |
3276 | - Feeds | 3284 | - Feeds |
3277 | summary: List videos | 3285 | summary: List videos |
3278 | servers: | ||
3279 | - url: 'https://peertube2.cpy.re' | ||
3280 | description: Live Test Server (live data - latest nightly version) | ||
3281 | - url: 'https://peertube3.cpy.re' | ||
3282 | description: Live Test Server (live data - latest RC version) | ||
3283 | - url: 'https://peertube.cpy.re' | ||
3284 | description: Live Test Server (live data - stable version) | ||
3285 | parameters: | 3286 | parameters: |
3286 | - name: format | 3287 | - name: format |
3287 | in: path | 3288 | in: path |
@@ -3338,19 +3339,93 @@ paths: | |||
3338 | application/rss+xml: | 3339 | application/rss+xml: |
3339 | schema: | 3340 | schema: |
3340 | $ref: '#/components/schemas/VideosForXML' | 3341 | $ref: '#/components/schemas/VideosForXML' |
3342 | examples: | ||
3343 | nightly: | ||
3344 | externalValue: https://peertube2.cpy.re/feeds/videos.rss?filter=local | ||
3341 | text/xml: | 3345 | text/xml: |
3342 | schema: | 3346 | schema: |
3343 | $ref: '#/components/schemas/VideosForXML' | 3347 | $ref: '#/components/schemas/VideosForXML' |
3348 | examples: | ||
3349 | nightly: | ||
3350 | externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local | ||
3344 | application/atom+xml: | 3351 | application/atom+xml: |
3345 | schema: | 3352 | schema: |
3346 | $ref: '#/components/schemas/VideosForXML' | 3353 | $ref: '#/components/schemas/VideosForXML' |
3354 | examples: | ||
3355 | nightly: | ||
3356 | externalValue: https://peertube2.cpy.re/feeds/videos.atom?filter=local | ||
3347 | application/json: | 3357 | application/json: |
3348 | schema: | 3358 | schema: |
3349 | type: object | 3359 | type: object |
3360 | examples: | ||
3361 | nightly: | ||
3362 | externalValue: https://peertube2.cpy.re/feeds/videos.json?filter=local | ||
3350 | '404': | 3363 | '404': |
3351 | description: video channel or account not found | 3364 | description: video channel or account not found |
3352 | '406': | 3365 | '406': |
3353 | description: accept header unsupported | 3366 | description: accept header unsupported |
3367 | '/feeds/subscriptions.{format}': | ||
3368 | get: | ||
3369 | tags: | ||
3370 | - Feeds | ||
3371 | - Account | ||
3372 | summary: List videos of subscriptions tied to a token | ||
3373 | parameters: | ||
3374 | - name: format | ||
3375 | in: path | ||
3376 | required: true | ||
3377 | description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))' | ||
3378 | schema: | ||
3379 | type: string | ||
3380 | enum: | ||
3381 | - xml | ||
3382 | - rss | ||
3383 | - rss2 | ||
3384 | - atom | ||
3385 | - atom1 | ||
3386 | - json | ||
3387 | - json1 | ||
3388 | - name: accountId | ||
3389 | in: query | ||
3390 | description: limit listing to a specific account | ||
3391 | schema: | ||
3392 | type: string | ||
3393 | required: true | ||
3394 | - name: token | ||
3395 | in: query | ||
3396 | description: private token allowing access | ||
3397 | schema: | ||
3398 | type: string | ||
3399 | required: true | ||
3400 | - $ref: '#/components/parameters/sort' | ||
3401 | - $ref: '#/components/parameters/nsfw' | ||
3402 | - $ref: '#/components/parameters/filter' | ||
3403 | responses: | ||
3404 | '204': | ||
3405 | description: successful operation | ||
3406 | headers: | ||
3407 | Cache-Control: | ||
3408 | schema: | ||
3409 | type: string | ||
3410 | default: 'max-age=900' # 15 min cache | ||
3411 | content: | ||
3412 | application/xml: | ||
3413 | schema: | ||
3414 | $ref: '#/components/schemas/VideosForXML' | ||
3415 | application/rss+xml: | ||
3416 | schema: | ||
3417 | $ref: '#/components/schemas/VideosForXML' | ||
3418 | text/xml: | ||
3419 | schema: | ||
3420 | $ref: '#/components/schemas/VideosForXML' | ||
3421 | application/atom+xml: | ||
3422 | schema: | ||
3423 | $ref: '#/components/schemas/VideosForXML' | ||
3424 | application/json: | ||
3425 | schema: | ||
3426 | type: object | ||
3427 | '406': | ||
3428 | description: accept header unsupported | ||
3354 | /plugins: | 3429 | /plugins: |
3355 | get: | 3430 | get: |
3356 | tags: | 3431 | tags: |