Entity-ngsiv2-datamodels-schema.json

{
  "$schema": "http://json-schema.org/schema#",
  "$id": "https://fiware.github.io/data-models/Entity-ngsiv2-datamodels-schema.json",
  "title": "NGSIv2 Entity. Normalized Format for FIWARE Data Models",
  "description": "NGSIv2 Entity. Normalized Format aligned with the usage given by FIWARE Data Models. Restrictions: geo:point, geo:line, geo:polygon, geo:box not covered. keyValues representation not covered",
  "definitions": {
    "Identifier": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256,
      "pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$"
    },
    "Value": {
      "type": [
        "number",
        "boolean",
        "array",
        "object",
        "null",
        "string"
      ]
    },
    "AttributeTypeValue": {
      "type": "object",
      "properties": {
        "type": {
          "allOf": [
            {
              "$ref": "#/definitions/Identifier"
            },
            {
              "not": {
                "const": "DateTime"
              }
            },
            {
              "not": {
                "const": "geo:json"
              }
            }
          ]
        },
        "value": {
          "$ref": "#/definitions/Value"
        }
      },
      "required": [
        "value"
      ]
    },
    "MetadataTypeValue": {
      "type": "object",
      "properties": {
        "type": {
          "allOf": [
            {
              "$ref": "#/definitions/Identifier"
            },
            {
              "not": {
                "const": "DateTime"
              }
            }
          ]
        },
        "value": {
          "$ref": "#/definitions/Value"
        }
      },
      "required": [
        "value"
      ]
    },

    "DateTimeValue": {
      "type": "string",
      "format": "date-time"
    },
    "DateTimeTypeValue": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "const": "DateTime"
        },
        "value": {
          "$ref": "#/definitions/DateTimeValue"
        }
      },
      "required": [
        "type",
        "value"
      ]
    },
    "GeoTypeValue": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "const": "geo:json"
        },
        "value": {
          "$ref": "http://json-schema.org/geojson/geometry.json#"
        }
      },
      "required": [
        "type",
        "value"
      ]
    },
    "Metadata": {
      "type": "object",
      "properties": {
        "dateCreated": {
          "$ref": "#/definitions/DateTimeTypeValue"
        },
        "dateModified": {
          "$ref": "#/definitions/DateTimeTypeValue"
        },
        "previousValue": {
          "$ref": "#/definitions/AttributeTypeValue"
        },
        "actionType": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "const": "Text"
            },
            "value": {
              "type": "string",
              "enum": [
                "update",
                "delete",
                "append"
              ]
            }
          },
          "required": [
            "type",
            "value"
          ]
        }
      },
      "additionalProperties": {
        "anyOf": [
          {
            "$ref": "#/definitions/MetadataTypeValue"
          },
          {
            "$ref": "#/definitions/DateTimeTypeValue"
          }
        ]
      },
      "propertyNames": {
        "allOf": [
          {
            "not": {
              "type": "string",
              "const": "*"
            }
          }
        ]
      }
    },
    "dateCreated": {
      "$ref": "#/definitions/DateTimeTypeValue"
    },
    "dateModified": {
      "$ref": "#/definitions/DateTimeTypeValue"
    },
    "dateExpires": {
      "$ref": "#/definitions/DateTimeTypeValue"
    },
    "Attribute": {
      "allOf": [
        {
          "oneOf": [
            {
              "$ref": "#/definitions/DateTimeTypeValue"
            },
            {
              "$ref": "#/definitions/GeoTypeValue"
            },
            {
              "$ref": "#/definitions/AttributeTypeValue"
            }
          ]
        },
        {
          "type": "object",
          "properties": {
            "metadata": {
              "$ref": "#/definitions/Metadata"
            }
          }
        }
      ]
    },
    "EntityFragment": {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/definitions/Identifier"
        },
        "type": {
          "allOf": [
            {
              "$ref": "#/definitions/Identifier"
            },
            {
              "default": "Thing"
            }
          ]
        },
        "dateCreated": {
          "$ref": "#/definitions/dateCreated"
        },
        "dateModified": {
          "$ref": "#/definitions/dateModified"
        },
        "dateExpires": {
          "$ref": "#/definitions/dateExpires"
        }
      },
      "propertyNames": {
        "allOf": [
          {
            "not": {
              "type": "string",
              "const": "geo:distance"
            }
          },
          {
            "not": {
              "type": "string",
              "const": "*"
            }
          }
        ]
      },
      "additionalProperties": {
        "anyOf": [
          {
            "$ref": "#/definitions/Attribute"
          }
        ]
      }
    },
    "Entity": {
      "allOf": [
        {
          "required": [
            "id",
            "type"
          ]
        },
        {
          "$ref": "#/definitions/EntityFragment"
        }
      ]
    }
  },
  "allOf": [
    {
      "$ref": "#/definitions/Entity"
    }
  ]
}