link.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://readium.org/webpub-manifest/schema/link.schema.json",
  "title": "Link Object for the Readium Web Publication Manifest",
  "type": "object",
  "properties": {
    "href": {
      "description": "URI or URI template of the linked resource",
      "type": "string"
    },
    "type": {
      "description": "MIME type of the linked resource",
      "type": "string"
    },
    "templated": {
      "description": "Indicates that a URI template is used in href",
      "type": "boolean"
    },
    "title": {
      "description": "Title of the linked resource",
      "type": "string"
    },
    "rel": {
      "description": "Relation between the linked resource and its containing collection",
      "type": [
        "string",
        "array"
      ],
      "items": {
        "type": "string"
      }
    },
    "properties": {
      "description": "Properties associated to the linked resource",
      "type": "object",
      "properties": {
        "page": {
          "description": "Indicates how the linked resource should be displayed in a reading environment that displays synthetic spreads.",
          "type": "string",
          "enum": [
            "left", 
            "right", 
            "center"
            ]
          }
      },
      "allOf": [
        { "$ref": "extensions/epub/properties.schema.json" },
        { "$ref": "extensions/encryption/properties.schema.json" },
        { "$ref": "extensions/divina/properties.schema.json" },
        { "$ref": "experimental/presentation/properties.schema.json" },
        { "$ref": "https://drafts.opds.io/schema/properties.schema.json" }
      ]
    },
    "height": {
      "description": "Height of the linked resource in pixels",
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "width": {
      "description": "Width of the linked resource in pixels",
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "bitrate": {
      "description": "Bitrate of the linked resource in kbps",
      "type": "number",
      "exclusiveMinimum": 0
    },
    "duration": {
      "description": "Length of the linked resource in seconds",
      "type": "number",
      "exclusiveMinimum": 0
    },
    "language": {
      "description": "Expected language of the linked resource",
      "type": [
        "string",
        "array"
      ],
      "items": {
        "type": "string",
        "pattern": "^((?<grandfathered>(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))|((?<language>([A-Za-z]{2,3}(-(?<extlang>[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-(?<script>[A-Za-z]{4}))?(-(?<region>[A-Za-z]{2}|[0-9]{3}))?(-(?<variant>[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-(?<extension>[0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(?<privateUse>x(-[A-Za-z0-9]{1,8})+))?)|(?<privateUse2>x(-[A-Za-z0-9]{1,8})+))$"
      },
      "pattern": "^((?<grandfathered>(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))|((?<language>([A-Za-z]{2,3}(-(?<extlang>[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-(?<script>[A-Za-z]{4}))?(-(?<region>[A-Za-z]{2}|[0-9]{3}))?(-(?<variant>[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-(?<extension>[0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(?<privateUse>x(-[A-Za-z0-9]{1,8})+))?)|(?<privateUse2>x(-[A-Za-z0-9]{1,8})+))$"
    },
    "alternate": {
      "description": "Alternate resources for the linked resource",
      "type": "array",
      "items": {
        "$ref": "link.schema.json"
      }
    },
    "children": {
      "description": "Resources that are children of the linked resource, in the context of a given collection role",
      "type": "array",
      "items": {
        "$ref": "link.schema.json"
      }
    }
  },
  "required": [
    "href"
  ],
  "if": {
    "properties": {
      "templated": {
        "enum": [
          false, null
        ]
      }
    }
  },
  "then": {
    "properties": {
      "href": {
        "type": "string",
        "format": "uri-reference"
      }
    }
  },
  "else": {
    "properties": {
      "href": {
        "type": "string",
        "format": "uri-template"
      }
    }
  }
}