add response content for createVideoChannel endpoint in openapi spec

closes #4077
pull/4083/head
Rigel Kent 2021-05-12 13:44:32 +02:00
parent 4c440cedcc
commit 9a320a06b6
No known key found for this signature in database
GPG Key ID: 5E53E96A494E452F
1 changed files with 27 additions and 11 deletions

View File

@ -47,7 +47,8 @@ info:
} }
``` ```
Some errors benefit from a more detailed message: Validation errors benefit from a more detailed error type and return the HTTP `400 Bad Request` status code.
``` ```
{ {
"errors": { "errors": {
@ -80,10 +81,10 @@ info:
| Header | Description | | Header | Description |
|-------------------------|------------------------------------------------------------| |-------------------------|------------------------------------------------------------|
| X-RateLimit-Limit | Number of max requests allowed in the current time period | | `X-RateLimit-Limit` | Number of max requests allowed in the current time period |
| X-RateLimit-Remaining | Number of remaining requests in the current time period | | `X-RateLimit-Remaining` | Number of remaining requests in the current time period |
| X-RateLimit-Reset | Timestamp of end of current time period as UNIX timestamp | | `X-RateLimit-Reset` | Timestamp of end of current time period as UNIX timestamp |
| Retry-After | Seconds to delay after the first `429` is received | | `Retry-After` | Seconds to delay after the first `429` is received |
externalDocs: externalDocs:
url: https://docs.joinpeertube.org/api-rest-reference.html url: https://docs.joinpeertube.org/api-rest-reference.html
tags: tags:
@ -1317,7 +1318,7 @@ paths:
type: string type: string
support: support:
description: A text tell the audience how to support the video creator description: A text tell the audience how to support the video creator
example: Please support my work on <insert crowdfunding plateform>! <3 example: Please support our work on https://soutenir.framasoft.org/en/ <3
type: string type: string
nsfw: nsfw:
description: Whether or not this video contains sensitive content description: Whether or not this video contains sensitive content
@ -1747,7 +1748,7 @@ paths:
type: string type: string
support: support:
description: A text tell the audience how to support the creator description: A text tell the audience how to support the creator
example: Please support my work on <insert crowdfunding plateform>! <3 example: Please support our work on https://soutenir.framasoft.org/en/ <3
type: string type: string
nsfw: nsfw:
description: Whether or not this live video/replay contains sensitive content description: Whether or not this live video/replay contains sensitive content
@ -2249,6 +2250,7 @@ paths:
/video-channels: /video-channels:
get: get:
summary: List video channels summary: List video channels
operationId: getVideoChannels
tags: tags:
- Video Channels - Video Channels
parameters: parameters:
@ -2264,6 +2266,7 @@ paths:
$ref: '#/components/schemas/VideoChannelList' $ref: '#/components/schemas/VideoChannelList'
post: post:
summary: Create a video channel summary: Create a video channel
operationId: createVideoChannel
security: security:
- OAuth2: [] - OAuth2: []
tags: tags:
@ -2271,6 +2274,16 @@ paths:
responses: responses:
'204': '204':
description: successful operation description: successful operation
content:
application/json:
schema:
type: object
properties:
videoChannel:
type: object
properties:
id:
$ref: '#/components/schemas/VideoChannel/properties/id'
requestBody: requestBody:
content: content:
application/json: application/json:
@ -2279,6 +2292,7 @@ paths:
'/video-channels/{channelHandle}': '/video-channels/{channelHandle}':
get: get:
summary: Get a video channel summary: Get a video channel
operationId: getVideoChannel
tags: tags:
- Video Channels - Video Channels
parameters: parameters:
@ -2968,6 +2982,8 @@ paths:
enum: enum:
- like - like
- dislike - dislike
required:
- rating
responses: responses:
'204': '204':
description: successful operation description: successful operation
@ -4215,7 +4231,7 @@ components:
usernameChannel: usernameChannel:
type: string type: string
description: immutable name of the channel, used to interact with its actor description: immutable name of the channel, used to interact with its actor
example: The Capybara Channel example: framasoft_videos
pattern: '/^[ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\\-_.:]+$/' pattern: '/^[ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\\-_.:]+$/'
password: password:
type: string type: string
@ -4649,7 +4665,7 @@ components:
support: support:
type: string type: string
description: A text tell the audience how to support the video creator description: A text tell the audience how to support the video creator
example: Please support my work on <insert crowdfunding plateform>! <3 example: Please support our work on https://soutenir.framasoft.org/en/ <3
minLength: 3 minLength: 3
maxLength: 1000 maxLength: 1000
channel: channel:
@ -5589,7 +5605,7 @@ components:
type: boolean type: boolean
support: support:
description: A text tell the audience how to support the video creator description: A text tell the audience how to support the video creator
example: Please support my work on <insert crowdfunding plateform>! <3 example: Please support our work on https://soutenir.framasoft.org/en/ <3
type: string type: string
nsfw: nsfw:
description: Whether or not this video contains sensitive content description: Whether or not this video contains sensitive content
@ -5963,7 +5979,7 @@ components:
support: support:
type: string type: string
description: text shown by default on all videos of this channel, to tell the audience how to support it description: text shown by default on all videos of this channel, to tell the audience how to support it
example: Please support my work on <insert crowdfunding plateform>! <3 example: Please support our work on https://soutenir.framasoft.org/en/ <3
minLength: 3 minLength: 3
maxLength: 1000 maxLength: 1000
# GET-only properties # GET-only properties