WorkflowStepResponseDto

Endpoints · All schemas

Field	Required	Description
config	Yes	Step configuration, without stored credential values
enabled	Yes	Step is enabled
extra	Yes	Additional fields of an imported definition, kept and exported unchanged
id	Yes	Step ID
method	Yes	Step plugin method, as plugin#method
storedSecrets	Yes	Configuration paths (keys joined with ".") holding a stored credential that is never returned

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

{
  "properties": {
    "config": {
      "additionalProperties": {},
      "description": "Step configuration, without stored credential values",
      "nullable": true,
      "type": "object"
    },
    "enabled": {
      "description": "Step is enabled",
      "type": "boolean"
    },
    "extra": {
      "additionalProperties": {},
      "description": "Additional fields of an imported definition, kept and exported unchanged",
      "type": "object"
    },
    "id": {
      "description": "Step ID",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "type": "string"
    },
    "method": {
      "description": "Step plugin method, as plugin#method",
      "type": "string"
    },
    "storedSecrets": {
      "description": "Configuration paths (keys joined with \".\") holding a stored credential that is never returned",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "config",
    "enabled",
    "extra",
    "id",
    "method",
    "storedSecrets"
  ],
  "type": "object"
}