diff options
Diffstat (limited to 'support/doc/api')
-rw-r--r-- | support/doc/api/openapi.yaml | 44 |
1 files changed, 19 insertions, 25 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 701988478..7307ea8a0 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -2385,7 +2385,7 @@ paths: | |||
2385 | id: | 2385 | id: |
2386 | type: integer | 2386 | type: integer |
2387 | uuid: | 2387 | uuid: |
2388 | type: string | 2388 | $ref: '#/components/schemas/UUIDv4' |
2389 | requestBody: | 2389 | requestBody: |
2390 | content: | 2390 | content: |
2391 | multipart/form-data: | 2391 | multipart/form-data: |
@@ -3753,9 +3753,7 @@ components: | |||
3753 | - type: integer | 3753 | - type: integer |
3754 | minimum: 0 | 3754 | minimum: 0 |
3755 | example: 42 | 3755 | example: 42 |
3756 | - type: string | 3756 | - $ref: '#/components/schemas/UUIDv4' |
3757 | format: uuid | ||
3758 | example: 9c9de5e8-0a1e-484a-b099-e80766180a6d | ||
3759 | playlistElementId: | 3757 | playlistElementId: |
3760 | name: playlistElementId | 3758 | name: playlistElementId |
3761 | in: path | 3759 | in: path |
@@ -3983,6 +3981,16 @@ components: | |||
3983 | moderator: Moderator scope | 3981 | moderator: Moderator scope |
3984 | user: User scope | 3982 | user: User scope |
3985 | schemas: | 3983 | schemas: |
3984 | UUIDv4: | ||
3985 | type: string | ||
3986 | format: uuid | ||
3987 | example: 9c9de5e8-0a1e-484a-b099-e80766180a6d | ||
3988 | pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$' | ||
3989 | # the regex above limits the length; | ||
3990 | # however, some tools might require explicit settings: | ||
3991 | minLength: 36 | ||
3992 | maxLength: 36 | ||
3993 | |||
3986 | VideoConstantNumber-Category: | 3994 | VideoConstantNumber-Category: |
3987 | properties: | 3995 | properties: |
3988 | id: | 3996 | id: |
@@ -4250,9 +4258,7 @@ components: | |||
4250 | id: | 4258 | id: |
4251 | type: integer | 4259 | type: integer |
4252 | uuid: | 4260 | uuid: |
4253 | type: string | 4261 | $ref: '#/components/schemas/UUIDv4' |
4254 | format: uuid | ||
4255 | example: 9c9de5e8-0a1e-484a-b099-e80766180a6d | ||
4256 | name: | 4262 | name: |
4257 | type: string | 4263 | type: string |
4258 | minLength: 3 | 4264 | minLength: 3 |
@@ -4263,9 +4269,7 @@ components: | |||
4263 | type: integer | 4269 | type: integer |
4264 | example: 8 | 4270 | example: 8 |
4265 | uuid: | 4271 | uuid: |
4266 | type: string | 4272 | $ref: '#/components/schemas/UUIDv4' |
4267 | format: uuid | ||
4268 | example: 9c9de5e8-0a1e-484a-b099-e80766180a6d | ||
4269 | isLive: | 4273 | isLive: |
4270 | type: boolean | 4274 | type: boolean |
4271 | createdAt: | 4275 | createdAt: |
@@ -4433,9 +4437,7 @@ components: | |||
4433 | type: string | 4437 | type: string |
4434 | format: url | 4438 | format: url |
4435 | uuid: | 4439 | uuid: |
4436 | type: string | 4440 | $ref: '#/components/schemas/UUIDv4' |
4437 | format: uuid | ||
4438 | example: 9c9de5e8-0a1e-484a-b099-e80766180a6d | ||
4439 | redundancies: | 4441 | redundancies: |
4440 | type: object | 4442 | type: object |
4441 | properties: | 4443 | properties: |
@@ -4544,9 +4546,7 @@ components: | |||
4544 | minLength: 3 | 4546 | minLength: 3 |
4545 | maxLength: 120 | 4547 | maxLength: 120 |
4546 | uuid: | 4548 | uuid: |
4547 | type: string | 4549 | $ref: '#/components/schemas/UUIDv4' |
4548 | format: uuid | ||
4549 | example: 9c9de5e8-0a1e-484a-b099-e80766180a6d | ||
4550 | description: | 4550 | description: |
4551 | type: string | 4551 | type: string |
4552 | minLength: 3 | 4552 | minLength: 3 |
@@ -4579,9 +4579,7 @@ components: | |||
4579 | id: | 4579 | id: |
4580 | type: integer | 4580 | type: integer |
4581 | uuid: | 4581 | uuid: |
4582 | type: string | 4582 | $ref: '#/components/schemas/UUIDv4' |
4583 | format: uuid | ||
4584 | example: 9c9de5e8-0a1e-484a-b099-e80766180a6d | ||
4585 | VideoPlaylist: | 4583 | VideoPlaylist: |
4586 | properties: | 4584 | properties: |
4587 | id: | 4585 | id: |
@@ -4597,9 +4595,7 @@ components: | |||
4597 | minLength: 3 | 4595 | minLength: 3 |
4598 | maxLength: 1000 | 4596 | maxLength: 1000 |
4599 | uuid: | 4597 | uuid: |
4600 | type: string | 4598 | $ref: '#/components/schemas/UUIDv4' |
4601 | format: uuid | ||
4602 | example: 9c9de5e8-0a1e-484a-b099-e80766180a6d | ||
4603 | displayName: | 4599 | displayName: |
4604 | type: string | 4600 | type: string |
4605 | minLength: 1 | 4601 | minLength: 1 |
@@ -5196,9 +5192,7 @@ components: | |||
5196 | type: integer | 5192 | type: integer |
5197 | example: 8 | 5193 | example: 8 |
5198 | uuid: | 5194 | uuid: |
5199 | type: string | 5195 | $ref: '#/components/schemas/UUIDv4' |
5200 | format: uuid | ||
5201 | example: 9c9de5e8-0a1e-484a-b099-e80766180a6d | ||
5202 | CommentThreadResponse: | 5196 | CommentThreadResponse: |
5203 | properties: | 5197 | properties: |
5204 | total: | 5198 | total: |