External Ingestion Live Json Schema

1
2
{
  "$id": "http://example.com/example.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "External Ingestion Event",
  "description": "Schema for events to Transformer Service",
  "type": "object",
  "definitions": {},
  "dataTypes": [
    "UGC/Configuration"
  ],
  "properties": {
    "entities": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "entityId": {
            "type": "string",
            "description": "EntityId that was operated on"
          },
          "entityType": {
            "type": "string",
            "description": "Type of entity that was operated on. Note that there is an allowed list of event producers to entityType and events not matching this list will be ignored"
          },
          "version": {
            "type": "integer",
            "description": "Version number of the ingestion record. This can be used to ensure ordering of events, as it is strictly monotonically increasing, though not necessarily by only 1 each time"
          },
          "lastUpdateMillis": {
            "type": "integer",
            "description": "Timestamp when the ingestion record is updated in the provider's storage."
          },
          "deleted": {
            "type": "boolean",
            "description": "Determine if the record should be deleted."
          },
          "content": {
            "type": "string",
            "description": "The Content object to be operated on."
          },
          "base64GzipContent": {
            "type": "string",
            "description": "The Content object to be operated on."
          }
        },
        "oneOf": [
          {
            "required": [
              "entityId",
              "entityType",
              "version",
              "lastUpdateMillis",
              "deleted",
              "content"
            ]
          },
          {
            "required": [
              "entityId",
              "entityType",
              "version",
              "lastUpdateMillis",
              "deleted",
              "base64GzipContent"
            ]
          }
        ]
      },
      "description": "List of external entities"
    },
    "timestamp": {
      "type": "integer",
      "description": "Timestamp when the event is pushed to StreamHub."
    }
  },
  "required": [
    "timestamp",
    "entities"
  ],
  "additionalProperties": false
}