Found while verifying adopter-facing configuration documentation against the v0.21.0 release.
Inconsistency
The codelist artifact grammar uses allowed_outputs (snake_case):
id: urn:gov:example:codelist:region-map
version: '1'
entries: {SOURCE-A: REGION-NORTH, SOURCE-B: REGION-SOUTH}
allowed_outputs: [REGION-NORTH, REGION-SOUTH]Every other multi-word key across the bundle and runtime grammars is camelCase (assuranceProfile, bundleDirectory, maximumFileBytes, holderBoundBatchMaxSize, acquisitionCapabilities, ...). allowed_outputs is the lone snake_case multi-word key an adopter writes, and it is easy to mistype as allowedOutputs, which the closed grammar rejects as an unknown key.
Suggested fix
Pre-1.0 this is still changeable: either rename to allowedOutputs for consistency, or, if the codelist artifact grammar is considered frozen with the Version 1 contract, document the exception explicitly where the artifact is described so adopters stop tripping on it.
Found while verifying adopter-facing configuration documentation against the v0.21.0 release.
Inconsistency
The codelist artifact grammar uses
allowed_outputs(snake_case):Every other multi-word key across the bundle and runtime grammars is camelCase (
assuranceProfile,bundleDirectory,maximumFileBytes,holderBoundBatchMaxSize,acquisitionCapabilities, ...).allowed_outputsis the lone snake_case multi-word key an adopter writes, and it is easy to mistype asallowedOutputs, which the closed grammar rejects as an unknown key.Suggested fix
Pre-1.0 this is still changeable: either rename to
allowedOutputsfor consistency, or, if the codelist artifact grammar is considered frozen with the Version 1 contract, document the exception explicitly where the artifact is described so adopters stop tripping on it.