collectionInfo

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/entur/main/json-schema/entur-collection-info-schema.json",
  "title": "collectionInfo",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/entur-omsa-openapi.yml#/components/schemas/collectionInfo",
  "required": [
    "id",
    "links"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "identifier of the collection used, for example, in URIs"
    },
    "title": {
      "type": "string",
      "description": "human readable title of the collection"
    },
    "description": {
      "type": "string",
      "description": "a description of the data in the collection"
    },
    "links": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/link"
      }
    },
    "extent": {
      "type": "object"
    },
    "itemType": {
      "type": "string",
      "description": "indicator about the type of the items in the collection if the collection has an accessible /collections/{collectionId}/items endpoint",
      "default": "unknown"
    },
    "crs": {
      "type": "array",
      "description": "the list of coordinate reference systems supported by the API; the first item is the default coordinate reference system",
      "items": {
        "type": "string"
      },
      "default": [
        "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
      ]
    },
    "dataType": {
      "$ref": "#/$defs/dataType"
    },
    "geometryDimension": {
      "maximum": 3,
      "minimum": 0,
      "type": "integer",
      "description": "The geometry dimension of the features shown in this layer (0: points, 1: curves, 2: surfaces, 3: solids), unspecified: mixed or unknown"
    },
    "minScaleDenominator": {
      "type": "number",
      "description": "Minimum scale denominator for usage of the collection"
    },
    "maxScaleDenominator": {
      "type": "number",
      "description": "Maximum scale denominator for usage of the collection"
    },
    "minCellSize": {
      "type": "number",
      "description": "Minimum cell size for usage of the collection"
    },
    "maxCellSize": {
      "type": "number",
      "description": "Maximum cell size for usage of the collection"
    }
  },
  "$defs": {
    "dataType": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string",
          "enum": [
            "map",
            "vector",
            "coverage"
          ]
        }
      ]
    },
    "dateTime": {
      "type": "string",
      "description": "https://www.rfc-editor.org/rfc/rfc3339#section-5.6, date-time (2019-10-12T07:20:50.52Z)",
      "format": "date-time",
      "x-pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
    },
    "day": {
      "type": "string",
      "enum": [
        "MON",
        "TUE",
        "WED",
        "THU",
        "FRI",
        "SAT",
        "SUN"
      ],
      "x-tm": "DAY OF WEEK"
    },
    "link": {
      "required": [
        "href",
        "rel"
      ],
      "type": "object",
      "properties": {
        "rel": {
          "type": "string",
          "description": "the action that can be performed OR part of the URI allowed values include the 'processId's, prefixes for the referenced data sources, prefixes for deeplinks ('apple' and 'android'), OGC compliant ones (alternative, next, etc)"
        },
        "href": {
          "$ref": "#/$defs/url"
        },
        "type": {
          "$ref": "#/$defs/shortString"
        },
        "method": {
          "type": "string",
          "description": "to indicate the http method.",
          "enum": [
            "POST",
            "GET",
            "PUT",
            "DELETE",
            "PATCH"
          ]
        },
        "description": {
          "type": "string",
          "description": "the description of the external data source"
        },
        "body": {
          "type": "object",
          "description": "the (prefilled) body for the request"
        },
        "headers": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "isMandatory": {
          "type": "boolean",
          "description": "is this link informative, or must it be used?"
        },
        "hash": {
          "type": "string",
          "description": "to validate that the content of the link hasn't been changed."
        },
        "validity": {
          "$ref": "#/$defs/temporalParameter"
        }
      },
      "additionalProperties": false,
      "x-externalDocs": {
        "url": "https://github.com/opengeospatial/ogcapi-processes/raw/refs/heads/master/openapi/schemas/common-core/link.yaml"
      }
    },
    "normalInt": {
      "maximum": 1000,
      "minimum": 0,
      "type": "integer",
      "description": "default length for an integer (0-1000)",
      "default": 0
    },
    "shortString": {
      "maxLength": 75,
      "type": "string",
      "description": "short string, display names (length 0-75)"
    },
    "temporalParameter": {
      "required": [
        "type"
      ],
      "type": "object",
      "properties": {
        "type": {
          "pattern": "^(temporal)$",
          "type": "string"
        },
        "startTime": {
          "$ref": "#/$defs/dateTime"
        },
        "endTime": {
          "$ref": "#/$defs/dateTime"
        },
        "duration": {
          "$ref": "#/$defs/normalInt"
        },
        "dayType": {
          "$ref": "#/$defs/day"
        }
      },
      "x-tm": "TEMPORAL VALIDITY PARAMETERS"
    },
    "url": {
      "type": "string",
      "description": "valid URL",
      "format": "uri"
    }
  }
}