diff --git a/assets/images/use_case_documentation/application_retrieval.png b/assets/images/use_case_documentation/application_retrieval.png new file mode 100644 index 0000000000000000000000000000000000000000..39008a717ec53aed0a26f56e3f83d017794724ab Binary files /dev/null and b/assets/images/use_case_documentation/application_retrieval.png differ diff --git a/assets/images/use_case_documentation/Use_Case_Diagramm.png b/assets/images/use_case_documentation/use_case_diagramm.png similarity index 100% rename from assets/images/use_case_documentation/Use_Case_Diagramm.png rename to assets/images/use_case_documentation/use_case_diagramm.png diff --git a/docs/3_Use_Cases_der_API.md b/docs/3_Use_Cases_der_API.md index a6e2b8c58fa904f4e9a3d19643d43a54d84891fb..addd5a8b0154e44abd1cb5db242a271edc34715c 100644 --- a/docs/3_Use_Cases_der_API.md +++ b/docs/3_Use_Cases_der_API.md @@ -4,8 +4,6 @@  - - ### Legende der verwendeten BPMN Symbole bei Anwendungsfallabläufen #### Aktivität @@ -58,9 +56,9 @@ Parallelisierungspunkt innerhalb des Prozessablauf. Prozessflüsse nach dem para **Vorbedingung:** Keine -**Ziel:** Es wird ein Zustellpunkt eingerichtet und verwaltet, über den der Subscriber Anträge empfangen kann. Hierdurch wird ein Zugang für alle Sender eröffnet, der über die ´destination-id` eindeutig adressierbar ist. +**Ziel:** Es wird ein Zustellpunkt (`destination`) eingerichtet und verwaltet, über den der Subscriber Anträge empfangen kann. Hierdurch wird ein Zugang für alle Sender eröffnet, der über die `destination-id` eindeutig adressierbar ist. -**Beschreibung:** Der Subscriber erstellt einen Zustellpunkt per POST und bekommt von der API eine eindeutige ´destination-id`. Für diesen Zustellpunkt sind noch fachliche und technische Ansprechpartner zu definieren und das Schema der Inhaltsdaten zu definieren. Zusätzlich besteht die Möglichkeit, eine Callback URL zu definieren, über die der Zustelldienst den Subscriber über neue Anträge informieren kann. +**Beschreibung:** Der Subscriber erstellt einen Zustellpunkt per POST und bekommt von der API eine eindeutige `destination-id`. Für diesen Zustellpunkt sind noch fachliche und technische Ansprechpartner zu definieren und das Schema der Inhaltsdaten zu definieren. Zusätzlich besteht die Möglichkeit, eine Callback URL zu definieren, über die der Zustelldienst den Subscriber über neue Anträge informieren kann. ### Benachrichtigungen über Anträge erhalten @@ -70,10 +68,11 @@ Parallelisierungspunkt innerhalb des Prozessablauf. Prozessflüsse nach dem para **Beschreibung:** Bei der Benachrichtung nimmt der Subscriber die Rolle eines API Providers auf, indem dieser Benachrichtigungen empfängt. Der Zustelldienst sendet beim Vorliegen einer oder mehrer Anträge in einem Zustellpunkt an die Callback URL einen POST mit allen `application-id's` der abholbereiten Anträge. -### Benachrichtigungen über Anträge erhalten +### Anträge abrufen -**Vorbedingung:** +**Vorbedingung:** Der Subscriber hat einen Zustellpunkt erstellt und einem oder mehreren Sendern die dazugehörige ´destination-id´ mitgeteilt. -**Ziel:** +**Ziel:** Ziel ist es, abgegebene und abholbereite Anträge abzurufen. **Beschreibung:** + diff --git a/docs/4_Authentifizierung_und_Autorisierung.md b/docs/4_Authentifizierung_und_Autorisierung.md index d110a8c2b13f8912e6647a441938d9e6280a2e66..2aa66cb98f7d9a1a1e9961462a23f59193ea46e7 100644 --- a/docs/4_Authentifizierung_und_Autorisierung.md +++ b/docs/4_Authentifizierung_und_Autorisierung.md @@ -1,3 +1,7 @@ # Authentifizierung und Autorisierung -The beginning of an awesome article... +... + +**Noch in Arbeit** + +... \ No newline at end of file diff --git a/docs/7_Begrenzung_von_Abrufen.md b/docs/7_Begrenzung_von_Abrufen.md index 1c5936868d0fde52014d9eda54ff6b75c7b28854..f6a21d5a82183f86284ba0620190ae862fac2ede 100644 --- a/docs/7_Begrenzung_von_Abrufen.md +++ b/docs/7_Begrenzung_von_Abrufen.md @@ -1,3 +1,7 @@ # Begrenzung von Abrufen -The beginning of an awesome article... +... + +**Noch in Arbeit** + +... \ No newline at end of file diff --git a/docs/99_Glossar.md b/docs/99_Glossar.md index 1b65f89afdf063a3aa9bcc6a06d6a072a381e38b..3de05ad0d4a6357b2514378f1701c13569c366c6 100644 --- a/docs/99_Glossar.md +++ b/docs/99_Glossar.md @@ -1,3 +1,7 @@ # Glossar -The beginning of an awesome article... +... + +**Noch in Arbeit** + +... \ No newline at end of file