Putvideo is an example object payload from PeerTube, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses
Example Payload
{
"operationId": "putVideo",
"method": "PUT",
"path": "/api/v1/videos/{id}",
"summary": "Update a video",
"description": "",
"tags": [
"Video"
],
"parameters": [
{
"name": null,
"in": null,
"required": false,
"description": "",
"schema": {}
}
],
"requestBody": {
"contentType": "multipart/form-data",
"schema": {
"type": "object",
"properties": {
"channelId": {
"type": "integer",
"description": "New channel of the video. The channel must be owned by the same account as the previous one. Use the \"change ownership\" endpoints to give a video to a channel owned by another account on the local PeerTube instance."
},
"thumbnailfile": {
"description": "Video thumbnail file",
"type": "string",
"format": "binary"
},
"previewfile": {
"description": "Deprecated in PeerTube v8.1, use thumbnailfile instead",
"deprecated": true,
"type": "string",
"format": "binary"
},
"category": {
"$ref": "#/components/schemas/VideoCategorySet"
},
"licence": {
"$ref": "#/components/schemas/VideoLicenceSet"
},
"language": {
"$ref": "#/components/schemas/VideoLanguageSet"
},
"privacy": {
"$ref": "#/components/schemas/VideoPrivacySet"
},
"description": {
"description": "Video description",
"type": "string"
},
"waitTranscoding": {
"description": "Whether or not we wait transcoding before publish the video",
"type": "string"
},
"support": {
"description": "A text tell the audience how to support the video creator",
"example": "Please support our work on https://soutenir.framasoft.org/en/ <3",
"type": "string"
},
"nsfw": {
"description": "Whether or not this video contains sensitive content",
"type": "boolean"
},
"nsfwSummary": {
"description": "More information about the sensitive content of the video"
},
"nsfwFlags": {
"$ref": "#/components/schemas/NSFWFlag"
},
"name": {
"description": "Video name",
"type": "string",
"minLength": 3,
"maxLength": 120
},
"tags": {
"description": "Video tags (maximum 5 tags each between 2 and 30 characters)",
"type": "array",
"minItems": 1,
"maxItems": 5,
"items": {
"type": "string",
"minLength": 2,
"maxLength": 30
}
},
"commentsPolicy": {
"$ref": "#/components/schemas/VideoCommentsPolicySet"
},
"downloadEnabled": {
"description": "Enable or disable downloading for this video",
"type": "boolean"
},
"originallyPublishedAt": {
"description": "Date when the content was originally published",
"type": "string",
"format": "date-time",
"nullable": true
},
"scheduleUpdate": {
"$ref": "#/components/schemas/VideoScheduledUpdate"
},
"videoPasswords": {
"$ref": "#/components/schemas/AddVideoPasswords"
}
}
},
"example": {}
},
"responses": {
"204": {
"description": "successful operation",
"examples": {}
}
}
}