diff options
Diffstat (limited to 'support/doc/api')
-rw-r--r-- | support/doc/api/openapi.yaml | 36 |
1 files changed, 30 insertions, 6 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 4230fc827..cd50e86a6 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -433,7 +433,7 @@ paths: | |||
433 | get: | 433 | get: |
434 | tags: | 434 | tags: |
435 | - Video Feeds | 435 | - Video Feeds |
436 | summary: List comments on videos | 436 | summary: Comments on videos feeds |
437 | operationId: getSyndicatedComments | 437 | operationId: getSyndicatedComments |
438 | parameters: | 438 | parameters: |
439 | - name: format | 439 | - name: format |
@@ -476,7 +476,7 @@ paths: | |||
476 | schema: | 476 | schema: |
477 | type: string | 477 | type: string |
478 | responses: | 478 | responses: |
479 | '204': | 479 | '200': |
480 | description: successful operation | 480 | description: successful operation |
481 | headers: | 481 | headers: |
482 | Cache-Control: | 482 | Cache-Control: |
@@ -528,7 +528,7 @@ paths: | |||
528 | get: | 528 | get: |
529 | tags: | 529 | tags: |
530 | - Video Feeds | 530 | - Video Feeds |
531 | summary: List videos | 531 | summary: Common videos feeds |
532 | operationId: getSyndicatedVideos | 532 | operationId: getSyndicatedVideos |
533 | parameters: | 533 | parameters: |
534 | - name: format | 534 | - name: format |
@@ -573,7 +573,7 @@ paths: | |||
573 | - $ref: '#/components/parameters/hasHLSFiles' | 573 | - $ref: '#/components/parameters/hasHLSFiles' |
574 | - $ref: '#/components/parameters/hasWebtorrentFiles' | 574 | - $ref: '#/components/parameters/hasWebtorrentFiles' |
575 | responses: | 575 | responses: |
576 | '204': | 576 | '200': |
577 | description: successful operation | 577 | description: successful operation |
578 | headers: | 578 | headers: |
579 | Cache-Control: | 579 | Cache-Control: |
@@ -620,7 +620,7 @@ paths: | |||
620 | get: | 620 | get: |
621 | tags: | 621 | tags: |
622 | - Video Feeds | 622 | - Video Feeds |
623 | summary: List videos of subscriptions tied to a token | 623 | summary: Videos of subscriptions feeds |
624 | operationId: getSyndicatedSubscriptionVideos | 624 | operationId: getSyndicatedSubscriptionVideos |
625 | parameters: | 625 | parameters: |
626 | - name: format | 626 | - name: format |
@@ -657,7 +657,7 @@ paths: | |||
657 | - $ref: '#/components/parameters/hasHLSFiles' | 657 | - $ref: '#/components/parameters/hasHLSFiles' |
658 | - $ref: '#/components/parameters/hasWebtorrentFiles' | 658 | - $ref: '#/components/parameters/hasWebtorrentFiles' |
659 | responses: | 659 | responses: |
660 | '204': | 660 | '200': |
661 | description: successful operation | 661 | description: successful operation |
662 | headers: | 662 | headers: |
663 | Cache-Control: | 663 | Cache-Control: |
@@ -683,6 +683,30 @@ paths: | |||
683 | '406': | 683 | '406': |
684 | description: accept header unsupported | 684 | description: accept header unsupported |
685 | 685 | ||
686 | '/feeds/podcast/videos.xml': | ||
687 | get: | ||
688 | tags: | ||
689 | - Video Feeds | ||
690 | summary: Videos podcast feed | ||
691 | operationId: getVideosPodcastFeed | ||
692 | parameters: | ||
693 | - name: videoChannelId | ||
694 | in: query | ||
695 | description: 'Limit listing to a specific video channel' | ||
696 | required: true | ||
697 | schema: | ||
698 | type: string | ||
699 | responses: | ||
700 | '200': | ||
701 | description: successful operation | ||
702 | headers: | ||
703 | Cache-Control: | ||
704 | schema: | ||
705 | type: string | ||
706 | default: 'max-age=900' # 15 min cache | ||
707 | '404': | ||
708 | description: video channel not found | ||
709 | |||
686 | '/api/v1/accounts/{name}': | 710 | '/api/v1/accounts/{name}': |
687 | get: | 711 | get: |
688 | tags: | 712 | tags: |