diff options
author | Chocobozzz <me@florianbigard.com> | 2019-04-24 16:57:23 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2019-04-24 16:57:34 +0200 |
commit | 9ce3d3027ed7253fbd4fe46787eda58c51549444 (patch) | |
tree | 6b100fe5740400d28d15acec5b3dd8a49063991c /support/doc | |
parent | fbe1bc2afa3d57a7880a076ec3a3b21cd9b89516 (diff) | |
download | PeerTube-9ce3d3027ed7253fbd4fe46787eda58c51549444.tar.gz PeerTube-9ce3d3027ed7253fbd4fe46787eda58c51549444.tar.zst PeerTube-9ce3d3027ed7253fbd4fe46787eda58c51549444.zip |
Fix video channel API route param in doc
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/openapi.yaml | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 484cfb31d..dcc6026e2 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -1276,13 +1276,13 @@ paths: | |||
1276 | $ref: '#/paths/~1users~1me/put/responses/204' | 1276 | $ref: '#/paths/~1users~1me/put/responses/204' |
1277 | requestBody: | 1277 | requestBody: |
1278 | $ref: '#/components/requestBodies/VideoChannelInput' | 1278 | $ref: '#/components/requestBodies/VideoChannelInput' |
1279 | '/video-channels/{id}': | 1279 | '/video-channels/{channelHandle}': |
1280 | get: | 1280 | get: |
1281 | summary: Get a video channel by its id | 1281 | summary: Get a video channel by its id |
1282 | tags: | 1282 | tags: |
1283 | - Video Channel | 1283 | - Video Channel |
1284 | parameters: | 1284 | parameters: |
1285 | - $ref: '#/components/parameters/id3' | 1285 | - $ref: '#/components/parameters/channelHandle' |
1286 | responses: | 1286 | responses: |
1287 | '200': | 1287 | '200': |
1288 | description: successful operation | 1288 | description: successful operation |
@@ -1297,7 +1297,7 @@ paths: | |||
1297 | tags: | 1297 | tags: |
1298 | - Video Channel | 1298 | - Video Channel |
1299 | parameters: | 1299 | parameters: |
1300 | - $ref: '#/components/parameters/id3' | 1300 | - $ref: '#/components/parameters/channelHandle' |
1301 | responses: | 1301 | responses: |
1302 | '204': | 1302 | '204': |
1303 | $ref: '#/paths/~1users~1me/put/responses/204' | 1303 | $ref: '#/paths/~1users~1me/put/responses/204' |
@@ -1310,17 +1310,17 @@ paths: | |||
1310 | tags: | 1310 | tags: |
1311 | - Video Channel | 1311 | - Video Channel |
1312 | parameters: | 1312 | parameters: |
1313 | - $ref: '#/components/parameters/id3' | 1313 | - $ref: '#/components/parameters/channelHandle' |
1314 | responses: | 1314 | responses: |
1315 | '204': | 1315 | '204': |
1316 | $ref: '#/paths/~1users~1me/put/responses/204' | 1316 | $ref: '#/paths/~1users~1me/put/responses/204' |
1317 | '/video-channels/{id}/videos': | 1317 | '/video-channels/{channelHandle}/videos': |
1318 | get: | 1318 | get: |
1319 | summary: Get videos of a video channel by its id | 1319 | summary: Get videos of a video channel by its id |
1320 | tags: | 1320 | tags: |
1321 | - Video Channel | 1321 | - Video Channel |
1322 | parameters: | 1322 | parameters: |
1323 | - $ref: '#/components/parameters/id3' | 1323 | - $ref: '#/components/parameters/channelHandle' |
1324 | responses: | 1324 | responses: |
1325 | '200': | 1325 | '200': |
1326 | description: successful operation | 1326 | description: successful operation |
@@ -1611,11 +1611,11 @@ components: | |||
1611 | description: The video id or uuid | 1611 | description: The video id or uuid |
1612 | schema: | 1612 | schema: |
1613 | type: string | 1613 | type: string |
1614 | id3: | 1614 | channelHandle: |
1615 | name: id | 1615 | name: channelHandle |
1616 | in: path | 1616 | in: path |
1617 | required: true | 1617 | required: true |
1618 | description: The video channel id or uuid | 1618 | description: "The video channel handle (example: 'my_username@example.com' or 'my_username')" |
1619 | schema: | 1619 | schema: |
1620 | type: string | 1620 | type: string |
1621 | commentId: | 1621 | commentId: |