Loading

Automated settings reference

Elastic Docs V3 supports the ability to build a markdown settings reference from a YAML source file.

:::{settings} /syntax/settings-with-applies-example.yml
:::

See /syntax/settings-with-applies-example.yml for a full, schema-compliant sample.

It demonstrates:

  • Group description and example.
  • Setting id, datatype, default, and options.
  • note, tip, warning, important, and deprecation_details.
  • Nested settings.
  • applies_to inheritance and override behavior.

Everything below this line is auto-generated.

General settings

These settings show top-level schema fields, metadata, and applies_to usage.

xpack.example.enabled: true
xpack.example.mode: strict
xpack.example.enabled

Enables the example feature.

Datatype: bool

Default: true

Options:

  • true - Turns the feature on.
  • false - Turns the feature off.
Note

Disable this only for troubleshooting.

Tip

Keep this enabled in production.

xpack.example.mode

Controls runtime mode.

Datatype: enum

Default: strict

Options:

  • strict - Full validation.
  • lenient - Reduced validation.
Warning

Lenient mode may hide configuration mistakes.

Important

Strict mode is recommended for production.

Deprecation details

The lenient option will be deprecated in a future release.

xpack.example.mode: strict

Advanced settings

These settings demonstrate nested entries and applies_to inheritance.

xpack.example.hosts

List of custom host settings.

Datatype: object

Default: []

xpack.example.hosts[n].url

Child setting inherits applies_to from the parent.

Datatype: string

xpack.example.hosts[n].mode

Child setting overrides applies_to.

Datatype: enum

Default: strict

Options:

  • strict - Requires strict checks.
  • lenient - Allows lenient checks.
Tip

Keep all host modes aligned to simplify troubleshooting and reduce drift.

xpack.example.hosts:
  - url: https://example.org
    mode: strict