mirror of
https://github.com/Chocobozzz/PeerTube.git
synced 2024-08-17 17:30:32 +03:00
Update search REST API doc
This commit is contained in:
parent
c5de763d3d
commit
b7e07bde8c
@ -43,8 +43,7 @@ function pickSearchVideoQuery (query: VideosSearchQueryAfterSanitize) {
|
||||
'originallyPublishedEndDate',
|
||||
'durationMin',
|
||||
'durationMax',
|
||||
'uuids',
|
||||
'excludeAlreadyWatched'
|
||||
'uuids'
|
||||
])
|
||||
}
|
||||
}
|
||||
|
@ -5321,6 +5321,7 @@ paths:
|
||||
get:
|
||||
tags:
|
||||
- Search
|
||||
- Video
|
||||
summary: Search videos
|
||||
operationId: searchVideos
|
||||
parameters:
|
||||
@ -5353,6 +5354,7 @@ paths:
|
||||
- $ref: '#/components/parameters/searchTarget'
|
||||
- $ref: '#/components/parameters/videosSearchSort'
|
||||
- $ref: '#/components/parameters/excludeAlreadyWatched'
|
||||
- $ref: '#/components/parameters/host'
|
||||
- name: startDate
|
||||
in: query
|
||||
description: Get videos that are published after this date
|
||||
@ -5404,6 +5406,7 @@ paths:
|
||||
get:
|
||||
tags:
|
||||
- Search
|
||||
- Video Channels
|
||||
summary: Search channels
|
||||
operationId: searchChannels
|
||||
parameters:
|
||||
@ -5420,6 +5423,8 @@ paths:
|
||||
- $ref: '#/components/parameters/count'
|
||||
- $ref: '#/components/parameters/searchTarget'
|
||||
- $ref: '#/components/parameters/sort'
|
||||
- $ref: '#/components/parameters/host'
|
||||
- $ref: '#/components/parameters/handles'
|
||||
callbacks:
|
||||
'searchTarget === search-index':
|
||||
$ref: '#/components/callbacks/searchIndex'
|
||||
@ -5437,6 +5442,7 @@ paths:
|
||||
get:
|
||||
tags:
|
||||
- Search
|
||||
- Video Playlists
|
||||
summary: Search playlists
|
||||
operationId: searchPlaylists
|
||||
parameters:
|
||||
@ -5453,6 +5459,8 @@ paths:
|
||||
- $ref: '#/components/parameters/count'
|
||||
- $ref: '#/components/parameters/searchTarget'
|
||||
- $ref: '#/components/parameters/sort'
|
||||
- $ref: '#/components/parameters/host'
|
||||
- $ref: '#/components/parameters/uuids'
|
||||
callbacks:
|
||||
'searchTarget === search-index':
|
||||
$ref: '#/components/callbacks/searchIndex'
|
||||
@ -6993,7 +7001,22 @@ components:
|
||||
schema:
|
||||
items:
|
||||
type: string
|
||||
description: 'Find videos with specific UUIDs'
|
||||
description: 'Find elements with specific UUIDs'
|
||||
host:
|
||||
name: host
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
description: 'Find elements owned by this host'
|
||||
handles:
|
||||
name: handles
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
items:
|
||||
type: string
|
||||
description: 'Find elements with these handles'
|
||||
include:
|
||||
name: include
|
||||
in: query
|
||||
|
Loading…
Reference in New Issue
Block a user