Configuration Item Block
Document configuration settings with types, defaults, and environment applicability.
Overview
The Configuration Item block documents application configuration settings. It captures the type, default value, description, and which environments the setting applies to. Use this block to create configuration documentation that helps developers and operators understand available settings.
Sensitive Configuration
A required, sensitive configuration like a database connection string.
Numeric Configuration with Allowed Values
A configuration with specific allowed values.
Boolean Feature Flag
A simple boolean configuration for enabling or disabling a feature.
JSON Configuration
Complex configuration stored as JSON.
Block Properties
| Property | Required | Description |
|---|---|---|
| name | Yes | Configuration variable name (e.g., DATABASE_URL) |
| type | Yes | One of 'string', 'number', 'boolean', 'json', or 'secret' |
| defaultValue | No | Default value if not explicitly set |
| description | No | Explanation of what the setting controls |
| allowedValues | No | Array of valid values (for constrained settings) |
| environment | No | Array of environments where this applies |
| sensitive | No | Whether the value should be masked in logs |
| required | No | Whether the configuration must be set |