diff options
author | Chocobozzz <me@florianbigard.com> | 2021-06-28 17:30:59 +0200 |
---|---|---|
committer | Chocobozzz <chocobozzz@cpy.re> | 2021-06-29 14:56:35 +0200 |
commit | d4a8e7a65f97bb3257facc13e1ae8ffdbad61ddb (patch) | |
tree | a4cb07318100031951c3dffc61f4f2cb95d2cbd0 /support/doc/api | |
parent | 62ddc31a9e4b92d7d27898ccfc363f68ab044139 (diff) | |
download | PeerTube-d4a8e7a65f97bb3257facc13e1ae8ffdbad61ddb.tar.gz PeerTube-d4a8e7a65f97bb3257facc13e1ae8ffdbad61ddb.tar.zst PeerTube-d4a8e7a65f97bb3257facc13e1ae8ffdbad61ddb.zip |
Support short uuid for GET video/playlist
Diffstat (limited to 'support/doc/api')
-rw-r--r-- | support/doc/api/openapi.yaml | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 919905788..1f9f3d5c4 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -3003,6 +3003,8 @@ paths: | |||
3003 | $ref: '#/components/schemas/VideoPlaylist/properties/id' | 3003 | $ref: '#/components/schemas/VideoPlaylist/properties/id' |
3004 | uuid: | 3004 | uuid: |
3005 | $ref: '#/components/schemas/VideoPlaylist/properties/uuid' | 3005 | $ref: '#/components/schemas/VideoPlaylist/properties/uuid' |
3006 | shortUUID: | ||
3007 | $ref: '#/components/schemas/VideoPlaylist/properties/shortUUID' | ||
3006 | requestBody: | 3008 | requestBody: |
3007 | content: | 3009 | content: |
3008 | multipart/form-data: | 3010 | multipart/form-data: |
@@ -4543,11 +4545,12 @@ components: | |||
4543 | name: id | 4545 | name: id |
4544 | in: path | 4546 | in: path |
4545 | required: true | 4547 | required: true |
4546 | description: The object id or uuid | 4548 | description: The object id, uuid or short uuid |
4547 | schema: | 4549 | schema: |
4548 | oneOf: | 4550 | oneOf: |
4549 | - $ref: '#/components/schemas/id' | 4551 | - $ref: '#/components/schemas/id' |
4550 | - $ref: '#/components/schemas/UUIDv4' | 4552 | - $ref: '#/components/schemas/UUIDv4' |
4553 | - $ref: '#/components/schemas/shortUUID' | ||
4551 | playlistId: | 4554 | playlistId: |
4552 | name: playlistId | 4555 | name: playlistId |
4553 | in: path | 4556 | in: path |
@@ -4812,6 +4815,10 @@ components: | |||
4812 | pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' | 4815 | pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' |
4813 | minLength: 36 | 4816 | minLength: 36 |
4814 | maxLength: 36 | 4817 | maxLength: 36 |
4818 | shortUUID: | ||
4819 | type: string | ||
4820 | description: translation of a uuid v4 with a bigger alphabet to have a shorter uuid | ||
4821 | example: 2y84q2MQUMWPbiEcxNXMgC | ||
4815 | username: | 4822 | username: |
4816 | type: string | 4823 | type: string |
4817 | description: immutable name of the user, used to find or mention its actor | 4824 | description: immutable name of the user, used to find or mention its actor |
@@ -5141,6 +5148,9 @@ components: | |||
5141 | description: universal identifier for the video, that can be used across instances | 5148 | description: universal identifier for the video, that can be used across instances |
5142 | allOf: | 5149 | allOf: |
5143 | - $ref: '#/components/schemas/UUIDv4' | 5150 | - $ref: '#/components/schemas/UUIDv4' |
5151 | shortUUID: | ||
5152 | allOf: | ||
5153 | - $ref: '#/components/schemas/shortUUID' | ||
5144 | isLive: | 5154 | isLive: |
5145 | type: boolean | 5155 | type: boolean |
5146 | createdAt: | 5156 | createdAt: |
@@ -5520,6 +5530,9 @@ components: | |||
5520 | $ref: '#/components/schemas/id' | 5530 | $ref: '#/components/schemas/id' |
5521 | uuid: | 5531 | uuid: |
5522 | $ref: '#/components/schemas/UUIDv4' | 5532 | $ref: '#/components/schemas/UUIDv4' |
5533 | shortUUID: | ||
5534 | allOf: | ||
5535 | - $ref: '#/components/schemas/shortUUID' | ||
5523 | createdAt: | 5536 | createdAt: |
5524 | type: string | 5537 | type: string |
5525 | format: date-time | 5538 | format: date-time |
@@ -6295,6 +6308,8 @@ components: | |||
6295 | $ref: '#/components/schemas/Video/properties/id' | 6308 | $ref: '#/components/schemas/Video/properties/id' |
6296 | uuid: | 6309 | uuid: |
6297 | $ref: '#/components/schemas/Video/properties/uuid' | 6310 | $ref: '#/components/schemas/Video/properties/uuid' |
6311 | shortUUID: | ||
6312 | $ref: '#/components/schemas/Video/properties/shortUUID' | ||
6298 | CommentThreadResponse: | 6313 | CommentThreadResponse: |
6299 | properties: | 6314 | properties: |
6300 | total: | 6315 | total: |