event_spec.json

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://example.com/product.schema.json",
    "type": "object",
    "definitions": {
      "iddef": {
        "type": "string",
        "minLength": 1
      },
      "versiondef": {
        "type": "string",
        "minLength": 1
      },
      "timedef": {
        "type": [
          "string",
          "null"
        ],
        "format": "date-time",
        "minLength": 1
      },
      "typedef": {
        "type": "string",
        "minLength": 1
      },
      "datadef": {
        "type": [
          "object",
          "string",
          "number",
          "array",
          "boolean",
          "null"
        ]
      },
      "resourcedef": {
        "type": "string",
        "pattern": "([^/]+(/{2,}[^/]+)?)",
        "minLength": 1
      },
      "valuetypedef": {
        "enum": [
          "enumeration",
          "decimal64.3"
        ]
      },
      "ptp-sync-state": {
        "enum": [
          "LOCKED",
          "HOLDOVER",
          "FREERUN"
        ]
      },
      "os-clock-sync-state": {
        "enum": [
          "LOCKED",
          "HOLDOVER",
          "FREERUN"
        ]
      },
      "syncee-lock-state": {
        "enum": [
          "LOCKED",
          "UNLOCKED"
        ]
      },
      "gnss-sync-state": {
        "enum": [
          "SYNCHRONIZED",
          "ACQUIRING-SYNC",
          "ANTENNA-DISCONNECTED",
          "BOOTING",
          "ANTENNA-SHORT_CIRCUIT"
        ]
      },
      "decimaldef": {
        "type": "number"
      },
      "datatypedef": {
        "enum": [
          "notification",
          "metric"
        ]
      },
      "valuedef": {
        "type": [
          "string",
          "number",
          "integer"
        ],
        "oneOf": [
          {
            "if": {
              "properties": {
                "dataType": {
                  "const": "metric"
                }
              }
            },
            "then": {
              "$ref": "#/definitions/decimaldef"
            }
          },
          {
            "if": {
              "properties": {
                "dataType": {
                  "const": "notification"
                }
              }
            },
            "then": {
              "anyOf": [
                {
                  "$ref": "#/definitions/ptp-sync-state"
                },
                {
                  "$ref": "#/definitions/os-clock-sync-state"
                },
                {
                  "$ref": "#/definitions/syncee-lock-state"
                },
                {
                  "$ref": "#/definitions/gnss-sync-state"
                }
              ]
            }
          }
        ]
      }
    },
    "properties": {
      "id": {
        "description": "Identifies the subscription and publisher.",
        "$ref": "#/definitions/iddef",
        "examples": [
          "789be75d-7ac3-472e-bbbc-6d62878aad4a"
        ]
      },
      "type": {
        "description": "Describes the type of cloud native events (CNE) related to the originating occurrence.",
        "$ref": "#/definitions/typedef",
        "examples": [
          "com.github.pull_request.opened",
          "com.example.object.deleted.v2"
        ]
      },
      "time": {
        "description": "Timestamp of when the occurrence happened. Must adhere to RFC 3339.",
        "$ref": "#/definitions/timedef",
        "examples": [
          "2018-04-05T17:31:00Z"
        ]
      },
      "data": {
        "description": "Define events",
        "type": "object",
        "properties": {
          "version": {
            "description": "The version of the cloud native events (CNE) specification which the event uses.",
            "$ref": "#/definitions/versiondef",
            "examples": [
              "1.0"
            ]
          },
          "values": {
            "description": "Array of JSON objects defining the information for the event.",
            "type": "array",
            "minItems": 1,
            "additionalItems": false,
            "items": {
              "type": "object",
              "properties": {
                "resource": {
                  "description": "Yang path to value specification .",
                  "$ref": "#/definitions/resourcedef",
                  "examples": [
                    "/sync/sync-status/sync-state"
                  ]
                },
                "dataType": {
                  "description": "Defines the event types as either notification or metric",
                  "$ref": "#/definitions/datatypedef"
                },
                "valueType": {
                  "description": "The type format of the value property, either string or number format",
                  "$ref": "#/definitions/valuetypedef"
                },
                "value": {
                  "description": "The version of the cloud native events (CNE) specification which the event uses.",
                  "$ref": "#/definitions/valuedef"
                }
              },
              "required": [
                "resource",
                "dataType",
                "valueType",
                "value"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "version",
          "values"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "id",
      "type",
      "time",
      "data"
    ],
    "additionalProperties": false
  }