PeerTube · Schema

VideoChannel

VideoDecentralizedFederationOpen SourceActivityPubSelf-HostedStreaming
View JSON Schema on GitHub

JSON Schema

VideoChannel.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/peertube/main/json-schema/VideoChannel.json",
  "title": "VideoChannel",
  "allOf": [
    {
      "$ref": "#/components/schemas/Actor"
    },
    {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "editable name of the channel, displayed in its representations",
          "example": "Videos of Framasoft",
          "minLength": 1,
          "maxLength": 120
        },
        "description": {
          "type": "string",
          "nullable": true,
          "example": "Videos made with <3 by Framasoft",
          "minLength": 3,
          "maxLength": 1000
        },
        "support": {
          "type": "string",
          "nullable": true,
          "description": "text shown by default on all videos of this channel, to tell the audience how to support it",
          "example": "Please support our work on https://soutenir.framasoft.org/en/ <3",
          "minLength": 3,
          "maxLength": 1000
        },
        "isLocal": {
          "type": "boolean"
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time"
        },
        "banners": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ActorImage"
          }
        },
        "ownerAccount": {
          "$ref": "#/components/schemas/Account"
        }
      }
    }
  ]
}