diff options
author | Frank Sträter <fstrater@beeldengeluid.nl> | 2019-09-18 14:31:16 +0200 |
---|---|---|
committer | Chocobozzz <chocobozzz@cpy.re> | 2019-09-18 15:24:33 +0200 |
commit | a1b572ea76687c0e347b7facaf2c77cda2533bdb (patch) | |
tree | f10bf9087b861b6ea9950954f682afcca44c75f6 /support/doc | |
parent | 8a08bc1ed57e50ca20fba2a9c34c9bb0e13501a1 (diff) | |
download | PeerTube-a1b572ea76687c0e347b7facaf2c77cda2533bdb.tar.gz PeerTube-a1b572ea76687c0e347b7facaf2c77cda2533bdb.tar.zst PeerTube-a1b572ea76687c0e347b7facaf2c77cda2533bdb.zip |
Remove feeds from API documentation
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/openapi.yaml | 45 |
1 files changed, 0 insertions, 45 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index b0473c7e7..3267e8b6a 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -49,10 +49,6 @@ tags: | |||
49 | description: > | 49 | description: > |
50 | Each server exposes public information regarding supported videos and | 50 | Each server exposes public information regarding supported videos and |
51 | options. | 51 | options. |
52 | - name: Feeds | ||
53 | description: | | ||
54 | Feeds of videos and feeds of comments allow to see updates and get them in | ||
55 | an aggregator or script of your choice. | ||
56 | - name: Job | 52 | - name: Job |
57 | description: > | 53 | description: > |
58 | Jobs are long-running tasks enqueued and processed by the instance | 54 | Jobs are long-running tasks enqueued and processed by the instance |
@@ -113,9 +109,6 @@ x-tagGroups: | |||
113 | tags: | 109 | tags: |
114 | - Config | 110 | - Config |
115 | - Server Following | 111 | - Server Following |
116 | - name: Notifications | ||
117 | tags: | ||
118 | - Feeds | ||
119 | - name: Jobs | 112 | - name: Jobs |
120 | tags: | 113 | tags: |
121 | - Job | 114 | - Job |
@@ -273,44 +266,6 @@ paths: | |||
273 | responses: | 266 | responses: |
274 | '200': | 267 | '200': |
275 | description: successful operation | 268 | description: successful operation |
276 | '/feeds/videos.{format}': | ||
277 | get: | ||
278 | summary: >- | ||
279 | Get the feed of videos for the server, with optional filter by account | ||
280 | name or id | ||
281 | tags: | ||
282 | - Feeds | ||
283 | parameters: | ||
284 | - name: format | ||
285 | in: path | ||
286 | required: true | ||
287 | description: >- | ||
288 | The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and | ||
289 | json to JSON FEED 1.0 | ||
290 | schema: | ||
291 | type: string | ||
292 | enum: | ||
293 | - xml | ||
294 | - atom | ||
295 | - json | ||
296 | default: xml | ||
297 | - name: accountId | ||
298 | in: query | ||
299 | required: false | ||
300 | description: >- | ||
301 | The id of the local account to filter to (beware, users IDs and not | ||
302 | actors IDs which will return empty feeds | ||
303 | schema: | ||
304 | type: number | ||
305 | - name: accountName | ||
306 | in: query | ||
307 | required: false | ||
308 | description: The name of the local account to filter to | ||
309 | schema: | ||
310 | type: string | ||
311 | responses: | ||
312 | '200': | ||
313 | description: successful operation | ||
314 | /jobs/{state}: | 269 | /jobs/{state}: |
315 | get: | 270 | get: |
316 | summary: Get list of jobs | 271 | summary: Get list of jobs |