Skip to main content

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: "number", "string", or "boolean"

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