diff options
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/openapi.yaml | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index dee86d83d..e9e84b139 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -414,6 +414,36 @@ paths: | |||
414 | 414 | ||
415 | print(json) | 415 | print(json) |
416 | 416 | ||
417 | '/accounts/{name}/followers': | ||
418 | get: | ||
419 | tags: | ||
420 | - Accounts | ||
421 | summary: 'List followers of an account' | ||
422 | security: | ||
423 | - OAuth2: [] | ||
424 | operationId: getAccountFollowers | ||
425 | parameters: | ||
426 | - $ref: '#/components/parameters/name' | ||
427 | - $ref: '#/components/parameters/start' | ||
428 | - $ref: '#/components/parameters/count' | ||
429 | - $ref: '#/components/parameters/followersSort' | ||
430 | - $ref: '#/components/parameters/search' | ||
431 | responses: | ||
432 | '200': | ||
433 | description: successful operation | ||
434 | content: | ||
435 | application/json: | ||
436 | schema: | ||
437 | type: object | ||
438 | properties: | ||
439 | total: | ||
440 | type: integer | ||
441 | example: 1 | ||
442 | data: | ||
443 | type: array | ||
444 | items: | ||
445 | $ref: '#/components/schemas/Follow' | ||
446 | |||
417 | /accounts: | 447 | /accounts: |
418 | get: | 448 | get: |
419 | tags: | 449 | tags: |
@@ -2832,6 +2862,36 @@ paths: | |||
2832 | schema: | 2862 | schema: |
2833 | $ref: '#/components/schemas/VideoListResponse' | 2863 | $ref: '#/components/schemas/VideoListResponse' |
2834 | 2864 | ||
2865 | '/video-channels/{channelHandle}/followers': | ||
2866 | get: | ||
2867 | tags: | ||
2868 | - Video Channels | ||
2869 | summary: 'List followers of a video channel' | ||
2870 | security: | ||
2871 | - OAuth2: [] | ||
2872 | operationId: getVideoChannelFollowers | ||
2873 | parameters: | ||
2874 | - $ref: '#/components/parameters/channelHandle' | ||
2875 | - $ref: '#/components/parameters/start' | ||
2876 | - $ref: '#/components/parameters/count' | ||
2877 | - $ref: '#/components/parameters/followersSort' | ||
2878 | - $ref: '#/components/parameters/search' | ||
2879 | responses: | ||
2880 | '200': | ||
2881 | description: successful operation | ||
2882 | content: | ||
2883 | application/json: | ||
2884 | schema: | ||
2885 | type: object | ||
2886 | properties: | ||
2887 | total: | ||
2888 | type: integer | ||
2889 | example: 1 | ||
2890 | data: | ||
2891 | type: array | ||
2892 | items: | ||
2893 | $ref: '#/components/schemas/Follow' | ||
2894 | |||
2835 | '/video-channels/{channelHandle}/avatar/pick': | 2895 | '/video-channels/{channelHandle}/avatar/pick': |
2836 | post: | 2896 | post: |
2837 | summary: Update channel avatar | 2897 | summary: Update channel avatar |
@@ -4532,6 +4592,15 @@ components: | |||
4532 | type: string | 4592 | type: string |
4533 | enum: | 4593 | enum: |
4534 | - name | 4594 | - name |
4595 | followersSort: | ||
4596 | name: sort | ||
4597 | in: query | ||
4598 | required: false | ||
4599 | description: Sort followers by criteria | ||
4600 | schema: | ||
4601 | type: string | ||
4602 | enum: | ||
4603 | - createdAt | ||
4535 | name: | 4604 | name: |
4536 | name: name | 4605 | name: name |
4537 | in: path | 4606 | in: path |