diff options
author | Chocobozzz <me@florianbigard.com> | 2021-12-07 11:30:53 +0100 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2021-12-07 11:30:53 +0100 |
commit | bdf70330e4d74091ccc9d64534d3f780d5ee8ef4 (patch) | |
tree | 8ddcb302483b4e3420fc91173e564c8e0052ed25 /support/doc | |
parent | d9f9804d8642b11001cb75aaef597e12825abe21 (diff) | |
download | PeerTube-bdf70330e4d74091ccc9d64534d3f780d5ee8ef4.tar.gz PeerTube-bdf70330e4d74091ccc9d64534d3f780d5ee8ef4.tar.zst PeerTube-bdf70330e4d74091ccc9d64534d3f780d5ee8ef4.zip |
Add account block status in openapi
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/openapi.yaml | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index cfba7b361..1d5581072 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -3792,6 +3792,39 @@ paths: | |||
3792 | '500': | 3792 | '500': |
3793 | description: search index unavailable | 3793 | description: search index unavailable |
3794 | 3794 | ||
3795 | /blocklist/status: | ||
3796 | get: | ||
3797 | tags: | ||
3798 | - Account Blocks | ||
3799 | - Server Blocks | ||
3800 | summary: Get block status of accounts/hosts | ||
3801 | parameters: | ||
3802 | - | ||
3803 | name: 'accounts' | ||
3804 | in: query | ||
3805 | description: 'Check if these accounts are blocked' | ||
3806 | example: [ 'goofy@example.com', 'donald@example.com' ] | ||
3807 | schema: | ||
3808 | type: array | ||
3809 | items: | ||
3810 | type: string | ||
3811 | - | ||
3812 | name: 'hosts' | ||
3813 | in: query | ||
3814 | description: 'Check if these hosts are blocked' | ||
3815 | example: [ 'example.com' ] | ||
3816 | schema: | ||
3817 | type: array | ||
3818 | items: | ||
3819 | type: string | ||
3820 | responses: | ||
3821 | '200': | ||
3822 | description: successful operation | ||
3823 | content: | ||
3824 | 'application/json': | ||
3825 | schema: | ||
3826 | $ref: '#/components/schemas/BlockStatus' | ||
3827 | |||
3795 | /server/blocklist/accounts: | 3828 | /server/blocklist/accounts: |
3796 | get: | 3829 | get: |
3797 | tags: | 3830 | tags: |
@@ -5134,6 +5167,29 @@ components: | |||
5134 | label: | 5167 | label: |
5135 | type: string | 5168 | type: string |
5136 | 5169 | ||
5170 | BlockStatus: | ||
5171 | properties: | ||
5172 | accounts: | ||
5173 | type: object | ||
5174 | additionalProperties: | ||
5175 | x-additionalPropertiesName: account | ||
5176 | type: object | ||
5177 | properties: | ||
5178 | blockedByServer: | ||
5179 | type: boolean | ||
5180 | blockedByUser: | ||
5181 | type: boolean | ||
5182 | hosts: | ||
5183 | type: object | ||
5184 | additionalProperties: | ||
5185 | x-additionalPropertiesName: host | ||
5186 | type: object | ||
5187 | properties: | ||
5188 | blockedByServer: | ||
5189 | type: boolean | ||
5190 | blockedByUser: | ||
5191 | type: boolean | ||
5192 | |||
5137 | NSFWPolicy: | 5193 | NSFWPolicy: |
5138 | type: string | 5194 | type: string |
5139 | enum: | 5195 | enum: |