diff options
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/openapi.yaml | 58 |
1 files changed, 54 insertions, 4 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 9fe98b8df..5074f05db 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -148,6 +148,17 @@ paths: | |||
148 | summary: 'List videos of an account' | 148 | summary: 'List videos of an account' |
149 | parameters: | 149 | parameters: |
150 | - $ref: '#/components/parameters/name' | 150 | - $ref: '#/components/parameters/name' |
151 | - $ref: '#/components/parameters/categoryOneOf' | ||
152 | - $ref: '#/components/parameters/tagsOneOf' | ||
153 | - $ref: '#/components/parameters/tagsAllOf' | ||
154 | - $ref: '#/components/parameters/licenceOneOf' | ||
155 | - $ref: '#/components/parameters/languageOneOf' | ||
156 | - $ref: '#/components/parameters/nsfw' | ||
157 | - $ref: '#/components/parameters/filter' | ||
158 | - $ref: '#/components/parameters/skipCount' | ||
159 | - $ref: '#/components/parameters/start' | ||
160 | - $ref: '#/components/parameters/count' | ||
161 | - $ref: '#/components/parameters/videosSort' | ||
151 | responses: | 162 | responses: |
152 | '200': | 163 | '200': |
153 | description: successful operation | 164 | description: successful operation |
@@ -630,9 +641,17 @@ paths: | |||
630 | - My Subscriptions | 641 | - My Subscriptions |
631 | - Videos | 642 | - Videos |
632 | parameters: | 643 | parameters: |
644 | - $ref: '#/components/parameters/categoryOneOf' | ||
645 | - $ref: '#/components/parameters/tagsOneOf' | ||
646 | - $ref: '#/components/parameters/tagsAllOf' | ||
647 | - $ref: '#/components/parameters/licenceOneOf' | ||
648 | - $ref: '#/components/parameters/languageOneOf' | ||
649 | - $ref: '#/components/parameters/nsfw' | ||
650 | - $ref: '#/components/parameters/filter' | ||
651 | - $ref: '#/components/parameters/skipCount' | ||
633 | - $ref: '#/components/parameters/start' | 652 | - $ref: '#/components/parameters/start' |
634 | - $ref: '#/components/parameters/count' | 653 | - $ref: '#/components/parameters/count' |
635 | - $ref: '#/components/parameters/sort' | 654 | - $ref: '#/components/parameters/videosSort' |
636 | responses: | 655 | responses: |
637 | '200': | 656 | '200': |
638 | description: successful operation | 657 | description: successful operation |
@@ -768,6 +787,7 @@ paths: | |||
768 | - $ref: '#/components/parameters/languageOneOf' | 787 | - $ref: '#/components/parameters/languageOneOf' |
769 | - $ref: '#/components/parameters/nsfw' | 788 | - $ref: '#/components/parameters/nsfw' |
770 | - $ref: '#/components/parameters/filter' | 789 | - $ref: '#/components/parameters/filter' |
790 | - $ref: '#/components/parameters/skipCount' | ||
771 | - $ref: '#/components/parameters/start' | 791 | - $ref: '#/components/parameters/start' |
772 | - $ref: '#/components/parameters/count' | 792 | - $ref: '#/components/parameters/count' |
773 | - $ref: '#/components/parameters/videosSort' | 793 | - $ref: '#/components/parameters/videosSort' |
@@ -1459,6 +1479,17 @@ paths: | |||
1459 | - Video Channels | 1479 | - Video Channels |
1460 | parameters: | 1480 | parameters: |
1461 | - $ref: '#/components/parameters/channelHandle' | 1481 | - $ref: '#/components/parameters/channelHandle' |
1482 | - $ref: '#/components/parameters/categoryOneOf' | ||
1483 | - $ref: '#/components/parameters/tagsOneOf' | ||
1484 | - $ref: '#/components/parameters/tagsAllOf' | ||
1485 | - $ref: '#/components/parameters/licenceOneOf' | ||
1486 | - $ref: '#/components/parameters/languageOneOf' | ||
1487 | - $ref: '#/components/parameters/nsfw' | ||
1488 | - $ref: '#/components/parameters/filter' | ||
1489 | - $ref: '#/components/parameters/skipCount' | ||
1490 | - $ref: '#/components/parameters/start' | ||
1491 | - $ref: '#/components/parameters/count' | ||
1492 | - $ref: '#/components/parameters/videosSort' | ||
1462 | responses: | 1493 | responses: |
1463 | '200': | 1494 | '200': |
1464 | description: successful operation | 1495 | description: successful operation |
@@ -1894,8 +1925,17 @@ paths: | |||
1894 | - Search | 1925 | - Search |
1895 | summary: Search videos | 1926 | summary: Search videos |
1896 | parameters: | 1927 | parameters: |
1928 | - $ref: '#/components/parameters/categoryOneOf' | ||
1929 | - $ref: '#/components/parameters/tagsOneOf' | ||
1930 | - $ref: '#/components/parameters/tagsAllOf' | ||
1931 | - $ref: '#/components/parameters/licenceOneOf' | ||
1932 | - $ref: '#/components/parameters/languageOneOf' | ||
1933 | - $ref: '#/components/parameters/nsfw' | ||
1934 | - $ref: '#/components/parameters/filter' | ||
1935 | - $ref: '#/components/parameters/skipCount' | ||
1897 | - $ref: '#/components/parameters/start' | 1936 | - $ref: '#/components/parameters/start' |
1898 | - $ref: '#/components/parameters/count' | 1937 | - $ref: '#/components/parameters/count' |
1938 | - $ref: '#/components/parameters/videosSort' | ||
1899 | - $ref: '#/components/parameters/videosSearchSort' | 1939 | - $ref: '#/components/parameters/videosSearchSort' |
1900 | - name: search | 1940 | - name: search |
1901 | in: query | 1941 | in: query |
@@ -2094,7 +2134,7 @@ components: | |||
2094 | name: categoryOneOf | 2134 | name: categoryOneOf |
2095 | in: query | 2135 | in: query |
2096 | required: false | 2136 | required: false |
2097 | description: category id of the video | 2137 | description: category id of the video (see /videos/categories) |
2098 | schema: | 2138 | schema: |
2099 | oneOf: | 2139 | oneOf: |
2100 | - type: number | 2140 | - type: number |
@@ -2133,7 +2173,7 @@ components: | |||
2133 | name: languageOneOf | 2173 | name: languageOneOf |
2134 | in: query | 2174 | in: query |
2135 | required: false | 2175 | required: false |
2136 | description: language id of the video | 2176 | description: language id of the video (see /videos/languages). Use _unknown to filter on videos that don't have a video language |
2137 | schema: | 2177 | schema: |
2138 | oneOf: | 2178 | oneOf: |
2139 | - type: string | 2179 | - type: string |
@@ -2146,7 +2186,7 @@ components: | |||
2146 | name: licenceOneOf | 2186 | name: licenceOneOf |
2147 | in: query | 2187 | in: query |
2148 | required: false | 2188 | required: false |
2149 | description: licence id of the video | 2189 | description: licence id of the video (see /videos/licences) |
2150 | schema: | 2190 | schema: |
2151 | oneOf: | 2191 | oneOf: |
2152 | - type: number | 2192 | - type: number |
@@ -2155,6 +2195,16 @@ components: | |||
2155 | type: number | 2195 | type: number |
2156 | style: form | 2196 | style: form |
2157 | explode: false | 2197 | explode: false |
2198 | skipCount: | ||
2199 | name: skipCount | ||
2200 | in: query | ||
2201 | required: false | ||
2202 | description: if you don't need the `total` in the response | ||
2203 | schema: | ||
2204 | type: string | ||
2205 | enum: | ||
2206 | - 'true' | ||
2207 | - 'false' | ||
2158 | nsfw: | 2208 | nsfw: |
2159 | name: nsfw | 2209 | name: nsfw |
2160 | in: query | 2210 | in: query |