From 5f571df9eecdb04d498ce5d23ae0cce28b8bb5ae Mon Sep 17 00:00:00 2001 From: Jonas Groeger <jonas.groeger@codecentric.de> Date: Thu, 27 Oct 2022 17:28:41 +0200 Subject: [PATCH] docs(changelog): submission-api 1.1.3 --- docs/changelog.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/docs/changelog.md b/docs/changelog.md index 7ff742fc0..fd3c7b668 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -50,6 +50,48 @@ Das hier veröffentlichte Changelog bezieht sich auf die [Testinstanz von FIT-Co - Die Informationen zu den verfügbaren Betriebsumgebungen aus dem Artikel [Getting Started](getting-started/get-started.mdx) wurden in den neuen Artikel [Betriebsumgebungen](getting-started/environments.mdx) verschoben und um die URLs der Staging- und Produktivumgebung ergänzt. - Hinweis auf Möglichkeit der Prüfung der für die SET-Erstellung genutzten Zertifikate in der Staging- und Produktivumgebung im Artikel [Prüfung eines Security-Event-Token (SET)](getting-started/event-log/set-validation.mdx) ergänzt +## 2022-10-26 + +### Submission API 1.1.3 + +Version 1.1.3 der Submission API behebt u.a. einige Fehler der Version 1.1.2. + +In den Endpunkten + +- `GET /v1/destinations` +- `POST /v1/destinations` +- `POST /v1/destinations/<destinationId>/keys` +- `PUT /v1/destinations/<destinationId>` +- `PATCH /v1/destinations/<destinationId>` +- `DELETE /v1/destinations/<destinationId>` + +sind folgende Änderungen vorgenommen worden: + +- Der Endpunkt ist nicht mehr als `deprecated` markiert. +- Im Endpunkt wurde der Tag `Zustellpunktverwaltung` durch durch `Internal` ersetzt (reine Anpassung der API-Dokumentation ohne technische Änderungen). [Commit](https://git.fitko.de/fit-connect/submission-api/-/commit/3e763ec5052c1bd91ed140ac707f2b7d0c6f1cc4) + +Weiterhin: +- Rückkanäle (`replyChannels`) wurden als `deprecated` markiert. Diese werden in Zukunft in die Services einer Destination verschoben. [Commit](https://git.fitko.de/fit-connect/submission-api/-/commit/d677e6eea06c52a4db269ef64ab22bef37b421df) +- Die API Spezifikation verwendet nun keine relativen Referenzen mehr. Dies hat zu Problemen bei Codegeneratoren geführt. [Commit](https://git.fitko.de/fit-connect/submission-api/-/commit/61ebe1eaadf4e4fc6e53e83ab4c77df4d3c92bfc) +- Die Anzeige der API Spezifikation im Browser ist nun schneller ohne die Abhängigkeit auf unpkg.com. [Commit](https://git.fitko.de/fit-connect/submission-api/-/commit/c2b1e1c9312ccabb5954710d9a86e5595698ef3f) +- Hinweis entfernt: Endpunkte mit Tag `Zustellpunktverwaltung` sind als `deprecated` anzusehen (reine Anpassung der API-Dokumentation ohne technische Änderungen). + +## 2022-10-20 + +### Submission API 1.1.2 + +- Da das Destination Management in Zukunft über die Self-Service API gehandhabt wird sind einige Änderungen an der Submission API nötig: + - Der Endpunkt `GET /v1/destinations` wurde als `deprecated` markiert. + - Der Endpunkt `POST /v1/destinations` wurde als `deprecated` markiert. + - Der Endpunkt `POST /v1/destinations` wurde mit `Zustellpunktverwaltung` statt `Internal` markiert. + - Der Endpunkt `POST /v1/destinations/<destinationId>/keys` wurde als `deprecated` markiert. + - Der Endpunkt `GET /v1/destinations/<destinationId>/keys/<keyId>` wurde vom Tag `Zustellpunktverwaltung` befreit. + - Beim Endpunkt `GET /v1/destinations/<destinationId>` wurde der Tag `Zustellpunktverwaltung` durch `Einreichungsübermittlung` ersetzt. + - Der Endpunkt `PUT /v1/destinations/<destinationId>` wurde als `deprecated` markiert. + - Der Endpunkt `PATCH /v1/destinations/<destinationId>` wurde als `deprecated` markiert. + - Der Endpunkt `DELETE /v1/destinations/<destinationId>` wurde als `deprecated` markiert. +- Die Fehler in den Beispielen im Endpunkt `PATCH /v1/destinations/<destinationId>` wurden behoben. [Commit](https://git.fitko.de/fit-connect/submission-api/-/commit/045fed84b19d1d1470d961c3580d2d0829fc409e) + ## 2022-10-17 ### Dokumentation - Die Dokumentation beschreibt nun, wie Onlinedienste und Fachverfahren an FIT-Connect angebunden werden. <br/> -- GitLab