aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api/openapi.yaml
diff options
context:
space:
mode:
authorRigel Kent <sendmemail@rigelk.eu>2020-07-02 22:49:51 +0200
committerRigel Kent <sendmemail@rigelk.eu>2020-07-02 22:50:33 +0200
commit8491293b02ed2ec53eb0fa128161ea0b08d3def9 (patch)
treeb3d8dd2732f5876e39c73b7d917a7ad02f4e021a /support/doc/api/openapi.yaml
parent2b587cad93381a1901df3c993bf1db90bbb0891f (diff)
downloadPeerTube-8491293b02ed2ec53eb0fa128161ea0b08d3def9.tar.gz
PeerTube-8491293b02ed2ec53eb0fa128161ea0b08d3def9.tar.zst
PeerTube-8491293b02ed2ec53eb0fa128161ea0b08d3def9.zip
add blocked filter in users list to filter banned users
fixes #2914
Diffstat (limited to 'support/doc/api/openapi.yaml')
-rw-r--r--support/doc/api/openapi.yaml26
1 files changed, 25 insertions, 1 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 2fc55b832..3c22a297f 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -518,10 +518,13 @@ paths:
518 get: 518 get:
519 summary: List users 519 summary: List users
520 security: 520 security:
521 - OAuth2: [] 521 - OAuth2:
522 - admin
522 tags: 523 tags:
523 - Users 524 - Users
524 parameters: 525 parameters:
526 - $ref: '#/components/parameters/usersSearch'
527 - $ref: '#/components/parameters/usersBlocked'
525 - $ref: '#/components/parameters/start' 528 - $ref: '#/components/parameters/start'
526 - $ref: '#/components/parameters/count' 529 - $ref: '#/components/parameters/count'
527 - $ref: '#/components/parameters/usersSort' 530 - $ref: '#/components/parameters/usersSort'
@@ -3148,6 +3151,13 @@ components:
3148 schema: 3151 schema:
3149 type: string 3152 type: string
3150 example: -createdAt 3153 example: -createdAt
3154 search:
3155 name: search
3156 in: query
3157 required: false
3158 description: Plain text search, applied to various parts of the model depending on endpoint
3159 schema:
3160 type: string
3151 searchTarget: 3161 searchTarget:
3152 name: searchTarget 3162 name: searchTarget
3153 in: query 3163 in: query
@@ -3224,6 +3234,20 @@ components:
3224 - -dislikes 3234 - -dislikes
3225 - -uuid 3235 - -uuid
3226 - -createdAt 3236 - -createdAt
3237 usersSearch:
3238 name: search
3239 in: query
3240 required: false
3241 description: Plain text search that will match with user usernames or emails
3242 schema:
3243 type: string
3244 usersBlocked:
3245 name: blocked
3246 in: query
3247 required: false
3248 description: Filter results down to (un)banned users
3249 schema:
3250 type: boolean
3227 usersSort: 3251 usersSort:
3228 name: sort 3252 name: sort
3229 in: query 3253 in: query