aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc
diff options
context:
space:
mode:
authorRigel Kent <sendmemail@rigelk.eu>2021-05-10 10:26:50 +0200
committerRigel Kent <sendmemail@rigelk.eu>2021-05-10 11:27:35 +0200
commit30b40713f48f993fac6db8d4dbd712018bbde847 (patch)
tree956a1811f77da3fcf10d904f14fb0e6a020394b6 /support/doc
parentf6d6e7f861189a4446f406efb775a29688764b48 (diff)
downloadPeerTube-30b40713f48f993fac6db8d4dbd712018bbde847.tar.gz
PeerTube-30b40713f48f993fac6db8d4dbd712018bbde847.tar.zst
PeerTube-30b40713f48f993fac6db8d4dbd712018bbde847.zip
fix response in openapi spec for quota and video ratings
closes #4064 closes #4065
Diffstat (limited to 'support/doc')
-rw-r--r--support/doc/api/openapi.yaml26
1 files changed, 20 insertions, 6 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index 050ab82f8..a71b571b8 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -50,8 +50,7 @@ info:
50 50
51 # Rate limits 51 # Rate limits
52 52
53 We are rate-limiting all endpoints of PeerTube's API. Custom values can be configured 53 We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators:
54 by administrators:
55 54
56 | Endpoint | Calls | Time frame | 55 | Endpoint | Calls | Time frame |
57 |-------------------------|------------------|---------------------------| 56 |-------------------------|------------------|---------------------------|
@@ -723,7 +722,14 @@ paths:
723 content: 722 content:
724 application/json: 723 application/json:
725 schema: 724 schema:
726 type: number 725 type: object
726 properties:
727 videoQuotaUsed:
728 type: number
729 example: 16810141515
730 videoQuotaUsedDaily:
731 type: number
732 example: 1681014151
727 '/users/me/videos/{videoId}/rating': 733 '/users/me/videos/{videoId}/rating':
728 get: 734 get:
729 summary: Get rate of my user for a video 735 summary: Get rate of my user for a video
@@ -5718,7 +5724,11 @@ components:
5718 type: string 5724 type: string
5719 description: Id of the video 5725 description: Id of the video
5720 rating: 5726 rating:
5721 type: number 5727 type: string
5728 enum:
5729 - like
5730 - dislike
5731 - none
5722 description: Rating of the video 5732 description: Rating of the video
5723 required: 5733 required:
5724 - id 5734 - id
@@ -5728,8 +5738,12 @@ components:
5728 video: 5738 video:
5729 $ref: '#/components/schemas/Video' 5739 $ref: '#/components/schemas/Video'
5730 rating: 5740 rating:
5731 type: number 5741 type: string
5732 description: 'Rating of the video' 5742 enum:
5743 - like
5744 - dislike
5745 - none
5746 description: Rating of the video
5733 required: 5747 required:
5734 - video 5748 - video
5735 - rating 5749 - rating