Skip to content

PluginTemplateResponseDto

Endpoints · All schemas

FieldRequiredDescription
descriptionYesTemplate description
keyYesTemplate key (unique across all templates)
stepsYesWorkflow steps
titleYesTemplate title
triggerYesWorkflow trigger
uiHintsYesUi hints, for example "smart-album"

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.

Field definitions: PluginTemplateStepResponseDto, WorkflowTrigger

{
  "properties": {
    "description": {
      "description": "Template description",
      "type": "string"
    },
    "key": {
      "description": "Template key (unique across all templates)",
      "type": "string"
    },
    "steps": {
      "description": "Workflow steps",
      "items": {
        "$ref": "#/components/schemas/PluginTemplateStepResponseDto"
      },
      "type": "array"
    },
    "title": {
      "description": "Template title",
      "type": "string"
    },
    "trigger": {
      "$ref": "#/components/schemas/WorkflowTrigger",
      "description": "Workflow trigger"
    },
    "uiHints": {
      "description": "Ui hints, for example \"smart-album\"",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "description",
    "key",
    "steps",
    "title",
    "trigger",
    "uiHints"
  ],
  "type": "object"
}