joystream/content-directory-schemas/schemas/entities/ChannelEntity.schema.json

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$id": "https://joystream.org/ChannelEntity.schema.json",
    "title": "ChannelEntity",
    "description": "JSON schema for entities based on Channel runtime schema",
    "type": "object",
    "additionalProperties": false,
    "required": [
        "title",
        "description",
        "coverPhotoUrl",
        "avatarPhotoURL",
        "isPublic",
        "isCurated"
    ],
    "properties": {
        "title": {
            "type": "string",
            "maxLength": 64,
            "description": "The title of the Channel"
        },
        "description": {
            "type": "string",
            "maxLength": 1024,
            "description": "The description of a Channel"
        },
        "coverPhotoUrl": {
            "type": "string",
            "maxLength": 256,
            "description": "Url for Channel's cover (background) photo. Recommended ratio: 16:9."
        },
        "avatarPhotoURL": {
            "type": "string",
            "maxLength": 256,
            "description": "Channel's avatar photo."
        },
        "isPublic": {
            "type": "boolean",
            "description": "Flag signaling whether a channel is public."
        },
        "isCurated": {
            "type": "boolean",
            "description": "Flag signaling whether a channel is curated/verified."
        },
        "language": {
            "oneOf": [
                {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                        "new"
                    ],
                    "properties": {
                        "new": {
                            "$ref": "./LanguageEntity.schema.json"
                        }
                    }
                },
                {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                        "existing"
                    ],
                    "properties": {
                        "existing": {
                            "$ref": "../entityReferences/LanguageRef.schema.json"
                        }
                    }
                }
            ],
            "description": "The primary langauge of the channel's content"
        }
    }
}