aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorWicklow <123956049+wickloww@users.noreply.github.com>2023-04-12 07:32:20 +0000
committerGitHub <noreply@github.com>2023-04-12 09:32:20 +0200
commit2a4c0d8bbe29178ae90e776bb9453f86e6d23bd9 (patch)
treedfe4b6e1e06f617f8968285ca394e73fedefe6b2 /support/doc/api
parent0cda019c1d1f77e06e524362880c38e93b1f5c70 (diff)
downloadPeerTube-2a4c0d8bbe29178ae90e776bb9453f86e6d23bd9.tar.gz
PeerTube-2a4c0d8bbe29178ae90e776bb9453f86e6d23bd9.tar.zst
PeerTube-2a4c0d8bbe29178ae90e776bb9453f86e6d23bd9.zip
Feature/filter already watched videos (#5739)
* filter already watched videos * Updated code based on review comments
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml11
1 files changed, 11 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 046eec544..a36ae0c7e 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -717,6 +717,7 @@ paths:
717 - $ref: '#/components/parameters/start' 717 - $ref: '#/components/parameters/start'
718 - $ref: '#/components/parameters/count' 718 - $ref: '#/components/parameters/count'
719 - $ref: '#/components/parameters/videosSort' 719 - $ref: '#/components/parameters/videosSort'
720 - $ref: '#/components/parameters/excludeAlreadyWatched'
720 responses: 721 responses:
721 '200': 722 '200':
722 description: successful operation 723 description: successful operation
@@ -1835,6 +1836,7 @@ paths:
1835 - $ref: '#/components/parameters/start' 1836 - $ref: '#/components/parameters/start'
1836 - $ref: '#/components/parameters/count' 1837 - $ref: '#/components/parameters/count'
1837 - $ref: '#/components/parameters/videosSort' 1838 - $ref: '#/components/parameters/videosSort'
1839 - $ref: '#/components/parameters/excludeAlreadyWatched'
1838 responses: 1840 responses:
1839 '200': 1841 '200':
1840 description: successful operation 1842 description: successful operation
@@ -2378,6 +2380,7 @@ paths:
2378 - $ref: '#/components/parameters/start' 2380 - $ref: '#/components/parameters/start'
2379 - $ref: '#/components/parameters/count' 2381 - $ref: '#/components/parameters/count'
2380 - $ref: '#/components/parameters/videosSort' 2382 - $ref: '#/components/parameters/videosSort'
2383 - $ref: '#/components/parameters/excludeAlreadyWatched'
2381 responses: 2384 responses:
2382 '200': 2385 '200':
2383 description: successful operation 2386 description: successful operation
@@ -3799,6 +3802,7 @@ paths:
3799 - $ref: '#/components/parameters/start' 3802 - $ref: '#/components/parameters/start'
3800 - $ref: '#/components/parameters/count' 3803 - $ref: '#/components/parameters/count'
3801 - $ref: '#/components/parameters/videosSort' 3804 - $ref: '#/components/parameters/videosSort'
3805 - $ref: '#/components/parameters/excludeAlreadyWatched'
3802 responses: 3806 responses:
3803 '200': 3807 '200':
3804 description: successful operation 3808 description: successful operation
@@ -4742,6 +4746,7 @@ paths:
4742 - $ref: '#/components/parameters/count' 4746 - $ref: '#/components/parameters/count'
4743 - $ref: '#/components/parameters/searchTarget' 4747 - $ref: '#/components/parameters/searchTarget'
4744 - $ref: '#/components/parameters/videosSearchSort' 4748 - $ref: '#/components/parameters/videosSearchSort'
4749 - $ref: '#/components/parameters/excludeAlreadyWatched'
4745 - name: startDate 4750 - name: startDate
4746 in: query 4751 in: query
4747 description: Get videos that are published after this date 4752 description: Get videos that are published after this date
@@ -5872,6 +5877,12 @@ components:
5872 schema: 5877 schema:
5873 $ref: '#/components/schemas/VideoPrivacySet' 5878 $ref: '#/components/schemas/VideoPrivacySet'
5874 description: '**PeerTube >= 4.0** Display only videos in this specific privacy/privacies' 5879 description: '**PeerTube >= 4.0** Display only videos in this specific privacy/privacies'
5880 excludeAlreadyWatched:
5881 name: excludeAlreadyWatched
5882 in: query
5883 description: Whether or not to exclude videos that are in the user's video history
5884 schema:
5885 type: boolean
5875 uuids: 5886 uuids:
5876 name: uuids 5887 name: uuids
5877 in: query 5888 in: query