Merge branch '4363c375' into develop

README.md

+# FIT-Connect API-Spezifikation
+
+Für die Spezifikation der FIT-Connect-Schnittstellen gelten die folgenden Architekturregeln.
+
+## OpenAPI
+- Wir verwenden OpenAPI 3.0
+- Die Spezifikation wird bis zur `beta7` als JSON und ab `beta8` als YAML geschreiben
+- Wir verwenden keine Versionsnummern in Dateinamen, da das Repo als Ganzes versioniert wird
+
+## Verzeichnisse
+Das Projektverzeichnis ist wie folgt aufgebaut:
+
+- 📁`assets`
+  - 📁`images` - Bilder
+  - 📁`postman` - Postman-Collection und -Enviroment dazu
+- 📁`docs` - Öffentliche Dokumentation zu den APIs
+- 📁`models` - Modelle, die von mehreren (beiden) APIs verwendet werden
+- 📁`reference` - Die APIs
+- 📄`LICENSE`
+
+## Bezeichner
+- Die Bezeichner werden camelCase geschreiben und beginnen mit einem Kleinbuchstaben
+- Eine ID (Identifikator) wird als `Id` (nicht `ID`) geschrieben
+
+## Pfade
+Multiple Resoucen werden im Pfad durch eine Collection-Resource und einer nachfolgenden ID aufgenommen
+
+Beispiel: `/destinations/{destinationId}/applications/{applicationId}`

docs/_Overview.md

@@ -19,7 +19,7 @@ Die XFall API besteht aus zwei getrennt nutzbaren APIs:
 Diese beiden APIs werden durch einen zentralen Intermediär (`XFall Zustelldienst`) bereitgestellt. Um auf diese APIs zuzugreifen, müssen interessierte Entwickler ihre Anwendungen beim FIT-Connect Autorisierungsdienst vorab registrieren.
 
 ### Zusammenspiel der APIs in der Antragsübermittlung
-![Applicationtransfer_Architecture](https://raw.githubusercontent.com/fiep-poc/assets/2c7cc84217ea55a3004751c62ef49e80458b579a/images/api_overview/XFall_Integration_Architecture.jpg "Antragsübertragungsarchitektur FIT-Connect")
+![Applicationtransfer_Architecture](../assets/images/api_overview/XFall_Integration_Architecture.png "Antragsübertragungsarchitektur FIT-Connect")
 
 Über die `Application Subscriber API` können die zuständigen Stellen für ihre Systeme einen Zustellpunkt eröffnen, der über eine `destination-Id` eindeutig adressierbar ist. Für diese Zustellpunkte legen die zuständigen Stellen alle fachlichen Vorgaben (Zulässige Fachstandards, Verschlüsselung, Datenformate etc.) fest, damit eine medienbruchfreie Weiterverarbeitung in ihren Systemen gewährleistet ist. Über die Angabe der `destination-Id` in der `Application Sender API` können beliebige antragssendende Systemen Anträge an die zuständige Stelle senden.
 
@@ -47,4 +47,4 @@ Durch die einfache Anbindung und Nutzung bietet sich die XFall API auch dort an,
 
 ## In welchem Stand befindet sich XFall REST API und wann kann man die API nutzen?
 
-Die Entwicklung und Bereitstellung der XFall REST 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 XFall API zu bekommen und eine prototypische Anbindung von Verfahren umzusetzen.
\ No newline at end of file
+Die Entwicklung und Bereitstellung der XFall REST 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 XFall API zu bekommen und eine prototypische Anbindung von Verfahren umzusetzen.