registrystack / registrystack/registry-stack
Decide the casing of the codelist allowed_outputs key
- Vorherrschende Sprache
- Rust
- Sterne
- 2
- Forks
- 0
- Ø Merge
- 2 Std. 55 Min.
- Gemergte PRs (30 T.)
- 130
Beschreibung
Found while verifying adopter-facing configuration documentation against the v0.21.0 release.
## Inconsistency
The codelist artifact grammar uses `allowed_outputs` (snake_case):
```yaml
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.
Beitragsleitfaden
Rechercherichtung
Beginne damit, die im Issue beschriebene Grammatik des Codelist-Artefakts und die Konfigurationsdokumentation für Adopter zu finden; vergleiche dann allowed_outputs mit den anderen mehrwortigen Schlüsseln in Bundle- und Laufzeitgrammatiken. Erledigt ist die Aufgabe, wenn die Entscheidung zur Groß-/Kleinschreibung festgehalten ist und entweder die relevanten Grammatikreferenzen einheitlich aktualisiert oder die Ausnahme für Adopter ausdrücklich dokumentiert wurde.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100