add examples and descriptions to some video fields in openapi spec
This commit is contained in:
parent
f880a5e704
commit
0c1145687b
1 changed files with 19 additions and 0 deletions
|
@ -4275,15 +4275,23 @@ components:
|
||||||
createdAt:
|
createdAt:
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
format: date-time
|
||||||
|
example: 2017-10-01T10:52:46.396Z
|
||||||
|
description: time at which the video object was first drafted
|
||||||
publishedAt:
|
publishedAt:
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
format: date-time
|
||||||
|
example: 2018-10-01T10:52:46.396Z
|
||||||
|
description: time at which the video was marked as ready for playback (with restrictions depending on `privacy`). Usually set after a `state` evolution.
|
||||||
updatedAt:
|
updatedAt:
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
format: date-time
|
||||||
|
example: 2021-05-04T08:01:01.502Z
|
||||||
|
description: last time the video's metadata was modified
|
||||||
originallyPublishedAt:
|
originallyPublishedAt:
|
||||||
type: string
|
type: string
|
||||||
format: date-time
|
format: date-time
|
||||||
|
example: 2010-10-01T10:52:46.396Z
|
||||||
|
description: used to represent a date of first publication, prior to the practical publication date of `publishedAt`
|
||||||
category:
|
category:
|
||||||
$ref: '#/components/schemas/VideoConstantNumber-Category'
|
$ref: '#/components/schemas/VideoConstantNumber-Category'
|
||||||
licence:
|
licence:
|
||||||
|
@ -4294,9 +4302,18 @@ components:
|
||||||
$ref: '#/components/schemas/VideoPrivacyConstant'
|
$ref: '#/components/schemas/VideoPrivacyConstant'
|
||||||
description:
|
description:
|
||||||
type: string
|
type: string
|
||||||
|
example: |
|
||||||
|
**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n
|
||||||
|
**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\r\n*A decentralized video hosting network, based on fr...
|
||||||
|
minLength: 3
|
||||||
|
maxLength: 250
|
||||||
|
description: |
|
||||||
|
truncated description of the video, written in Markdown.
|
||||||
|
Resolve `descriptionPath` to get the full description of maximum `10000` characters.
|
||||||
duration:
|
duration:
|
||||||
type: integer
|
type: integer
|
||||||
example: 1419
|
example: 1419
|
||||||
|
description: duration of the video in seconds
|
||||||
isLocal:
|
isLocal:
|
||||||
type: boolean
|
type: boolean
|
||||||
name:
|
name:
|
||||||
|
@ -4356,6 +4373,8 @@ components:
|
||||||
properties:
|
properties:
|
||||||
descriptionPath:
|
descriptionPath:
|
||||||
type: string
|
type: string
|
||||||
|
example: /api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180a6d/description
|
||||||
|
description: path at which to get the full description of maximum `10000` characters
|
||||||
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
|
||||||
|
|
Loading…
Reference in a new issue