diff options
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/api/openapi.yaml | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/support/doc/api/openapi.yaml b/support/doc/api/openapi.yaml index 7307ea8a0..d4fe15664 100644 --- a/support/doc/api/openapi.yaml +++ b/support/doc/api/openapi.yaml | |||
@@ -4275,15 +4275,23 @@ components: | |||
4275 | createdAt: | 4275 | createdAt: |
4276 | type: string | 4276 | type: string |
4277 | format: date-time | 4277 | format: date-time |
4278 | example: 2017-10-01T10:52:46.396Z | ||
4279 | description: time at which the video object was first drafted | ||
4278 | publishedAt: | 4280 | publishedAt: |
4279 | type: string | 4281 | type: string |
4280 | format: date-time | 4282 | format: date-time |
4283 | example: 2018-10-01T10:52:46.396Z | ||
4284 | description: time at which the video was marked as ready for playback (with restrictions depending on `privacy`). Usually set after a `state` evolution. | ||
4281 | updatedAt: | 4285 | updatedAt: |
4282 | type: string | 4286 | type: string |
4283 | format: date-time | 4287 | format: date-time |
4288 | example: 2021-05-04T08:01:01.502Z | ||
4289 | description: last time the video's metadata was modified | ||
4284 | originallyPublishedAt: | 4290 | originallyPublishedAt: |
4285 | type: string | 4291 | type: string |
4286 | format: date-time | 4292 | format: date-time |
4293 | example: 2010-10-01T10:52:46.396Z | ||
4294 | description: used to represent a date of first publication, prior to the practical publication date of `publishedAt` | ||
4287 | category: | 4295 | category: |
4288 | $ref: '#/components/schemas/VideoConstantNumber-Category' | 4296 | $ref: '#/components/schemas/VideoConstantNumber-Category' |
4289 | licence: | 4297 | licence: |
@@ -4294,9 +4302,18 @@ components: | |||
4294 | $ref: '#/components/schemas/VideoPrivacyConstant' | 4302 | $ref: '#/components/schemas/VideoPrivacyConstant' |
4295 | description: | 4303 | description: |
4296 | type: string | 4304 | type: string |
4305 | example: | | ||
4306 | **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n | ||
4307 | **Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\r\n*A decentralized video hosting network, based on fr... | ||
4308 | minLength: 3 | ||
4309 | maxLength: 250 | ||
4310 | description: | | ||
4311 | truncated description of the video, written in Markdown. | ||
4312 | Resolve `descriptionPath` to get the full description of maximum `10000` characters. | ||
4297 | duration: | 4313 | duration: |
4298 | type: integer | 4314 | type: integer |
4299 | example: 1419 | 4315 | example: 1419 |
4316 | description: duration of the video in seconds | ||
4300 | isLocal: | 4317 | isLocal: |
4301 | type: boolean | 4318 | type: boolean |
4302 | name: | 4319 | name: |
@@ -4356,6 +4373,8 @@ components: | |||
4356 | properties: | 4373 | properties: |
4357 | descriptionPath: | 4374 | descriptionPath: |
4358 | type: string | 4375 | type: string |
4376 | example: /api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180a6d/description | ||
4377 | description: path at which to get the full description of maximum `10000` characters | ||
4359 | support: | 4378 | support: |
4360 | type: string | 4379 | type: string |
4361 | description: A text tell the audience how to support the video creator | 4380 | description: A text tell the audience how to support the video creator |