Argo Workflows · Schema

github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.PayloadField

PayloadField binds a value at path within the event payload against a name.

CNCFContainersData ProcessingKubernetesMachine LearningOpen SourceWorkflow Engine

Properties

Name Type Description
name string Name acts as key that holds the value at the path.
path string Path is the JSONPath of the event's (JSON decoded) data key Path is a series of keys separated by a dot. A key may contain wildcard characters '*' and '?'. To access an array value use the index as th
View JSON Schema on GitHub

JSON Schema

argo-workflows-github-com-argoproj-argo-events-pkg-apis-events-v1alpha1-payload-field-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/argo-workflows/refs/heads/main/json-schema/argo-workflows-github-com-argoproj-argo-events-pkg-apis-events-v1alpha1-payload-field-schema.json",
  "title": "github.com.argoproj.argo_events.pkg.apis.events.v1alpha1.PayloadField",
  "description": "PayloadField binds a value at path within the event payload against a name.",
  "type": "object",
  "properties": {
    "name": {
      "description": "Name acts as key that holds the value at the path.",
      "type": "string"
    },
    "path": {
      "description": "Path is the JSONPath of the event's (JSON decoded) data key\nPath is a series of keys separated by a dot. A key may contain wildcard characters '*' and '?'.\nTo access an array value use the index as the key. The dot and wildcard characters can be escaped with '\\\\'.\nSee https://github.com/tidwall/gjson#path-syntax for more information on how to use this.",
      "type": "string"
    }
  }
}