diff options
author | Rigel Kent <sendmemail@rigelk.eu> | 2018-04-17 00:49:04 +0200 |
---|---|---|
committer | Rigel <sendmemail@rigelk.eu> | 2018-04-17 01:09:06 +0200 |
commit | 244e76a552ef05a5067134b1065d26dd89246d8c (patch) | |
tree | a15fcd52bce99797fc9366572fea62a7a44aaabe /support/doc/api/openapi.yaml | |
parent | c36d5a6b98056ef7fec3db43fbee880ee7332dcf (diff) | |
download | PeerTube-244e76a552ef05a5067134b1065d26dd89246d8c.tar.gz PeerTube-244e76a552ef05a5067134b1065d26dd89246d8c.tar.zst PeerTube-244e76a552ef05a5067134b1065d26dd89246d8c.zip |
feature: initial syndication feeds support
Provides rss 2.0, atom 1.0 and json 1.0 feeds for videos (instance and account-wide) on listings and video-watch views.
* still lacks redis caching
* still lacks lastBuildDate support
* still lacks channel-wide support
* still lacks semantic annotation (for licenses, NSFW warnings, etc.)
* still lacks love ( ˘ ³˘)
* RSS: has MRSS support for torrent lists!
* RSS: includes the first torrent in an enclosure
* JSON: lists all torrents in the 'attachments' object
* ATOM: lacking torrent listing support
Advances #23
Partial implementation for the accountId generation in the client, which will need a hotfix to add a way to get the proper account id.
Diffstat (limited to 'support/doc/api/openapi.yaml')
-rw-r--r-- | support/doc/api/openapi.yaml | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index c3efa512d..0729ac8ec 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -78,6 +78,38 @@ paths: | |||
78 | description: successful operation | 78 | description: successful operation |
79 | schema: | 79 | schema: |
80 | $ref: '#/definitions/ServerConfig' | 80 | $ref: '#/definitions/ServerConfig' |
81 | /feeds/videos.{format}: | ||
82 | get: | ||
83 | tags: | ||
84 | - Feeds | ||
85 | consumes: | ||
86 | - application/json | ||
87 | produces: | ||
88 | - application/json | ||
89 | parameters: | ||
90 | - name: format | ||
91 | in: path | ||
92 | required: true | ||
93 | type: string | ||
94 | enum: ['xml', 'atom' 'json'] | ||
95 | default: 'xml' | ||
96 | description: 'The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0' | ||
97 | - name: accountId | ||
98 | in: query | ||
99 | required: false | ||
100 | type: number | ||
101 | description: 'The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds' | ||
102 | - name: accountName | ||
103 | in: query | ||
104 | required: false | ||
105 | type: string | ||
106 | description: 'The name of the local account to filter to' | ||
107 | responses: | ||
108 | '200': | ||
109 | description: successful operation | ||
110 | content: | ||
111 | application/json: | ||
112 | application/xml: | ||
81 | /jobs: | 113 | /jobs: |
82 | get: | 114 | get: |
83 | security: | 115 | security: |