docs(spec): align custom resource type YAML format with schema definition #5658

Merged
HAL9000 merged 2 commits from spec/resource-type-yaml-format-canonical-5622 into master 2026-06-19 06:04:42 +00:00

2 Commits

Author SHA1 Message Date
HAL9000 f4e9fa3183 docs(spec): add CHANGELOG entry for custom resource type YAML format fix (#5622)
CI / load-versions (pull_request) Successful in 15s
CI / push-validation (pull_request) Successful in 23s
CI / lint (pull_request) Successful in 39s
CI / helm (pull_request) Successful in 39s
CI / build (pull_request) Successful in 52s
CI / quality (pull_request) Successful in 54s
CI / security (pull_request) Successful in 1m22s
CI / typecheck (pull_request) Successful in 4m22s
CI / unit_tests (pull_request) Successful in 4m38s
CI / docker (pull_request) Successful in 2m17s
CI / integration_tests (pull_request) Successful in 8m28s
CI / coverage (pull_request) Successful in 9m53s
CI / status-check (pull_request) Successful in 3s
2026-06-19 01:49:37 -04:00
HAL9000 6eb7ceb3fd docs(spec): align custom resource type YAML format with schema definition
The spec had three inconsistent YAML formats for custom resource types
across different sections. The canonical format is defined in
docs/schema/resource_type.schema.yaml. Update spec examples to match:

- physical_or_virtual -> resource_kind (matches schema field name)
- cli_arguments -> cli_args (matches schema field name)
- allowed_parent_types -> parent_types (matches schema field name)
- checkpointable (top-level) -> capabilities.checkpoint (matches schema)
- readable/writable/sandboxable -> read/write/sandbox (matches schema)
- handler: ClassName -> handler: module:ClassName (matches schema format)
- classification -> resource_kind (fixes extensibility section)
- child_types: [{type: x}] -> child_types: [x] (matches schema items)
- document auto_discovery as the place for per-child discovery settings

Also update ResourceTypeRecord UML class diagram to match schema fields.

ISSUES CLOSED: #5622
2026-06-19 01:49:37 -04:00