schema.events.eventdef.json Maven / Gradle / Ivy

Go to download
{
  "type": "object",
  "javaType": "io.serverlessworkflow.api.events.EventDefinition",
  "properties": {
    "name": {
      "type": "string",
      "description": "Event Definition unique name",
      "minLength": 1
    },
    "source": {
      "type": "string",
      "description": "CloudEvent source UUID"
    },
    "type": {
      "type": "string",
      "description": "CloudEvent type"
    },
    "correlation": {
      "type": "array",
      "description": "CloudEvent correlation definitions",
      "minItems": 1,
      "items": {
        "type": "object",
        "$ref": "../correlation/correlationdef.json"
      }
    },
    "dataOnly": {
      "type": "boolean",
      "default": true,
      "description": "If `true`, only the Event payload is accessible to consuming Workflow states. If `false`, both event payload and context attributes should be accessible "
    },
    "kind": {
      "type" : "string",
      "enum": ["consumed", "produced"],
      "description": "Defines the events as either being consumed or produced by the workflow. Default is consumed",
      "default": "consumed"
    },
    "metadata": {
      "$ref": "../metadata/metadata.json"
    }
  },
  "if": {
    "properties": {
      "kind": {
        "const": "consumed"
      }
    }
  },
  "then": {
    "required": [
      "name",
      "source",
      "type"
    ]
  },
  "else": {
    "required": [
      "name",
      "type"
    ]
  }
}