From 8e8538dadb967efa921df2ee205cd68a02b57dcf Mon Sep 17 00:00:00 2001
From: David Schwarzmann <david.schwarzmann@codecentric.de>
Date: Sun, 27 Jun 2021 22:20:10 +0200
Subject: [PATCH] Reference on overview section for giving feedback
---
docs/{overview.mdx => overview.md} | 1 +
docs/roadmap.md | 6 ++++--
2 files changed, 5 insertions(+), 2 deletions(-)
rename docs/{overview.mdx => overview.md} (99%)
diff --git a/docs/overview.mdx b/docs/overview.md
similarity index 99%
rename from docs/overview.mdx
rename to docs/overview.md
index a643831a..35c8a440 100644
--- a/docs/overview.mdx
+++ b/docs/overview.md
@@ -57,4 +57,5 @@ Durch die einfache Anbindung und Nutzung bietet sich die FIT-Connect API auch do
Die Entwicklung und Bereitstellung der FIT-Connect API erfolgt im Rahmen eines Proof of Concepts für die geplante föderale Integrations- und Entwicklungsplattform FIT-Connect. Seit dem zweiten Quartal 2020 ist es interessierten Parteien möglich, einen Zugang zur FIT-Connect API zu bekommen und eine prototypische Anbindung von Verfahren umzusetzen.
## Ich habe einen Fehler in der Dokumentation oder in der API-Spezifikation gefunden. Wo kann ich diesen melden?
+
Vielen Dank für das Interesse an unserer Entwickler:innendokumentation! Wir freuen uns immer über Feedback und Anregungen über unser Funktionspostfach fit-connect ät fitko.de. Zudem können wir bei Interesse gerne einen Zugang zu unserem GitLab zur Eröffnung von Issues oder Einreichung von Merge-Requests einrichten.
diff --git a/docs/roadmap.md b/docs/roadmap.md
index 6a89db9e..b8d4de7f 100644
--- a/docs/roadmap.md
+++ b/docs/roadmap.md
@@ -1,6 +1,6 @@
# Roadmap
-Die FIT-Connect Einreichungs-API und die dazugehörige Infrastruktur wird in einem Projekt des IT-Planungsrats im Jahr 2021 zu einer Produktreife entwickelt. Die Umsetzung der Projektliefergegenstände erfolgt iterativ, um eine schnelle Erprobung und Feedback zu ermöglichen.
+Die FIT-Connect Einreichungs-API und die dazugehörige Infrastruktur wird in einem Projekt des IT-Planungsrats im Jahr 2021 zu einer Produktreife entwickelt. Die Umsetzung der Projektliefergegenstände erfolgt iterativ, um eine schnelle Erprobung und Feedback zu ermöglichen.
Die Roadmap soll daher einen Überblick verschaffen, wann das FIT-Connect Team für die folgende Projektliefergegenstände neue Features anstebt:
@@ -12,6 +12,8 @@ Die Roadmap wird laufend aktualisiert und erweitert. Unser Team versucht weitest
Wir nehmen gerne neue Wünsche & Anregungen für die FIT-Connect API als Issue auf unserem Projekt (https://git.fitko.de/fit-connect/api) entgegen und versuche diese Issues nach einer Umsetzungsprüfung in unsere Roadmap aufzunehmen.
+> Wünsche & Anregungen oder Fehler können über den [hier](overview.md#ich-habe-einen-fehler-in-der-dokumentation-oder-in-der-api-spezifikation-gefunden-wo-kann-ich-diesen-melden) beschriebenen Prozess abgegeben werden können.
+
## Überblick über die Zeitplanung
- **Seit 24.06.2021:** Preview der API-Spezifikation und der Entwicklerdokumentaion für die Version 1.0 der API ist online und ist für alle interessierten Entwickler zugänglich.
@@ -25,7 +27,7 @@ Wir nehmen gerne neue Wünsche & Anregungen für die FIT-Connect API als Issue a
- **Bereitstellung und Übermittlung des Security Event Logs:** Der bisherige Übermittlungsstatus wird durch einen Security Event Log ersetzt, der aus signierten Security Event Tokens besteht und die einzelnen Übermittlungsschritte beweissicher dokumentiert. Die jeweiligen Security Event Tokens sind durch die jeweils verantwortlichen Systeme (Zustelldienst bzw. das empfangende System) zu erstellen und zu signieren. Dieser Security Event Log kann über die API von beiden Parteien abgerufen werden und dient späteren Nachweisen über die korrekte Zustellung.
- **Callbacks zur Benachrichtigung sendender Systeme:** Sendende Systeme bekommen die Möglichkeit für Submissions einen Callback einzurichten. Über diesen Callback informiert der Zustelldienst sendende Systeme, sobald es Änderungen im Zustellstatus. Durch den Callback soll ein regelmäßiges Polling des Security Event Log zur Prüfung des Zustellstatus unötig gemacht werden.
- **Neuumsetzung von Features:** Einige Features aus der Beta7 Version der API wie die Abfrage von Destination Informationen und die Abfrage von abholbereiten Anträgen werden neu konzipiert und sind in der aktuellen Preview noch nicht enthalten.
-- **Neues Client Autorisierungskonzept auf Basis des bestehen Client Credentials Flows:** Ein neues OAuth Konzept soll umgesetzt werden, da detailierte Berechtigung für den API-Zugriff ermöglicht und höhere Sicherheit für die Nutzung von Access Token gewährleistet. Hieraus werden auch Änderungen in der Erstellung von neuen Destinations entstehen.
+- **Neues Client Autorisierungskonzept auf Basis des bestehen Client Credentials Flows:** Ein neues OAuth Konzept soll umgesetzt werden, da detailierte Berechtigung für den API-Zugriff ermöglicht und höhere Sicherheit für die Nutzung von Access Token gewährleistet. Hieraus werden auch Änderungen in der Erstellung von neuen Destinations entstehen.
### Entwicklerdokumentation- und tools
--
GitLab