mirror of
https://github.com/Chocobozzz/PeerTube.git
synced 2024-09-11 21:47:09 +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',
|
'originallyPublishedEndDate',
|
||||||
'durationMin',
|
'durationMin',
|
||||||
'durationMax',
|
'durationMax',
|
||||||
'uuids',
|
'uuids'
|
||||||
'excludeAlreadyWatched'
|
|
||||||
])
|
])
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -5321,6 +5321,7 @@ paths:
|
|||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- Search
|
- Search
|
||||||
|
- Video
|
||||||
summary: Search videos
|
summary: Search videos
|
||||||
operationId: searchVideos
|
operationId: searchVideos
|
||||||
parameters:
|
parameters:
|
||||||
@ -5353,6 +5354,7 @@ paths:
|
|||||||
- $ref: '#/components/parameters/searchTarget'
|
- $ref: '#/components/parameters/searchTarget'
|
||||||
- $ref: '#/components/parameters/videosSearchSort'
|
- $ref: '#/components/parameters/videosSearchSort'
|
||||||
- $ref: '#/components/parameters/excludeAlreadyWatched'
|
- $ref: '#/components/parameters/excludeAlreadyWatched'
|
||||||
|
- $ref: '#/components/parameters/host'
|
||||||
- name: startDate
|
- name: startDate
|
||||||
in: query
|
in: query
|
||||||
description: Get videos that are published after this date
|
description: Get videos that are published after this date
|
||||||
@ -5404,6 +5406,7 @@ paths:
|
|||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- Search
|
- Search
|
||||||
|
- Video Channels
|
||||||
summary: Search channels
|
summary: Search channels
|
||||||
operationId: searchChannels
|
operationId: searchChannels
|
||||||
parameters:
|
parameters:
|
||||||
@ -5420,6 +5423,8 @@ paths:
|
|||||||
- $ref: '#/components/parameters/count'
|
- $ref: '#/components/parameters/count'
|
||||||
- $ref: '#/components/parameters/searchTarget'
|
- $ref: '#/components/parameters/searchTarget'
|
||||||
- $ref: '#/components/parameters/sort'
|
- $ref: '#/components/parameters/sort'
|
||||||
|
- $ref: '#/components/parameters/host'
|
||||||
|
- $ref: '#/components/parameters/handles'
|
||||||
callbacks:
|
callbacks:
|
||||||
'searchTarget === search-index':
|
'searchTarget === search-index':
|
||||||
$ref: '#/components/callbacks/searchIndex'
|
$ref: '#/components/callbacks/searchIndex'
|
||||||
@ -5437,6 +5442,7 @@ paths:
|
|||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- Search
|
- Search
|
||||||
|
- Video Playlists
|
||||||
summary: Search playlists
|
summary: Search playlists
|
||||||
operationId: searchPlaylists
|
operationId: searchPlaylists
|
||||||
parameters:
|
parameters:
|
||||||
@ -5453,6 +5459,8 @@ paths:
|
|||||||
- $ref: '#/components/parameters/count'
|
- $ref: '#/components/parameters/count'
|
||||||
- $ref: '#/components/parameters/searchTarget'
|
- $ref: '#/components/parameters/searchTarget'
|
||||||
- $ref: '#/components/parameters/sort'
|
- $ref: '#/components/parameters/sort'
|
||||||
|
- $ref: '#/components/parameters/host'
|
||||||
|
- $ref: '#/components/parameters/uuids'
|
||||||
callbacks:
|
callbacks:
|
||||||
'searchTarget === search-index':
|
'searchTarget === search-index':
|
||||||
$ref: '#/components/callbacks/searchIndex'
|
$ref: '#/components/callbacks/searchIndex'
|
||||||
@ -6993,7 +7001,22 @@ components:
|
|||||||
schema:
|
schema:
|
||||||
items:
|
items:
|
||||||
type: string
|
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:
|
include:
|
||||||
name: include
|
name: include
|
||||||
in: query
|
in: query
|
||||||
|
Loading…
Reference in New Issue
Block a user