diff options
Diffstat (limited to 'support/doc/api/openapi.yaml')
-rw-r--r-- | support/doc/api/openapi.yaml | 82 |
1 files changed, 82 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 123e54f47..3a8b481d3 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -2462,6 +2462,48 @@ paths: | |||
2462 | description: bad parameters or trying to update a live that has already started | 2462 | description: bad parameters or trying to update a live that has already started |
2463 | '403': | 2463 | '403': |
2464 | description: trying to save replay of the live but saving replay is not enabled on the instance | 2464 | description: trying to save replay of the live but saving replay is not enabled on the instance |
2465 | /videos/live/{id}/sessions: | ||
2466 | get: | ||
2467 | summary: List live sessions | ||
2468 | description: List all sessions created in a particular live | ||
2469 | security: | ||
2470 | - OAuth2: [] | ||
2471 | tags: | ||
2472 | - Live Videos | ||
2473 | parameters: | ||
2474 | - $ref: '#/components/parameters/idOrUUID' | ||
2475 | responses: | ||
2476 | '200': | ||
2477 | description: successful operation | ||
2478 | content: | ||
2479 | application/json: | ||
2480 | schema: | ||
2481 | type: object | ||
2482 | properties: | ||
2483 | total: | ||
2484 | type: integer | ||
2485 | example: 1 | ||
2486 | data: | ||
2487 | type: array | ||
2488 | items: | ||
2489 | $ref: '#/components/schemas/LiveVideoSessionResponse' | ||
2490 | /videos/{id}/live-session: | ||
2491 | get: | ||
2492 | summary: Get live session of a replay | ||
2493 | description: If the video is a replay of a live, you can find the associated live session using this endpoint | ||
2494 | security: | ||
2495 | - OAuth2: [] | ||
2496 | tags: | ||
2497 | - Live Videos | ||
2498 | parameters: | ||
2499 | - $ref: '#/components/parameters/idOrUUID' | ||
2500 | responses: | ||
2501 | '200': | ||
2502 | description: successful operation | ||
2503 | content: | ||
2504 | application/json: | ||
2505 | schema: | ||
2506 | $ref: '#/components/schemas/LiveVideoSessionResponse' | ||
2465 | 2507 | ||
2466 | /users/me/abuses: | 2508 | /users/me/abuses: |
2467 | get: | 2509 | get: |
@@ -7673,6 +7715,46 @@ components: | |||
7673 | description: User can select live latency mode if enabled by the instance | 7715 | description: User can select live latency mode if enabled by the instance |
7674 | $ref: '#/components/schemas/LiveVideoLatencyMode' | 7716 | $ref: '#/components/schemas/LiveVideoLatencyMode' |
7675 | 7717 | ||
7718 | LiveVideoSessionResponse: | ||
7719 | properties: | ||
7720 | id: | ||
7721 | type: integer | ||
7722 | startDate: | ||
7723 | type: string | ||
7724 | format: date-time | ||
7725 | description: Start date of the live session | ||
7726 | endDate: | ||
7727 | type: string | ||
7728 | format: date-time | ||
7729 | nullable: true | ||
7730 | description: End date of the live session | ||
7731 | error: | ||
7732 | type: integer | ||
7733 | enum: | ||
7734 | - 1 | ||
7735 | - 2 | ||
7736 | - 3 | ||
7737 | - 4 | ||
7738 | - 5 | ||
7739 | nullable: true | ||
7740 | description: > | ||
7741 | Error type if an error occured during the live session: | ||
7742 | - `1`: Bad socket health (transcoding is too slow) | ||
7743 | - `2`: Max duration exceeded | ||
7744 | - `3`: Quota exceeded | ||
7745 | - `4`: Quota FFmpeg error | ||
7746 | - `5`: Video has been blacklisted during the live | ||
7747 | replayVideo: | ||
7748 | type: object | ||
7749 | description: Video replay information | ||
7750 | properties: | ||
7751 | id: | ||
7752 | type: number | ||
7753 | uuid: | ||
7754 | $ref: '#/components/schemas/UUIDv4' | ||
7755 | shortUUID: | ||
7756 | $ref: '#/components/schemas/shortUUID' | ||
7757 | |||
7676 | callbacks: | 7758 | callbacks: |
7677 | searchIndex: | 7759 | searchIndex: |
7678 | 'https://search.example.org/api/v1/search/videos': | 7760 | 'https://search.example.org/api/v1/search/videos': |