diff options
author | Chocobozzz <me@florianbigard.com> | 2019-05-24 10:17:54 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2019-05-24 10:17:54 +0200 |
commit | 048b69466168e5585b2f8d8a6d77da315202cabb (patch) | |
tree | 5200f6741162fe0880bc3500a8b0ea62aa545d9d /support/doc/api/openapi.yaml | |
parent | ee89e8fd1a0dc516c850b47c5279baafa4c434ac (diff) | |
download | PeerTube-048b69466168e5585b2f8d8a6d77da315202cabb.tar.gz PeerTube-048b69466168e5585b2f8d8a6d77da315202cabb.tar.zst PeerTube-048b69466168e5585b2f8d8a6d77da315202cabb.zip |
Fix videos list response in rest api doc
Diffstat (limited to 'support/doc/api/openapi.yaml')
-rw-r--r-- | support/doc/api/openapi.yaml | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index c1a9a3987..b9ca4cca2 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -153,7 +153,7 @@ paths: | |||
153 | content: | 153 | content: |
154 | application/json: | 154 | application/json: |
155 | schema: | 155 | schema: |
156 | $ref: '#/components/schemas/Video' | 156 | $ref: '#/components/schemas/VideoListResponse' |
157 | x-code-samples: | 157 | x-code-samples: |
158 | - lang: JavaScript | 158 | - lang: JavaScript |
159 | source: | | 159 | source: | |
@@ -576,9 +576,7 @@ paths: | |||
576 | content: | 576 | content: |
577 | application/json: | 577 | application/json: |
578 | schema: | 578 | schema: |
579 | type: array | 579 | $ref: '#/components/schemas/VideoListResponse' |
580 | items: | ||
581 | $ref: '#/components/schemas/Video' | ||
582 | /users/me/subscriptions: | 580 | /users/me/subscriptions: |
583 | get: | 581 | get: |
584 | summary: Get subscriptions of the current user | 582 | summary: Get subscriptions of the current user |
@@ -639,9 +637,7 @@ paths: | |||
639 | content: | 637 | content: |
640 | application/json: | 638 | application/json: |
641 | schema: | 639 | schema: |
642 | type: array | 640 | $ref: '#/components/schemas/VideoListResponse' |
643 | items: | ||
644 | $ref: '#/components/schemas/Video' | ||
645 | '/users/me/subscriptions/{uri}': | 641 | '/users/me/subscriptions/{uri}': |
646 | get: | 642 | get: |
647 | summary: Get subscription of the current user for a given uri | 643 | summary: Get subscription of the current user for a given uri |
@@ -731,9 +727,7 @@ paths: | |||
731 | content: | 727 | content: |
732 | application/json: | 728 | application/json: |
733 | schema: | 729 | schema: |
734 | type: array | 730 | $ref: '#/components/schemas/VideoListResponse' |
735 | items: | ||
736 | $ref: '#/components/schemas/Video' | ||
737 | /videos/categories: | 731 | /videos/categories: |
738 | get: | 732 | get: |
739 | summary: Get list of video licences known by the server | 733 | summary: Get list of video licences known by the server |
@@ -1371,6 +1365,7 @@ paths: | |||
1371 | get: | 1365 | get: |
1372 | summary: Get videos of a video channel by its id | 1366 | summary: Get videos of a video channel by its id |
1373 | tags: | 1367 | tags: |
1368 | - Video | ||
1374 | - Video Channel | 1369 | - Video Channel |
1375 | parameters: | 1370 | parameters: |
1376 | - $ref: '#/components/parameters/channelHandle' | 1371 | - $ref: '#/components/parameters/channelHandle' |
@@ -1380,7 +1375,7 @@ paths: | |||
1380 | content: | 1375 | content: |
1381 | application/json: | 1376 | application/json: |
1382 | schema: | 1377 | schema: |
1383 | $ref: '#/components/schemas/Video' | 1378 | $ref: '#/components/schemas/VideoListResponse' |
1384 | '/accounts/{name}/video-channels': | 1379 | '/accounts/{name}/video-channels': |
1385 | get: | 1380 | get: |
1386 | summary: Get video channels of an account by its name | 1381 | summary: Get video channels of an account by its name |
@@ -1540,9 +1535,7 @@ paths: | |||
1540 | content: | 1535 | content: |
1541 | application/json: | 1536 | application/json: |
1542 | schema: | 1537 | schema: |
1543 | type: array | 1538 | $ref: '#/components/schemas/VideoListResponse' |
1544 | items: | ||
1545 | $ref: '#/components/schemas/Video' | ||
1546 | servers: | 1539 | servers: |
1547 | - url: 'https://peertube.cpy.re/api/v1' | 1540 | - url: 'https://peertube.cpy.re/api/v1' |
1548 | description: Live Test Server (live data - stable version) | 1541 | description: Live Test Server (live data - stable version) |
@@ -2180,6 +2173,14 @@ components: | |||
2180 | properties: | 2173 | properties: |
2181 | comment: | 2174 | comment: |
2182 | $ref: '#/components/schemas/VideoComment' | 2175 | $ref: '#/components/schemas/VideoComment' |
2176 | VideoListResponse: | ||
2177 | properties: | ||
2178 | total: | ||
2179 | type: number | ||
2180 | data: | ||
2181 | type: array | ||
2182 | items: | ||
2183 | $ref: '#/components/schemas/Video' | ||
2183 | AddUser: | 2184 | AddUser: |
2184 | properties: | 2185 | properties: |
2185 | username: | 2186 | username: |