aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc/api
diff options
context:
space:
mode:
authorRigel Kent <sendmemail@rigelk.eu>2021-05-11 20:19:26 +0200
committerRigel Kent <sendmemail@rigelk.eu>2021-05-11 20:19:45 +0200
commitbf3c3feafbb3c5a57c171222fcaf140fc784ea36 (patch)
tree07abd4be46033971e2706c6d6ef973ed2de88495 /support/doc/api
parent5c48aa8c3ef48369235bc3a222bbbe5e08c6bd93 (diff)
downloadPeerTube-bf3c3feafbb3c5a57c171222fcaf140fc784ea36.tar.gz
PeerTube-bf3c3feafbb3c5a57c171222fcaf140fc784ea36.tar.zst
PeerTube-bf3c3feafbb3c5a57c171222fcaf140fc784ea36.zip
add missing video comment fields in openapi spec
closes #4079
Diffstat (limited to 'support/doc/api')
-rw-r--r--support/doc/api/openapi.yaml34
1 files changed, 25 insertions, 9 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml
index d5b624048..b538b6f67 100644
--- a/support/doc/api/openapi.yaml
+++ b/support/doc/api/openapi.yaml
@@ -69,10 +69,10 @@ info:
69 |-------------------------|------------------|---------------------------| 69 |-------------------------|------------------|---------------------------|
70 | `/*` | 50 | 10 seconds | 70 | `/*` | 50 | 10 seconds |
71 | `POST /users/token` | 15 | 5 minutes | 71 | `POST /users/token` | 15 | 5 minutes |
72 | `POST /users/register` | 2¹ | 5 minutes | 72 | `POST /users/register` | 2<sup>*</sup> | 5 minutes |
73 | `POST /users/ask-send-verify-email` | 3 | 5 minutes | 73 | `POST /users/ask-send-verify-email` | 3 | 5 minutes |
74 74
75 Depending on the endpoint, ¹failed requests are not taken into account. A service 75 Depending on the endpoint, <sup>*</sup>failed requests are not taken into account. A service
76 limit is announced by a `429 Too Many Requests` status code. 76 limit is announced by a `429 Too Many Requests` status code.
77 77
78 You can get details about the current state of your rate limit by reading the 78 You can get details about the current state of your rate limit by reading the
@@ -2875,8 +2875,10 @@ paths:
2875 type: object 2875 type: object
2876 properties: 2876 properties:
2877 text: 2877 text:
2878 type: string 2878 allOf:
2879 description: 'Text comment' 2879 - $ref: '#/components/schemas/VideoComment/properties/text'
2880 format: markdown
2881 maxLength: 10000
2880 required: 2882 required:
2881 - text 2883 - text
2882 2884
@@ -2921,7 +2923,10 @@ paths:
2921 type: object 2923 type: object
2922 properties: 2924 properties:
2923 text: 2925 text:
2924 $ref: '#/components/schemas/VideoComment/properties/text' 2926 allOf:
2927 - $ref: '#/components/schemas/VideoComment/properties/text'
2928 format: markdown
2929 maxLength: 10000
2925 required: 2930 required:
2926 - text 2931 - text
2927 2932
@@ -4931,13 +4936,16 @@ components:
4931 format: url 4936 format: url
4932 text: 4937 text:
4933 type: string 4938 type: string
4934 description: Text of the comment in Markdown 4939 format: html
4940 description: Text of the comment
4935 minLength: 1 4941 minLength: 1
4936 maxLength: 10000 4942 example: This video is wonderful!
4937 threadId: 4943 threadId:
4938 type: integer
4939 inReplyToCommentId:
4940 $ref: '#/components/schemas/id' 4944 $ref: '#/components/schemas/id'
4945 inReplyToCommentId:
4946 nullable: true
4947 allOf:
4948 - $ref: '#/components/schemas/id'
4941 videoId: 4949 videoId:
4942 $ref: '#/components/schemas/Video/properties/id' 4950 $ref: '#/components/schemas/Video/properties/id'
4943 createdAt: 4951 createdAt:
@@ -4946,6 +4954,14 @@ components:
4946 updatedAt: 4954 updatedAt:
4947 type: string 4955 type: string
4948 format: date-time 4956 format: date-time
4957 deletedAt:
4958 nullable: true
4959 type: string
4960 format: date-time
4961 default: null
4962 isDeleted:
4963 type: boolean
4964 default: false
4949 totalRepliesFromVideoAuthor: 4965 totalRepliesFromVideoAuthor:
4950 type: integer 4966 type: integer
4951 minimum: 0 4967 minimum: 0