StepDefinition

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/signicat/main/json-schema/signicat-step-definition-schema.json",
  "title": "StepDefinition",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/signicat-mint-openapi.yml#/components/schemas/StepDefinition",
  "required": [
    "type",
    "displayName",
    "category"
  ],
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The step type."
    },
    "displayName": {
      "type": "string",
      "description": "The display name of the step."
    },
    "description": {
      "type": [
        "null",
        "string"
      ],
      "description": "The description of the step."
    },
    "category": {
      "type": "string",
      "description": "The step category."
    },
    "documentationUrl": {
      "type": [
        "null",
        "string"
      ],
      "description": "URL to the documentation page for the step."
    },
    "keywords": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of keywords associated with the step."
    },
    "outcomes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of possible step outcomes."
    },
    "requiredPermissions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of required permissions to use the step."
    },
    "deprecated": {
      "type": "boolean",
      "description": "Whether the step is deprecated."
    },
    "interactive": {
      "type": "boolean",
      "description": "Whether the step requires end user interaction."
    }
  }
}