add missing video comment fields in openapi spec

closes #4079
This commit is contained in:
Rigel Kent 2021-05-11 20:19:26 +02:00
parent 5c48aa8c3e
commit bf3c3feafb
No known key found for this signature in database
GPG Key ID: 5E53E96A494E452F
1 changed files with 25 additions and 9 deletions

View File

@ -69,10 +69,10 @@ info:
|-------------------------|------------------|---------------------------| |-------------------------|------------------|---------------------------|
| `/*` | 50 | 10 seconds | | `/*` | 50 | 10 seconds |
| `POST /users/token` | 15 | 5 minutes | | `POST /users/token` | 15 | 5 minutes |
| `POST /users/register` | 2¹ | 5 minutes | | `POST /users/register` | 2<sup>*</sup> | 5 minutes |
| `POST /users/ask-send-verify-email` | 3 | 5 minutes | | `POST /users/ask-send-verify-email` | 3 | 5 minutes |
Depending on the endpoint, ¹failed requests are not taken into account. A service Depending on the endpoint, <sup>*</sup>failed requests are not taken into account. A service
limit is announced by a `429 Too Many Requests` status code. limit is announced by a `429 Too Many Requests` status code.
You can get details about the current state of your rate limit by reading the You can get details about the current state of your rate limit by reading the
@ -2875,8 +2875,10 @@ paths:
type: object type: object
properties: properties:
text: text:
type: string allOf:
description: 'Text comment' - $ref: '#/components/schemas/VideoComment/properties/text'
format: markdown
maxLength: 10000
required: required:
- text - text
@ -2921,7 +2923,10 @@ paths:
type: object type: object
properties: properties:
text: text:
$ref: '#/components/schemas/VideoComment/properties/text' allOf:
- $ref: '#/components/schemas/VideoComment/properties/text'
format: markdown
maxLength: 10000
required: required:
- text - text
@ -4931,13 +4936,16 @@ components:
format: url format: url
text: text:
type: string type: string
description: Text of the comment in Markdown format: html
description: Text of the comment
minLength: 1 minLength: 1
maxLength: 10000 example: This video is wonderful!
threadId: threadId:
type: integer
inReplyToCommentId:
$ref: '#/components/schemas/id' $ref: '#/components/schemas/id'
inReplyToCommentId:
nullable: true
allOf:
- $ref: '#/components/schemas/id'
videoId: videoId:
$ref: '#/components/schemas/Video/properties/id' $ref: '#/components/schemas/Video/properties/id'
createdAt: createdAt:
@ -4946,6 +4954,14 @@ components:
updatedAt: updatedAt:
type: string type: string
format: date-time format: date-time
deletedAt:
nullable: true
type: string
format: date-time
default: null
isDeleted:
type: boolean
default: false
totalRepliesFromVideoAuthor: totalRepliesFromVideoAuthor:
type: integer type: integer
minimum: 0 minimum: 0