registrystack / registrystack/registry-stack
Decide the casing of the codelist allowed_outputs key
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Rust
- Estrellas
- 2
- Forks
- 0
- Merge medio
- 2 h 55 min
- PR fusionados (30 d)
- 130
Descripción
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza localizando la gramática del artefacto codelist y la documentación de configuración dirigida a los adoptantes descritas en el issue; después compara allowed_outputs con las otras claves de varias palabras de las gramáticas del bundle y del runtime. Se considera terminado cuando la decisión sobre el uso de mayúsculas y minúsculas queda registrada y las referencias gramaticales pertinentes se actualizan de forma coherente o la excepción se documenta explícitamente para los adoptantes.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100