diff options
Diffstat (limited to 'support/doc/api')
-rw-r--r-- | support/doc/api/openapi.yaml | 45 |
1 files changed, 40 insertions, 5 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 3b06a2568..186d7d37d 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -1147,7 +1147,8 @@ paths: | |||
1147 | description: Whether or not we wait transcoding before publish the video | 1147 | description: Whether or not we wait transcoding before publish the video |
1148 | type: string | 1148 | type: string |
1149 | support: | 1149 | support: |
1150 | description: Text describing how to support the video uploader | 1150 | description: A text tell the audience how to support the video creator |
1151 | example: Please support my work on <insert crowdfunding plateform>! <3 | ||
1151 | type: string | 1152 | type: string |
1152 | nsfw: | 1153 | nsfw: |
1153 | description: Whether or not this video contains sensitive content | 1154 | description: Whether or not this video contains sensitive content |
@@ -1305,7 +1306,8 @@ paths: | |||
1305 | description: Whether or not we wait transcoding before publish the video | 1306 | description: Whether or not we wait transcoding before publish the video |
1306 | type: string | 1307 | type: string |
1307 | support: | 1308 | support: |
1308 | description: Text describing how to support the video uploader | 1309 | description: A text tell the audience how to support the video creator |
1310 | example: Please support my work on <insert crowdfunding plateform>! <3 | ||
1309 | type: string | 1311 | type: string |
1310 | nsfw: | 1312 | nsfw: |
1311 | description: Whether or not this video contains sensitive content | 1313 | description: Whether or not this video contains sensitive content |
@@ -1422,7 +1424,8 @@ paths: | |||
1422 | description: Whether or not we wait transcoding before publish the video | 1424 | description: Whether or not we wait transcoding before publish the video |
1423 | type: string | 1425 | type: string |
1424 | support: | 1426 | support: |
1425 | description: Text describing how to support the video uploader | 1427 | description: A text tell the audience how to support the video creator |
1428 | example: Please support my work on <insert crowdfunding plateform>! <3 | ||
1426 | type: string | 1429 | type: string |
1427 | nsfw: | 1430 | nsfw: |
1428 | description: Whether or not this video contains sensitive content | 1431 | description: Whether or not this video contains sensitive content |
@@ -2723,7 +2726,7 @@ paths: | |||
2723 | - name: format | 2726 | - name: format |
2724 | in: path | 2727 | in: path |
2725 | required: true | 2728 | required: true |
2726 | description: 'format expected (we focus on making `rss` the most featureful ; it serves Media RSS)' | 2729 | description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))' |
2727 | schema: | 2730 | schema: |
2728 | type: string | 2731 | type: string |
2729 | enum: | 2732 | enum: |
@@ -2739,6 +2742,26 @@ paths: | |||
2739 | description: 'limit listing to a specific video' | 2742 | description: 'limit listing to a specific video' |
2740 | schema: | 2743 | schema: |
2741 | type: string | 2744 | type: string |
2745 | - name: accountId | ||
2746 | in: query | ||
2747 | description: 'limit listing to a specific account' | ||
2748 | schema: | ||
2749 | type: string | ||
2750 | - name: accountName | ||
2751 | in: query | ||
2752 | description: 'limit listing to a specific account' | ||
2753 | schema: | ||
2754 | type: string | ||
2755 | - name: videoChannelId | ||
2756 | in: query | ||
2757 | description: 'limit listing to a specific video channel' | ||
2758 | schema: | ||
2759 | type: string | ||
2760 | - name: videoChannelName | ||
2761 | in: query | ||
2762 | description: 'limit listing to a specific video channel' | ||
2763 | schema: | ||
2764 | type: string | ||
2742 | responses: | 2765 | responses: |
2743 | '204': | 2766 | '204': |
2744 | description: successful operation | 2767 | description: successful operation |
@@ -2763,6 +2786,13 @@ paths: | |||
2763 | application/json: | 2786 | application/json: |
2764 | schema: | 2787 | schema: |
2765 | type: object | 2788 | type: object |
2789 | '400': | ||
2790 | x-summary: field inconsistencies | ||
2791 | description: > | ||
2792 | Arises when: | ||
2793 | - videoId filter is mixed with a channel filter | ||
2794 | '404': | ||
2795 | description: video, video channel or account not found | ||
2766 | '406': | 2796 | '406': |
2767 | description: accept header unsupported | 2797 | description: accept header unsupported |
2768 | '/feeds/videos.{format}': | 2798 | '/feeds/videos.{format}': |
@@ -2781,7 +2811,7 @@ paths: | |||
2781 | - name: format | 2811 | - name: format |
2782 | in: path | 2812 | in: path |
2783 | required: true | 2813 | required: true |
2784 | description: 'format expected (we focus on making `rss` the most featureful ; it serves Media RSS)' | 2814 | description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))' |
2785 | schema: | 2815 | schema: |
2786 | type: string | 2816 | type: string |
2787 | enum: | 2817 | enum: |
@@ -2842,6 +2872,8 @@ paths: | |||
2842 | application/json: | 2872 | application/json: |
2843 | schema: | 2873 | schema: |
2844 | type: object | 2874 | type: object |
2875 | '404': | ||
2876 | description: video channel or account not found | ||
2845 | '406': | 2877 | '406': |
2846 | description: accept header unsupported | 2878 | description: accept header unsupported |
2847 | /plugins: | 2879 | /plugins: |
@@ -3775,6 +3807,7 @@ components: | |||
3775 | type: string | 3807 | type: string |
3776 | support: | 3808 | support: |
3777 | type: string | 3809 | type: string |
3810 | description: A text tell the audience how to support the video creator | ||
3778 | example: Please support my work on <insert crowdfunding plateform>! <3 | 3811 | example: Please support my work on <insert crowdfunding plateform>! <3 |
3779 | channel: | 3812 | channel: |
3780 | $ref: '#/components/schemas/VideoChannel' | 3813 | $ref: '#/components/schemas/VideoChannel' |
@@ -4806,6 +4839,7 @@ components: | |||
4806 | support: | 4839 | support: |
4807 | type: string | 4840 | type: string |
4808 | description: 'A text shown by default on all videos of this channel, to tell the audience how to support it' | 4841 | description: 'A text shown by default on all videos of this channel, to tell the audience how to support it' |
4842 | example: Please support my work on <insert crowdfunding plateform>! <3 | ||
4809 | required: | 4843 | required: |
4810 | - name | 4844 | - name |
4811 | - displayName | 4845 | - displayName |
@@ -4818,6 +4852,7 @@ components: | |||
4818 | support: | 4852 | support: |
4819 | type: string | 4853 | type: string |
4820 | description: 'A text shown by default on all videos of this channel, to tell the audience how to support it' | 4854 | description: 'A text shown by default on all videos of this channel, to tell the audience how to support it' |
4855 | example: Please support my work on <insert crowdfunding plateform>! <3 | ||
4821 | bulkVideosSupportUpdate: | 4856 | bulkVideosSupportUpdate: |
4822 | type: boolean | 4857 | type: boolean |
4823 | description: 'Update the support field for all videos of this channel' | 4858 | description: 'Update the support field for all videos of this channel' |