Skip to content

.NET-SDK: Prüfung $schema-Attribut des Metadatensatzes

Warum?

Aktuell unterstützen die SDKs nur die Version 1.x.x des Metadatenschemas. Um undefiniertes Verhalten bei der Veröffentlichung des Metadatenschemas in der Version 2.x.x zu verhindern, soll in den SDKs geprüft werden, dass tatsächlich Version 1 zum Einsatz kommt.

Relevante Links und Bemerkungen

  • Derzeit ist das $schema-Attribut im Metadatensatz nicht vorhanden. Mit #267 (closed) soll es eingeführt werden (optional). Mit #572 soll es verpflichtend werden.
  • Siehe Doku-Changes in docs!309 (diffs)
  • Hinweis: Die Prüfung des $schema-Attributs kann auch durch Aktualisierung des Metadaten-Schemas und Einbindung der neuen Metadaten-Schema-Version im SDK erfolgen.

Akzeptanzkriterien

  1. Bei Erzeugen des Metadatensatzes wird das $schema-Attribut gemäß der neusten vom SDK unterstützten Version gesetzt.
  2. Das SDK prüft vor der Schema-Prüfung des Metadatensatzes, ob das $schema-Attribut entweder gar nicht vorhanden ist oder den Wert https://schema.fitko.de/fit-connect/metadata/1.y.z/metadata.schema.json enthält, wobei y und z beliebige Zahlen sind. Andernfalls (es handelt sich um ein Metadatenschema in Version 2+) wird die Verarbeitung der Einreichung abgebrochen (und ein Reject-Event geschrieben).
  3. Nach wie vor wird bei nicht-unterstützten Schema-Versionen ein Reject-Event mit https://schema.fitko.de/fit-connect/events/problems/unsupported-schema-Problem erzeugt.

Durchführungsplan (von Entwickler:in bei Umsetzungsplanung auszufüllen)

Edited by Klaus Fischer