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

Improve videos sort documentation

pull/4903/head
Chocobozzz 2022-04-15 14:50:09 +02:00
parent ef3de8de21
commit d09ed46e71
No known key found for this signature in database
GPG Key ID: 583A612D890159BE
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -4781,23 +4781,31 @@ components:
name: sort name: sort
in: query in: query
required: false required: false
description: Sort videos by criteria
schema: schema:
type: string type: string
enum: enum:
- name - name
- -duration - -duration
- -createdAt - -createdAt
- -publishedAt - -publishedAt
- -views - -views
- -likes - -likes
- -trending - -trending
- -hot - -hot
- -best
description: >
Sort videos by criteria (prefixing with `-` means `DESC` order):
* `hot` - Adaptation of Reddit "hot" algorithm taking into account video views, likes, dislikes and comments and publication date
* `best` - Same than `hot`, but also takes into account user video history
* `trending` - Sort videos by recent views ("recent" is defined by the admin)
* `views` - Sort videos using their `views` counter
* `publishedAt` - Sort by video publication date (when it became publicly available)
videosSearchSort: videosSearchSort:
name: sort name: sort
in: query in: query
required: false required: false
description: Sort videos by criteria description: >
Sort videos by criteria (prefixing with `-` means `DESC` order):
schema: schema:
type: string type: string
enum: enum: