aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2022-04-15 14:50:09 +0200
committerChocobozzz <me@florianbigard.com>2022-04-15 14:50:09 +0200
commitd09ed46e71b78b4874de4afabefa2f9453c5894d (patch)
tree8b81c31b8980302344303bc4608379bb868f7f8e /support/doc/api
parentef3de8de216d63f3ac8166c5699be9a9c37f152b (diff)
downloadPeerTube-d09ed46e71b78b4874de4afabefa2f9453c5894d.tar.gz
PeerTube-d09ed46e71b78b4874de4afabefa2f9453c5894d.tar.zst
PeerTube-d09ed46e71b78b4874de4afabefa2f9453c5894d.zip
Improve videos sort documentation
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml28
1 files changed, 18 insertions, 10 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 407f3eb10..60b2fe168 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -4781,23 +4781,31 @@ components:
4781 name: sort 4781 name: sort
4782 in: query 4782 in: query
4783 required: false 4783 required: false
4784 description: Sort videos by criteria
4785 schema: 4784 schema:
4786 type: string 4785 type: string
4787 enum: 4786 enum:
4788 - name 4787 - name
4789 - -duration 4788 - -duration
4790 - -createdAt 4789 - -createdAt
4791 - -publishedAt 4790 - -publishedAt
4792 - -views 4791 - -views
4793 - -likes 4792 - -likes
4794 - -trending 4793 - -trending
4795 - -hot 4794 - -hot
4795 - -best
4796 description: >
4797 Sort videos by criteria (prefixing with `-` means `DESC` order):
4798 * `hot` - Adaptation of Reddit "hot" algorithm taking into account video views, likes, dislikes and comments and publication date
4799 * `best` - Same than `hot`, but also takes into account user video history
4800 * `trending` - Sort videos by recent views ("recent" is defined by the admin)
4801 * `views` - Sort videos using their `views` counter
4802 * `publishedAt` - Sort by video publication date (when it became publicly available)
4796 videosSearchSort: 4803 videosSearchSort:
4797 name: sort 4804 name: sort
4798 in: query 4805 in: query
4799 required: false 4806 required: false
4800 description: Sort videos by criteria 4807 description: >
4808 Sort videos by criteria (prefixing with `-` means `DESC` order):
4801 schema: 4809 schema:
4802 type: string 4810 type: string
4803 enum: 4811 enum: