Skip to content

[v2] Dokumentation ZSD 2.0

User Story

Als Nutzer von FIT-Connect möchte ich alle relevanten Informationen über neuen Versionen der APIs und der Metadaten in der Dokumentaion finden können.

Warum

Links, Hinweise, Bemerkungen

Für die Dokumentation soll eine Merge Request erstellt werden, sodass die Doku zum gewünschten Zeitpunkt bereitgestellt werden kann. Die Dokumentation wird gerade neu strukturiert. Daher wird die Doku für die v2 in zwei Schritten in zwei Merge Requests erstellt:

  1. Migrations-Guide v1 auf v2 auf einer eigenen Seite für die Zielgruppe "Entwickler"
  2. Die gesamte restliche Dokumentation

Akzeptanzkriterien

  1. Es gibt einen Migraions-Guide v1 auf v2 für Entwickler: docs!1124
  2. Für die in Epic #3302 umgesetzten Änderungen wurde ein Merge Request in Doku-Repo erstellt.
  3. Die Doku zu "GET destination in der Submission API nur noch als öffentlicher Endpunkt" #3319 ist in der API-Spec und dem Migration-Guide enthalten.
  4. Die Doku zu "Array submissionIds in den Webhooks optional" #3323 ist darin enthalten (Gibt dazu über die API-Spec hinaus eine Dokumentation?).
  5. Die Doku zu "Event forward-submission abkündigen / entfernen" #3420 ist darin enthalten (https://docs.fitko.de/fit-connect/docs/getting-started/event-log/set-creation und https://docs.fitko.de/fit-connect/docs/getting-started/event-log/events).
  6. Die Doku zu "'jwk.use' nicht mehr rausgeben" #3325 ist darin enthalten (Gibt dazu über die API-Spec hinaus eine Dokumentation?)
  7. Die Doku zu "Abgekündigtes Objekt 'Callback' nicht mehr ausgeben" #3326 ist darin enthalten (Gibt dazu über die API-Spec hinaus eine Dokumentation?)
  8. Die Doku zu "'destination.replyChannels' auf Root-Ebene nicht mehr rausgeben und nicht mehr annehmen" #3328 ist darin enthalten (Gibt dazu über die API-Spec hinaus eine Dokumentation?)
  9. Die Doku zu "Vereinheitlichung serviceType vs. service vs. publicServiceType" #499 ist darin enthalten (Gibt dazu über die API-Spec hinaus eine Dokumentation?)
  10. Die Doku zu "Versenden von Einreichungen (Submissions) ohne Fachdaten nicht mehr erlauben (required encryptedData)" #322 ist darin enthalten (https://docs.fitko.de/fit-connect/docs/sending/start-submission) -> Gibt es schon eine geeignete Stelle in der Doku, an der man darauf hinweisen sollte?
  11. Die Doku zu "Unterstützung für Legacy Trailing-Slashes in Pfaden muss nicht mit übernommen werden, d.h. aus GET /v1/cases und GET /v1/cases/ wird nur GET /v2/cases" ist darin enthalten.
  12. Zu "Metadaten v2" werden im Metadatenschema und unter "Überlick" die Angaben zu den umgesetzen Änderungen (#3320, #3188, #3242, #3452, #1301) angezeigt.
  13. Zu "Metadaten v2" #3320 ist dokumentiert, dass für individuelle Daten ein dataSet zu verwenden ist, dessen Schema der Sender bereitzustellen hat (Neue Seite "Metadaten" - "DataSets"). Das Objekt additionalReferenceInfo darf dagegen nicht mehr erweitert werden ("Metadaten" - "Weitere Angaben" - "additionalReferenceInfo").
  14. Zu "Metadaten v2" #3320 wird das anstelle des Objekts authenticationInformation eingeführte DateSet mit Schema https://raw.githubusercontent.com/Governikus/IdentificationReport/2.0.0/schema/identification-report.json in der Dokumentation referenziert und dessen Verwendung beschrieben ("Metadten" - "Authentifizierung").
  15. Zu "Metadaten v2" #3188 Zustimmung zum elektronischen Bescheid in den Metadaten ist die Verwendung unter "Metadaten" - "Weitere Angaben" - "additionalReferenceInfo" beschrieben.
  16. Zu "Metadaten v2" #3242 Absenderinfo in den Metadaten ist auf der neuen Seite "Metadaten" - "Absenderinformationen" das Element author beschieben.
  17. Zu "Metadaten v2" #3452 $schema verpflichtend im Metadatensatz wird unter "Metadaten" - "Überblick" auf die verpflichtende Angabe hingewiesen.
  18. In der Dokumentation zum Senden von Submissions wird auf darauf hingewiesen, das bei Fachdaten, Metadaten und Anlagen Kompression nicht mehr erlaubt ist (#2849)

Mögliche Folgeaktivitäten (vom Entwickler zu ergänzen)

Edited by Andreas Aschauer