schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://stac-extensions.github.io/language/v1.0.0/schema.json#",
  "title": "Language (I18N) Extension",
  "description": "STAC Language (I18N) Extension for STAC.",
  "type": "object",
  "required": [
    "stac_extensions"
  ],
  "properties": {
    "stac_extensions": {
      "type": "array",
      "contains": {
        "const": "https://stac-extensions.github.io/language/v1.0.0/schema.json"
      }
    },
    "links": {
      "type": "array",
      "items": {
        "$refs": "#/definitions/href_fields"
      }
    }
  },
  "oneOf": [
    {
      "$comment": "This is the schema for STAC Items.",
      "type": "object",
      "required": [
        "type",
        "properties"
      ],
      "properties": {
        "type": {
          "const": "Feature"
        },
        "properties": {
          "$ref": "#/definitions/lang_fields"
        },
        "assets": {
          "$ref": "#/definitions/assets"
        }
      }
    },
    {
      "$comment": "This is the schema for STAC Collections.",
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "const": "Collection"
        }
      },
      "anyOf": [
        {
          "$comment": "This is the schema for the top-level fields in a Collection.",
          "allOf": [
            {
              "$ref": "#/definitions/lang_fields"
            }
          ]
        },
        {
          "$comment": "This validates the fields in Collection Assets, but does not require them.",
          "required": [
            "assets"
          ],
          "properties": {
            "assets": {
              "$ref": "#/definitions/assets"
            }
          }
        },
        {
          "$comment": "This is the schema for the fields in Item Asset Definitions. It doesn't require any fields.",
          "required": [
            "item_assets"
          ],
          "properties": {
            "item_assets": {
              "$ref": "#/definitions/assets"
            }
          }
        },
        {
          "$comment": "This is the schema for the fields in Summaries. By default, only checks the existence of the properties, but not the schema of the summaries.",
          "required": [
            "summaries"
          ],
          "properties": {
            "summaries": {
              "anyOf": [
                {"required": ["language"]},
                {"required": ["languages"]}
              ]
            }
          }
        }
      ]
    },
    {
      "$comment": "This is the schema for STAC Catalogs, all top-level.",
      "type": "object",
      "required": [
        "type",
        "language"
      ],
      "properties": {
        "type": {
          "const": "Catalog"
        }
      },
      "allOf": [
        {
          "$ref": "#/definitions/lang_fields"
        }
      ]
    }
  ],
  "definitions": {
    "assets": {
      "type" : "object",
      "additionalProperties": {
        "$refs": "#/definitions/href_fields"
      }
    },
    "language_code": {
      "$comment": "Source for the pattern is https://www.regextester.com/103066",
      "type": "string",
      "pattern": "^((?:(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))|((?:([A-Za-z]{2,3}(-(?:[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-(?:[A-Za-z]{4}))?(-(?:[A-Za-z]{2}|[0-9]{3}))?(-(?:[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-(?:[0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(?:x(-[A-Za-z0-9]{1,8})+))?)|(?:x(-[A-Za-z0-9]{1,8})+))$"
    },
    "language_object": {
      "type": "object",
      "required": [
        "code"
      ],
      "properties": {
        "code": {
          "$ref": "#/definitions/language_code"
        },
        "name": {
          "type": "string",
          "minLength": 1
        },
        "alternate": {
          "type": "string",
          "minLength": 1
        },
        "dir": {
          "type": "string",
          "enum": [
            "ltr",
            "rtl"
          ],
          "default": "ltr"
        }
      }
    },
    "lang_fields": {
      "type": "object",
      "required": [
        "language"
      ],
      "properties": {
        "language": {
          "$ref": "#/definitions/language_object"
        },
        "languages": {
          "type": "array",
          "uniqueItems": true,
          "items": {
            "$ref": "#/definitions/language_object"
          }
        }
      }
    },
    "href_fields": {
      "type": "object",
      "properties": {
        "hreflang": {
          "$ref": "#/definitions/language_code"
        }
      }
    }
  }
}