diff options
author | Rigel Kent <sendmemail@rigelk.eu> | 2021-05-10 14:39:01 +0200 |
---|---|---|
committer | Rigel Kent <sendmemail@rigelk.eu> | 2021-05-10 14:43:44 +0200 |
commit | 045bcd0d18a13e8d2e0bdaf8ae2ebc83f2a7e7fc (patch) | |
tree | d0a298cc60d898b13716720807a7b99fdc34569a /support/doc | |
parent | 985ece57551515e3b10a83c4a826bf35913a992a (diff) | |
download | PeerTube-045bcd0d18a13e8d2e0bdaf8ae2ebc83f2a7e7fc.tar.gz PeerTube-045bcd0d18a13e8d2e0bdaf8ae2ebc83f2a7e7fc.tar.zst PeerTube-045bcd0d18a13e8d2e0bdaf8ae2ebc83f2a7e7fc.zip |
refactor subscriptions response from list to totalDataList in openapi spec
closes #4067
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/openapi.yaml | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index bfe3c6da4..4fbf5b055 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -804,6 +804,10 @@ paths: | |||
804 | responses: | 804 | responses: |
805 | '200': | 805 | '200': |
806 | description: successful operation | 806 | description: successful operation |
807 | content: | ||
808 | application/json: | ||
809 | schema: | ||
810 | $ref: '#/components/schemas/VideoChannelList' | ||
807 | post: | 811 | post: |
808 | tags: | 812 | tags: |
809 | - My Subscriptions | 813 | - My Subscriptions |
@@ -2301,15 +2305,7 @@ paths: | |||
2301 | content: | 2305 | content: |
2302 | application/json: | 2306 | application/json: |
2303 | schema: | 2307 | schema: |
2304 | type: object | 2308 | $ref: '#/components/schemas/VideoChannelList' |
2305 | properties: | ||
2306 | total: | ||
2307 | type: integer | ||
2308 | example: 1 | ||
2309 | data: | ||
2310 | type: array | ||
2311 | items: | ||
2312 | $ref: '#/components/schemas/VideoChannel' | ||
2313 | post: | 2309 | post: |
2314 | summary: Create a video channel | 2310 | summary: Create a video channel |
2315 | security: | 2311 | security: |
@@ -2846,14 +2842,7 @@ paths: | |||
2846 | content: | 2842 | content: |
2847 | application/json: | 2843 | application/json: |
2848 | schema: | 2844 | schema: |
2849 | properties: | 2845 | $ref: '#/components/schemas/VideoChannelList' |
2850 | total: | ||
2851 | type: integer | ||
2852 | example: 1 | ||
2853 | data: | ||
2854 | type: array | ||
2855 | items: | ||
2856 | $ref: '#/components/schemas/VideoChannel' | ||
2857 | '/accounts/{name}/ratings': | 2846 | '/accounts/{name}/ratings': |
2858 | get: | 2847 | get: |
2859 | summary: List ratings of an account | 2848 | summary: List ratings of an account |
@@ -3111,9 +3100,7 @@ paths: | |||
3111 | content: | 3100 | content: |
3112 | application/json: | 3101 | application/json: |
3113 | schema: | 3102 | schema: |
3114 | type: array | 3103 | $ref: '#/components/schemas/VideoChannelList' |
3115 | items: | ||
3116 | $ref: '#/components/schemas/VideoChannel' | ||
3117 | '500': | 3104 | '500': |
3118 | description: search index unavailable | 3105 | description: search index unavailable |
3119 | /blocklist/accounts: | 3106 | /blocklist/accounts: |
@@ -4993,6 +4980,8 @@ components: | |||
4993 | host: | 4980 | host: |
4994 | type: string | 4981 | type: string |
4995 | format: hostname | 4982 | format: hostname |
4983 | hostRedundancyAllowed: | ||
4984 | type: boolean | ||
4996 | followingCount: | 4985 | followingCount: |
4997 | type: integer | 4986 | type: integer |
4998 | followersCount: | 4987 | followersCount: |
@@ -5919,6 +5908,17 @@ components: | |||
5919 | bulkVideosSupportUpdate: | 5908 | bulkVideosSupportUpdate: |
5920 | type: boolean | 5909 | type: boolean |
5921 | description: 'Update the support field for all videos of this channel' | 5910 | description: 'Update the support field for all videos of this channel' |
5911 | VideoChannelList: | ||
5912 | properties: | ||
5913 | total: | ||
5914 | type: integer | ||
5915 | example: 1 | ||
5916 | data: | ||
5917 | type: array | ||
5918 | items: | ||
5919 | allOf: | ||
5920 | - $ref: '#/components/schemas/VideoChannel' | ||
5921 | - $ref: '#/components/schemas/Actor' | ||
5922 | 5922 | ||
5923 | MRSSPeerLink: | 5923 | MRSSPeerLink: |
5924 | type: object | 5924 | type: object |