diff options
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/openapi.yaml | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index b43b6bfa0..ada4f1b7b 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -3584,6 +3584,47 @@ paths: | |||
3584 | '500': | 3584 | '500': |
3585 | description: search index unavailable | 3585 | description: search index unavailable |
3586 | 3586 | ||
3587 | /search/video-playlists: | ||
3588 | get: | ||
3589 | tags: | ||
3590 | - Search | ||
3591 | summary: Search playlists | ||
3592 | operationId: searchPlaylists | ||
3593 | parameters: | ||
3594 | - name: search | ||
3595 | in: query | ||
3596 | required: true | ||
3597 | description: > | ||
3598 | String to search. If the user can make a remote URI search, and the string is an URI then the | ||
3599 | PeerTube instance will fetch the remote object and add it to its database. Then, | ||
3600 | you can use the REST API to fetch the complete playlist information and interact with it. | ||
3601 | schema: | ||
3602 | type: string | ||
3603 | - $ref: '#/components/parameters/start' | ||
3604 | - $ref: '#/components/parameters/count' | ||
3605 | - $ref: '#/components/parameters/searchTarget' | ||
3606 | - $ref: '#/components/parameters/sort' | ||
3607 | callbacks: | ||
3608 | 'searchTarget === search-index': | ||
3609 | $ref: '#/components/callbacks/searchIndex' | ||
3610 | responses: | ||
3611 | '200': | ||
3612 | description: successful operation | ||
3613 | content: | ||
3614 | application/json: | ||
3615 | schema: | ||
3616 | type: object | ||
3617 | properties: | ||
3618 | total: | ||
3619 | type: integer | ||
3620 | example: 1 | ||
3621 | data: | ||
3622 | type: array | ||
3623 | items: | ||
3624 | $ref: '#/components/schemas/VideoPlaylist' | ||
3625 | '500': | ||
3626 | description: search index unavailable | ||
3627 | |||
3587 | /server/blocklist/accounts: | 3628 | /server/blocklist/accounts: |
3588 | get: | 3629 | get: |
3589 | tags: | 3630 | tags: |