PluginMethodResponseDto

Endpoints · All schemas

Field	Required	Description
allowedHosts	Yes	Hosts this method may send requests to; empty when it cannot reach other servers
description	Yes	Description
hostFunctions	Yes	boolean
key	Yes	Key
name	Yes	Name
schema	No	object
title	Yes	Title
types	Yes	Workflow types
uiHints	Yes	Ui hints

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: WorkflowType

{
  "properties": {
    "allowedHosts": {
      "description": "Hosts this method may send requests to; empty when it cannot reach other servers",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "description": {
      "description": "Description",
      "type": "string"
    },
    "hostFunctions": {
      "type": "boolean"
    },
    "key": {
      "description": "Key",
      "type": "string"
    },
    "name": {
      "description": "Name",
      "type": "string"
    },
    "schema": {
      "properties": {},
      "type": "object"
    },
    "title": {
      "description": "Title",
      "type": "string"
    },
    "types": {
      "description": "Workflow types",
      "items": {
        "$ref": "#/components/schemas/WorkflowType"
      },
      "type": "array"
    },
    "uiHints": {
      "description": "Ui hints",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "allowedHosts",
    "description",
    "hostFunctions",
    "key",
    "name",
    "title",
    "types",
    "uiHints"
  ],
  "type": "object"
}