cleveragents/cleveragents-core
4
0
Fork 3
Code Issues 6.0k Pull Requests 115 Actions Packages Projects Releases Wiki Activity

docs(spec): fix custom resource type YAML example to match implementation format #5717

Closed
HAL9000 wants to merge 1 commits from spec/fix-resource-type-yaml-format-5622 into master
pull from: spec/fix-resource-type-yaml-format-5622
merge into: cleveragents:master
Conversation 4 Commits 1 Files Changed 1
+43 -47

1 Commits

Author SHA1 Message Date
HAL9000 6175e4aba0 docs(spec): fix custom resource type YAML example to match implementation format
CI / lint (pull_request) Successful in 22s
Details
CI / security (pull_request) Successful in 56s
Details
CI / typecheck (pull_request) Successful in 1m17s
Details
CI / quality (pull_request) Successful in 30s
Details
CI / build (pull_request) Successful in 26s
Details
CI / helm (pull_request) Successful in 25s
Details
CI / push-validation (pull_request) Successful in 15s
Details
CI / e2e_tests (pull_request) Successful in 3m16s
Details
CI / integration_tests (pull_request) Successful in 7m36s
Details
CI / unit_tests (pull_request) Successful in 8m30s
Details
CI / docker (pull_request) Successful in 2m31s
Details
CI / coverage (pull_request) Successful in 12m19s
Details
CI / status-check (pull_request) Successful in 1s
Details
CI / benchmark-publish (pull_request) Has been skipped
Details
CI / benchmark-regression (pull_request) Successful in 57m40s
Details 
Relates to #5622

The §Custom Resource Types section showed an incorrect YAML format with:
- resource_type: wrapper (not supported by implementation)
- cleveragents: version header (not supported)
- physical_or_virtual: (implementation uses resource_kind:)
- cli_arguments: (implementation uses cli_args:)
- allowed_parent_types: (implementation uses parent_types:)
- handler: DatabaseHandler (string, implementation expects object with class/module)
- capabilities.readable/writable/sandboxable/checkpointable (implementation uses read/write/sandbox/checkpoint)

Updated the database.yaml example to use the correct flat format that matches
ResourceTypeSpec.from_config() in resource_type.py:
- Flat format (no resource_type: wrapper)
- resource_kind: physical (not physical_or_virtual:)
- cli_args: (not cli_arguments:)
- parent_types: (not allowed_parent_types:)
- handler: {class: ..., module: ...} (object format)
- capabilities: {read, write, sandbox, checkpoint}

The §Resource Type Configuration Files section (line ~34780) already uses the
correct format and serves as the authoritative reference.
 2026-04-09 08:45:37 +00:00