aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc
diff options
context:
space:
mode:
authorArman <Arman1371@gmail.com>2020-11-26 02:57:59 +0330
committerGitHub <noreply@github.com>2020-11-26 00:27:59 +0100
commit3520d38515f5e83320ef4e54cb837b3b91fedf90 (patch)
treee8f0e92c71cff5c42392cd113fb3cca74a957ff5 /support/doc
parentffeb3bf40d08f541f4c678094fbf515b6e55baf4 (diff)
downloadPeerTube-3520d38515f5e83320ef4e54cb837b3b91fedf90.tar.gz
PeerTube-3520d38515f5e83320ef4e54cb837b3b91fedf90.tar.zst
PeerTube-3520d38515f5e83320ef4e54cb837b3b91fedf90.zip
add My History API to openapi (#3363)
Co-authored-by: Rigel Kent <sendmemail@rigelk.eu> Co-authored-by: Rigel Kent <par@rigelk.eu>
Diffstat (limited to 'support/doc')
-rw-r--r--support/doc/api/openapi.yaml41
1 files changed, 41 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 4feca5d99..6dd51ec7c 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -70,6 +70,9 @@ tags:
70 description: > 70 description: >
71 Operations related to your subscriptions to video channels, their 71 Operations related to your subscriptions to video channels, their
72 new videos, and how to keep up to date with their latest publications! 72 new videos, and how to keep up to date with their latest publications!
73 - name: My History
74 description: >
75 Operations related to your watch history.
73 - name: My Notifications 76 - name: My Notifications
74 description: > 77 description: >
75 Notifications following new videos, follows or reports. They allow you 78 Notifications following new videos, follows or reports. They allow you
@@ -150,6 +153,7 @@ x-tagGroups:
150 - My User 153 - My User
151 - My Subscriptions 154 - My Subscriptions
152 - My Notifications 155 - My Notifications
156 - My History
153 - name: Videos 157 - name: Videos
154 tags: 158 tags:
155 - Video 159 - Video
@@ -917,6 +921,43 @@ paths:
917 responses: 921 responses:
918 '204': 922 '204':
919 description: successful operation 923 description: successful operation
924 /users/me/history/videos:
925 get:
926 summary: List watched videos history
927 security:
928 - OAuth2: []
929 tags:
930 - My History
931 parameters:
932 - $ref: '#/components/parameters/start'
933 - $ref: '#/components/parameters/count'
934 responses:
935 '200':
936 description: successful operation
937 content:
938 application/json:
939 schema:
940 $ref: '#/components/schemas/VideoListResponse'
941 /users/me/history/videos/remove:
942 post:
943 summary: Clear video history
944 security:
945 - OAuth2: []
946 tags:
947 - My History
948 requestBody:
949 content:
950 multipart/form-data:
951 schema:
952 type: object
953 properties:
954 beforeDate:
955 description: history before this date will be deleted
956 type: string
957 format: date-time
958 responses:
959 '204':
960 description: successful operation
920 /users/me/avatar/pick: 961 /users/me/avatar/pick:
921 post: 962 post:
922 summary: Update my user avatar 963 summary: Update my user avatar