ConfigFieldDto

Configuration field definition for documenting plugin config options

default

Default value if not provided

descriptionstring | nullnullable

Description of what this field does

example

Example value for documentation

keystringrequired

Field name (key in JSON config)

labelstringrequired

Human-readable label

requiredboolean

Whether this field is required

typestringrequired

Field type — free-form documentation hint. Common values: "number", "string", "boolean", "string-array", "object". The host never validates stored config against this; it forwards the raw JSON to the plugin.

ConfigFieldDto

{
  "description": "string",
  "key": "string",
  "label": "string",
  "required": true,
  "type": "string"
}