Managed YAML

Managed YAML

Managed YAML is the higher-level DaisyConfig file model for versioned config ownership.

id string

Stable identifier for the managed file.

Required

path string

Disk path relative to the plugin data folder.

Required

resourcePath string

Bundled resource path used for first-run creation and default merge.

Optional

codec object

Typed decode shape for the managed file.

Required

versionKey string

YAML key that stores the schema version. Defaults to config_version.

Optional

currentVersion number

Current schema version expected by the codec.

Required

migrations object

Ordered list of migrations used to reach currentVersion.

Optional

mergePolicy enum

Controls whether missing keys are merged from bundled defaults.

Optional

Core types

• DaisyManagedYamlFile<T>
• DaisyManagedConfigHandle<T>
• DaisyManagedConfigMetadata
• DaisyManagedReloadResult<T>
• DaisyManagedMigrationReport
• DaisyYamlMergePolicy

Metadata

DaisyManagedConfigMetadata exposes:

• path
• versionKey
• currentVersion
• diskVersion

Use it when you want to log the currently observed file version or expose admin diagnostics.

Reports

DaisyManagedMigrationReport records:

• whether the file was created from defaults
• which keys were merged
• which keys were removed
• which keys were renamed or moved
• version before and after
• whether the file was written back

Merge policy

DaisyYamlMergePolicy.AddMissingKeys is the default and recommended behavior.

It:

• copies only missing deep keys
• does not overwrite user values
• does not remove unknown user keys

Use None only when you explicitly do not want bundled defaults merged into disk files.