schema.json

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://sparkgeo.github.io/hazard-extension/v1.0.0/schema.json#",
    "title": "Hazard STAC Extension",
    "description": "STAC Hazard Extension for STAC Items and STAC Collections.",
    "oneOf": [
      {
        "$comment": "This is the schema for STAC Items.",
        "allOf": [
          {
            "$ref": "#/definitions/stac_extensions"
          },
          {
            "type": "object",
            "required": [
              "type",
              "properties",
              "assets"
            ],
            "properties": {
              "type": {
                "const": "Feature"
              },
              "properties": {
                "allOf": [
                  {
                    "$comment": "Require fields here for Item Properties.",
                    "required": [
                      "osc-hazard:hazard_version",
                      "osc-hazard:id",
                      "osc-hazard:hazard_kind",
                      "osc-hazard:name",
                      "osc-hazard:description"
                    ]
                  },
                  {
                    "$ref": "#/definitions/fields"
                  }
                ]
              },
              "assets": {
                "$comment": "This validates the fields in Item Assets, but does not require them.",
                "type": "object",
                "additionalProperties": {
                  "$ref": "#/definitions/fields"
                }
              }
            }
          }
        ]
      },
      {
        "$comment": "This is the schema for STAC Collections.",
        "type": "object",
        "allOf": [
          {
            "required": [
              "type"
            ],
            "properties": {
              "type": {
                "const": "Collection"
              }
            }
          },
          {
            "$ref": "#/definitions/stac_extensions"
          }
        ],
        "anyOf": [
          {
            "$comment": "This is the schema for the top-level fields in a Collection.",
            "allOf": [
              {
                "$comment": "Require fields here for Collections (top-level).",
                "required": [
                  "osc-hazard:hazard_version",
                  "osc-hazard:id",
                  "osc-hazard:hazard_kind",
                  "osc-hazard:name",
                  "osc-hazard:description"
                ]
              },
              {
                "$ref": "#/definitions/fields"
              }
            ]
          },
          {
            "$comment": "This validates the fields in Collection Assets, but does not require them.",
            "required": [
              "assets"
            ],
            "properties": {
              "assets": {
                "type": "object",
                "not": {
                  "additionalProperties": {
                    "not": {
                      "allOf": [
                        {
                          "$ref": "#/definitions/require_any_field"
                        },
                        {
                          "$ref": "#/definitions/fields"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          {
            "$comment": "This is the schema for the fields in Item Asset Definitions.",
            "required": [
              "item_assets"
            ],
            "properties": {
              "item_assets": {
                "type": "object",
                "not": {
                  "additionalProperties": {
                    "not": {
                      "allOf": [
                        {
                          "$ref": "#/definitions/require_any_field"
                        },
                        {
                          "$ref": "#/definitions/fields"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          {
            "$comment": "This is the schema for the fields in Summaries.",
            "required": [
              "summaries"
            ],
            "properties": {
              "summaries": {
                "$ref": "#/definitions/require_any_field"
              }
            }
          }
        ]
      }
    ],
    "definitions": {
      "stac_extensions": {
        "type": "object",
        "required": [
          "stac_extensions"
        ],
        "properties": {
          "stac_extensions": {
            "type": "array",
            "contains": {
              "const": "https://sparkgeo.github.io/hazard-extension/v1.0.0/schema.json"
            }
          }
        }
      },
      "require_any_field": {
        "$comment": "List of fields to ensure their existence.",
        "anyOf": [
          {"required": ["osc-hazard:hazard_version"]},
          {"required": ["osc-hazard:id"]},
          {"required": ["osc-hazard:hazard_kind"]},
          {"required": ["osc-hazard:name"]},
          {"required": ["osc-hazard:description"]}
        ]
      },
      "fields": {
        "$comment": "Add your new fields here.",
        "type": "object",
        "properties": {
          "osc-hazard:hazard_version": {
            "type": "string",
            "description": "The version of the hazard schema.",
            "const": "0.1.0"
          },
          "osc-hazard:id": {
            "type": "string",
            "description": "The identifier for the hazard.",
            "minLength": 1
          },
          "osc-hazard:hazard_kind": {
            "type": "string",
            "description": "The kind of hazard.",
            "enum": ["chronic", "acute", "unknown"]
          },
          "osc-hazard:name": {
            "type": "string",
            "description": "The name of the hazard."
          },
          "osc-hazard:description": {
            "type": "string",
            "description": "A description of the hazard."
          },
          "links": {
            "title": "Hazard Links",
            "description": "Links to hazard relations.",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "href": {
                  "title": "Link reference",
                  "type": "string",
                  "format": "iri-reference",
                  "minLength": 1
                },
                "rel": {
                  "title": "Link relation type",
                  "type": "string",
                  "minLength": 1
                },
                "type": {
                  "title": "Link type",
                  "type": "string"
                },
                "title": {
                  "title": "Link title",
                  "type": "string"
                }
              },
              "required": ["href", "rel"]
            }
          },
          "osc-hazard:vulnerability_model": {
            "$ref": "vulnerability_model.json#/properties/vulnerability_model"
          }
        },
        "additionalProperties": false
      }
    }
  }