Update search REST API doc

pull/6422/head
Chocobozzz 2024-05-28 08:23:53 +02:00
parent c5de763d3d
commit b7e07bde8c
No known key found for this signature in database
GPG Key ID: 583A612D890159BE
2 changed files with 25 additions and 3 deletions

View File

@ -43,8 +43,7 @@ function pickSearchVideoQuery (query: VideosSearchQueryAfterSanitize) {
'originallyPublishedEndDate', 'originallyPublishedEndDate',
'durationMin', 'durationMin',
'durationMax', 'durationMax',
'uuids', 'uuids'
'excludeAlreadyWatched'
]) ])
} }
} }

View File

@ -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