Skip to main content

ConfigSchemaDto

Plugin configuration schema - documents available config options

descriptionstring | nullnullable

Human-readable description of the configuration

fields object[]required

List of configuration fields

  • Array [
  • 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"

  • ]
  • ConfigSchemaDto
    {
    "description": "string",
    "fields": [
    {
    "description": "string",
    "key": "string",
    "label": "string",
    "required": true,
    "type": "string"
    }
    ]
    }