diff options
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/openapi.yaml | 63 |
1 files changed, 42 insertions, 21 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index fd227353d..f99d49fef 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -1976,10 +1976,12 @@ paths: | |||
1976 | - $ref: '#/components/schemas/Video/properties/id' | 1976 | - $ref: '#/components/schemas/Video/properties/id' |
1977 | startAt: | 1977 | startAt: |
1978 | type: integer | 1978 | type: integer |
1979 | format: seconds | ||
1979 | description: Timestamp in the video that marks the beginning of the report | 1980 | description: Timestamp in the video that marks the beginning of the report |
1980 | minimum: 0 | 1981 | minimum: 0 |
1981 | endAt: | 1982 | endAt: |
1982 | type: integer | 1983 | type: integer |
1984 | format: seconds | ||
1983 | description: Timestamp in the video that marks the ending of the report | 1985 | description: Timestamp in the video that marks the ending of the report |
1984 | minimum: 0 | 1986 | minimum: 0 |
1985 | comment: | 1987 | comment: |
@@ -2564,13 +2566,13 @@ paths: | |||
2564 | thumbnailfile: | 2566 | thumbnailfile: |
2565 | contentType: image/jpeg | 2567 | contentType: image/jpeg |
2566 | 2568 | ||
2567 | /video-playlists/{id}: | 2569 | /video-playlists/{playlistId}: |
2568 | get: | 2570 | get: |
2569 | summary: Get a video playlist | 2571 | summary: Get a video playlist |
2570 | tags: | 2572 | tags: |
2571 | - Video Playlists | 2573 | - Video Playlists |
2572 | parameters: | 2574 | parameters: |
2573 | - $ref: '#/components/parameters/idOrUUID' | 2575 | - $ref: '#/components/parameters/playlistId' |
2574 | responses: | 2576 | responses: |
2575 | '200': | 2577 | '200': |
2576 | description: successful operation | 2578 | description: successful operation |
@@ -2589,7 +2591,7 @@ paths: | |||
2589 | '204': | 2591 | '204': |
2590 | description: successful operation | 2592 | description: successful operation |
2591 | parameters: | 2593 | parameters: |
2592 | - $ref: '#/components/parameters/idOrUUID' | 2594 | - $ref: '#/components/parameters/playlistId' |
2593 | requestBody: | 2595 | requestBody: |
2594 | content: | 2596 | content: |
2595 | multipart/form-data: | 2597 | multipart/form-data: |
@@ -2624,19 +2626,19 @@ paths: | |||
2624 | tags: | 2626 | tags: |
2625 | - Video Playlists | 2627 | - Video Playlists |
2626 | parameters: | 2628 | parameters: |
2627 | - $ref: '#/components/parameters/idOrUUID' | 2629 | - $ref: '#/components/parameters/playlistId' |
2628 | responses: | 2630 | responses: |
2629 | '204': | 2631 | '204': |
2630 | description: successful operation | 2632 | description: successful operation |
2631 | 2633 | ||
2632 | /video-playlists/{id}/videos: | 2634 | /video-playlists/{playlistId}/videos: |
2633 | get: | 2635 | get: |
2634 | summary: 'List videos of a playlist' | 2636 | summary: 'List videos of a playlist' |
2635 | tags: | 2637 | tags: |
2636 | - Videos | 2638 | - Videos |
2637 | - Video Playlists | 2639 | - Video Playlists |
2638 | parameters: | 2640 | parameters: |
2639 | - $ref: '#/components/parameters/idOrUUID' | 2641 | - $ref: '#/components/parameters/playlistId' |
2640 | responses: | 2642 | responses: |
2641 | '200': | 2643 | '200': |
2642 | description: successful operation | 2644 | description: successful operation |
@@ -2645,14 +2647,14 @@ paths: | |||
2645 | schema: | 2647 | schema: |
2646 | $ref: '#/components/schemas/VideoListResponse' | 2648 | $ref: '#/components/schemas/VideoListResponse' |
2647 | post: | 2649 | post: |
2648 | summary: 'Add a video in a playlist' | 2650 | summary: Add a video in a playlist |
2649 | security: | 2651 | security: |
2650 | - OAuth2: [] | 2652 | - OAuth2: [] |
2651 | tags: | 2653 | tags: |
2652 | - Videos | 2654 | - Videos |
2653 | - Video Playlists | 2655 | - Video Playlists |
2654 | parameters: | 2656 | parameters: |
2655 | - $ref: '#/components/parameters/idOrUUID' | 2657 | - $ref: '#/components/parameters/playlistId' |
2656 | responses: | 2658 | responses: |
2657 | '200': | 2659 | '200': |
2658 | description: successful operation | 2660 | description: successful operation |
@@ -2666,6 +2668,7 @@ paths: | |||
2666 | properties: | 2668 | properties: |
2667 | id: | 2669 | id: |
2668 | type: integer | 2670 | type: integer |
2671 | example: 2 | ||
2669 | requestBody: | 2672 | requestBody: |
2670 | content: | 2673 | content: |
2671 | application/json: | 2674 | application/json: |
@@ -2673,19 +2676,22 @@ paths: | |||
2673 | type: object | 2676 | type: object |
2674 | properties: | 2677 | properties: |
2675 | videoId: | 2678 | videoId: |
2676 | allOf: | 2679 | oneOf: |
2680 | - $ref: '#/components/schemas/Video/properties/uuid' | ||
2677 | - $ref: '#/components/schemas/Video/properties/id' | 2681 | - $ref: '#/components/schemas/Video/properties/id' |
2678 | description: Video to add in the playlist | 2682 | description: Video to add in the playlist |
2679 | startTimestamp: | 2683 | startTimestamp: |
2680 | type: integer | 2684 | type: integer |
2681 | description: Start the video at this specific timestamp (in seconds) | 2685 | format: seconds |
2686 | description: Start the video at this specific timestamp | ||
2682 | stopTimestamp: | 2687 | stopTimestamp: |
2683 | type: integer | 2688 | type: integer |
2684 | description: Stop the video at this specific timestamp (in seconds) | 2689 | format: seconds |
2690 | description: Stop the video at this specific timestamp | ||
2685 | required: | 2691 | required: |
2686 | - videoId | 2692 | - videoId |
2687 | 2693 | ||
2688 | /video-playlists/{id}/videos/reorder: | 2694 | /video-playlists/{playlistId}/videos/reorder: |
2689 | post: | 2695 | post: |
2690 | summary: 'Reorder a playlist' | 2696 | summary: 'Reorder a playlist' |
2691 | security: | 2697 | security: |
@@ -2693,7 +2699,7 @@ paths: | |||
2693 | tags: | 2699 | tags: |
2694 | - Video Playlists | 2700 | - Video Playlists |
2695 | parameters: | 2701 | parameters: |
2696 | - $ref: '#/components/parameters/idOrUUID' | 2702 | - $ref: '#/components/parameters/playlistId' |
2697 | responses: | 2703 | responses: |
2698 | '204': | 2704 | '204': |
2699 | description: successful operation | 2705 | description: successful operation |
@@ -2719,15 +2725,15 @@ paths: | |||
2719 | - startPosition | 2725 | - startPosition |
2720 | - insertAfterPosition | 2726 | - insertAfterPosition |
2721 | 2727 | ||
2722 | /video-playlists/{id}/videos/{playlistElementId}: | 2728 | /video-playlists/{playlistId}/videos/{playlistElementId}: |
2723 | put: | 2729 | put: |
2724 | summary: 'Update a playlist element' | 2730 | summary: Update a playlist element |
2725 | security: | 2731 | security: |
2726 | - OAuth2: [] | 2732 | - OAuth2: [] |
2727 | tags: | 2733 | tags: |
2728 | - Video Playlists | 2734 | - Video Playlists |
2729 | parameters: | 2735 | parameters: |
2730 | - $ref: '#/components/parameters/idOrUUID' | 2736 | - $ref: '#/components/parameters/playlistId' |
2731 | - $ref: '#/components/parameters/playlistElementId' | 2737 | - $ref: '#/components/parameters/playlistElementId' |
2732 | responses: | 2738 | responses: |
2733 | '204': | 2739 | '204': |
@@ -2740,18 +2746,20 @@ paths: | |||
2740 | properties: | 2746 | properties: |
2741 | startTimestamp: | 2747 | startTimestamp: |
2742 | type: integer | 2748 | type: integer |
2743 | description: 'Start the video at this specific timestamp (in seconds)' | 2749 | format: seconds |
2750 | description: Start the video at this specific timestamp | ||
2744 | stopTimestamp: | 2751 | stopTimestamp: |
2745 | type: integer | 2752 | type: integer |
2746 | description: 'Stop the video at this specific timestamp (in seconds)' | 2753 | format: seconds |
2754 | description: Stop the video at this specific timestamp | ||
2747 | delete: | 2755 | delete: |
2748 | summary: 'Delete an element from a playlist' | 2756 | summary: Delete an element from a playlist |
2749 | security: | 2757 | security: |
2750 | - OAuth2: [] | 2758 | - OAuth2: [] |
2751 | tags: | 2759 | tags: |
2752 | - Video Playlists | 2760 | - Video Playlists |
2753 | parameters: | 2761 | parameters: |
2754 | - $ref: '#/components/parameters/idOrUUID' | 2762 | - $ref: '#/components/parameters/playlistId' |
2755 | - $ref: '#/components/parameters/playlistElementId' | 2763 | - $ref: '#/components/parameters/playlistElementId' |
2756 | responses: | 2764 | responses: |
2757 | '204': | 2765 | '204': |
@@ -2759,7 +2767,7 @@ paths: | |||
2759 | 2767 | ||
2760 | '/users/me/video-playlists/videos-exist': | 2768 | '/users/me/video-playlists/videos-exist': |
2761 | get: | 2769 | get: |
2762 | summary: 'Check video exists in my playlists' | 2770 | summary: Check video exists in my playlists |
2763 | security: | 2771 | security: |
2764 | - OAuth2: [] | 2772 | - OAuth2: [] |
2765 | tags: | 2773 | tags: |
@@ -2792,8 +2800,10 @@ paths: | |||
2792 | type: integer | 2800 | type: integer |
2793 | startTimestamp: | 2801 | startTimestamp: |
2794 | type: integer | 2802 | type: integer |
2803 | format: seconds | ||
2795 | stopTimestamp: | 2804 | stopTimestamp: |
2796 | type: integer | 2805 | type: integer |
2806 | format: seconds | ||
2797 | 2807 | ||
2798 | '/accounts/{name}/video-channels': | 2808 | '/accounts/{name}/video-channels': |
2799 | get: | 2809 | get: |
@@ -3984,6 +3994,13 @@ components: | |||
3984 | oneOf: | 3994 | oneOf: |
3985 | - $ref: '#/components/schemas/id' | 3995 | - $ref: '#/components/schemas/id' |
3986 | - $ref: '#/components/schemas/UUIDv4' | 3996 | - $ref: '#/components/schemas/UUIDv4' |
3997 | playlistId: | ||
3998 | name: playlistId | ||
3999 | in: path | ||
4000 | required: true | ||
4001 | description: Playlist id | ||
4002 | schema: | ||
4003 | $ref: '#/components/schemas/VideoPlaylist/properties/id' | ||
3987 | playlistElementId: | 4004 | playlistElementId: |
3988 | name: playlistElementId | 4005 | name: playlistElementId |
3989 | in: path | 4006 | in: path |
@@ -4447,8 +4464,10 @@ components: | |||
4447 | type: integer | 4464 | type: integer |
4448 | startTimestamp: | 4465 | startTimestamp: |
4449 | type: integer | 4466 | type: integer |
4467 | format: seconds | ||
4450 | stopTimestamp: | 4468 | stopTimestamp: |
4451 | type: integer | 4469 | type: integer |
4470 | format: seconds | ||
4452 | video: | 4471 | video: |
4453 | nullable: true | 4472 | nullable: true |
4454 | allOf: | 4473 | allOf: |
@@ -4597,6 +4616,7 @@ components: | |||
4597 | duration: | 4616 | duration: |
4598 | type: integer | 4617 | type: integer |
4599 | example: 1419 | 4618 | example: 1419 |
4619 | format: seconds | ||
4600 | description: duration of the video in seconds | 4620 | description: duration of the video in seconds |
4601 | isLocal: | 4621 | isLocal: |
4602 | type: boolean | 4622 | type: boolean |
@@ -5091,6 +5111,7 @@ components: | |||
5091 | properties: | 5111 | properties: |
5092 | currentTime: | 5112 | currentTime: |
5093 | type: integer | 5113 | type: integer |
5114 | format: seconds | ||
5094 | description: timestamp within the video, in seconds | 5115 | description: timestamp within the video, in seconds |
5095 | example: 5 | 5116 | example: 5 |
5096 | ServerConfig: | 5117 | ServerConfig: |