interesting
/
PeerTube
mirror of https://github.com/Chocobozzz/PeerTube.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add videos list filters param in api doc

This commit is contained in:
Chocobozzz 2020-04-21 16:03:51 +02:00
parent 98639806c0
commit 59c794a5dc
No known key found for this signature in database
GPG Key ID: 583A612D890159BE
1 changed files with 54 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
support/doc/api/openapi.yaml
View File

@ -148,6 +148,17 @@ paths:
summary: 'List videos of an account' summary: 'List videos of an account'
parameters: parameters:
- $ref: '#/components/parameters/name' - $ref: '#/components/parameters/name'
- $ref: '#/components/parameters/categoryOneOf'
- $ref: '#/components/parameters/tagsOneOf'
- $ref: '#/components/parameters/tagsAllOf'
- $ref: '#/components/parameters/licenceOneOf'
- $ref: '#/components/parameters/languageOneOf'
- $ref: '#/components/parameters/nsfw'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/skipCount'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/videosSort'
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -630,9 +641,17 @@ paths:
- My Subscriptions - My Subscriptions
- Videos - Videos
parameters: parameters:
- $ref: '#/components/parameters/categoryOneOf'
- $ref: '#/components/parameters/tagsOneOf'
- $ref: '#/components/parameters/tagsAllOf'
- $ref: '#/components/parameters/licenceOneOf'
- $ref: '#/components/parameters/languageOneOf'
- $ref: '#/components/parameters/nsfw'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/skipCount'
- $ref: '#/components/parameters/start' - $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count' - $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/sort' - $ref: '#/components/parameters/videosSort'
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -768,6 +787,7 @@ paths:
- $ref: '#/components/parameters/languageOneOf' - $ref: '#/components/parameters/languageOneOf'
- $ref: '#/components/parameters/nsfw' - $ref: '#/components/parameters/nsfw'
- $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/skipCount'
- $ref: '#/components/parameters/start' - $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count' - $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/videosSort' - $ref: '#/components/parameters/videosSort'
@ -1459,6 +1479,17 @@ paths:
- Video Channels - Video Channels
parameters: parameters:
- $ref: '#/components/parameters/channelHandle' - $ref: '#/components/parameters/channelHandle'
- $ref: '#/components/parameters/categoryOneOf'
- $ref: '#/components/parameters/tagsOneOf'
- $ref: '#/components/parameters/tagsAllOf'
- $ref: '#/components/parameters/licenceOneOf'
- $ref: '#/components/parameters/languageOneOf'
- $ref: '#/components/parameters/nsfw'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/skipCount'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/videosSort'
responses: responses:
'200': '200':
description: successful operation description: successful operation
@ -1894,8 +1925,17 @@ paths:
- Search - Search
summary: Search videos summary: Search videos
parameters: parameters:
- $ref: '#/components/parameters/categoryOneOf'
- $ref: '#/components/parameters/tagsOneOf'
- $ref: '#/components/parameters/tagsAllOf'
- $ref: '#/components/parameters/licenceOneOf'
- $ref: '#/components/parameters/languageOneOf'
- $ref: '#/components/parameters/nsfw'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/skipCount'
- $ref: '#/components/parameters/start' - $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/count' - $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/videosSort'
- $ref: '#/components/parameters/videosSearchSort' - $ref: '#/components/parameters/videosSearchSort'
- name: search - name: search
in: query in: query
@ -2094,7 +2134,7 @@ components:
name: categoryOneOf name: categoryOneOf
in: query in: query
required: false required: false
description: category id of the video description: category id of the video (see /videos/categories)
schema: schema:
oneOf: oneOf:
- type: number - type: number
@ -2133,7 +2173,7 @@ components:
name: languageOneOf name: languageOneOf
in: query in: query
required: false required: false
description: language id of the video description: language id of the video (see /videos/languages). Use _unknown to filter on videos that don't have a video language
schema: schema:
oneOf: oneOf:
- type: string - type: string
@ -2146,7 +2186,7 @@ components:
name: licenceOneOf name: licenceOneOf
in: query in: query
required: false required: false
description: licence id of the video description: licence id of the video (see /videos/licences)
schema: schema:
oneOf: oneOf:
- type: number - type: number
@ -2155,6 +2195,16 @@ components:
type: number type: number
style: form style: form
explode: false explode: false
skipCount:
name: skipCount
in: query
required: false
description: if you don't need the `total` in the response
schema:
type: string
enum:
- 'true'
- 'false'
nsfw: nsfw:
name: nsfw name: nsfw
in: query in: query