diff options
author | Alecks Gates <agates@mail.agates.io> | 2023-05-22 09:00:05 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-05-22 16:00:05 +0200 |
commit | cb0eda5602a21d1626a7face32de6153ed07b5f9 (patch) | |
tree | d6a7a4e31c7267c130871ac8e3beb42994271c20 /support/doc/api | |
parent | 3f0ceab06e5320f62f593c49daa30d963dbc36f9 (diff) | |
download | PeerTube-cb0eda5602a21d1626a7face32de6153ed07b5f9.tar.gz PeerTube-cb0eda5602a21d1626a7face32de6153ed07b5f9.tar.zst PeerTube-cb0eda5602a21d1626a7face32de6153ed07b5f9.zip |
Add Podcast RSS feeds (#5487)
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Add medium/socialInteract to podcast RSS feeds. Use HTML for description
* Change base production image to bullseye, install prosody in image
* Add liveItem and trackers to Podcast RSS feeds
Remove height from alternateEnclosure, replaced with title.
* Clear Podcast RSS feed cache when live streams start/end
* Upgrade to Node 16
* Refactor clearCacheRoute to use ApiCache
* Remove unnecessary type hint
* Update dockerfile to node 16, install python-is-python2
* Use new file paths for captions/playlists
* Fix legacy videos in RSS after migration to object storage
* Improve method of identifying non-fragmented mp4s in podcast RSS feeds
* Don't include fragmented MP4s in podcast RSS feeds
* Add experimental support for podcast:categories on the podcast RSS item
* Fix undefined category when no videos exist
Allows for empty feeds to exist (important for feeds that might only go live)
* Add support for podcast:locked -- user has to opt in to show their email
* Use comma for podcast:categories delimiter
* Make cache clearing async
* Fix merge, temporarily test with pfeed-podcast
* Syntax changes
* Add EXT_MIMETYPE constants for captions
* Update & fix tests, fix enclosure mimetypes, remove admin email
* Add test for podacst:socialInteract
* Add filters hooks for podcast customTags
* Remove showdown, updated to pfeed-podcast 6.1.2
* Add 'action:api.live-video.state.updated' hook
* Avoid assigning undefined category to podcast feeds
* Remove nvmrc
* Remove comment
* Remove unused podcast config
* Remove more unused podcast config
* Fix MChannelAccountDefault type hint missed in merge
* Remove extra line
* Re-add newline in config
* Fix lint errors for isEmailPublic
* Fix thumbnails in podcast feeds
* Requested changes based on review
* Provide podcast rss 2.0 only on video channels
* Misc cleanup for a less messy PR
* Lint fixes
* Remove pfeed-podcast
* Add peertube version to new hooks
* Don't use query include, remove TODO
* Remove film medium hack
* Clear podcast rss cache before video/channel update hooks
* Clear podcast rss cache before video uploaded/deleted hooks
* Refactor podcast feed cache clearing
* Set correct person name from video channel
* Styling
* Fix tests
---------
Co-authored-by: Chocobozzz <me@florianbigard.com>
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: |