Legende fuer Keys in JSON Payloads
Die durch das generierte JSON Schema beschriebenen Daten sind fuer sich allein genommen nicht ohne eine Legende zu verstehen, da keine interpretierbaren Namen sondern FIM-IDs als Keys verwendet werden:
{
"G00001234": {
"F00001": "some value",
"F00002": "some other value",
"F00003": true
}
}
Im Treffen zwischen @oc00001428441 und dem DataBund ist herausgekommen, dass der Support bei Validierungsfehlern haeufig schwierig ist, da weder die Fehlermeldungen noch die Daten selbst eine einfache Interpretation des Fehlers zulassen. Wir konnen diesen Use-Case einfach unterstuetzen, indem wir zu den Keys in den Daten eine einfache Legende aus unserem Datenbestand erzeugen.
Akzeptanzkriterien
-
API-Endpunkt, der anhand eines JSON Datenobjektes ein JSON Objekt mit Informationen ueber die Keys liefert -
HTML-Endpunkt zur einfachen Verwendung im Browser -
Tests -
Aufnahme in OpenAPI Docs
Edited by Felix Bernhardt