Skip to content
Snippets Groups Projects
Commit 94bd136e authored by Jonas Gröger's avatar Jonas Gröger :palm_tree:
Browse files

docs: wordings

parent 842af9d7
No related branches found
No related tags found
1 merge request!18Umbenennung von Antragsformular / Dokument in Anhang
operationId: create-destination
summary: Zustellpunkt anlegen
description: 'Erstellung eines neuen Zustellpunktes mit bestimmten, unterstüzten Antragsschemata.'
description: Erstellung eines neuen Zustellpunktes mit unterstüzten Antragsschemata.
tags:
- Destination Management
security:
......@@ -15,7 +15,6 @@ requestBody:
examples:
example-1:
$ref: '../../examples/destination-request.yml'
description: Struktur zur Erstellung eines neuen Zustellpunktes
responses:
'201':
description: Created
......@@ -56,4 +55,4 @@ callbacks:
$ref: '../../schemas/list-of-application-ids.yml'
responses:
'202':
description: Accepted
\ No newline at end of file
description: Accepted
operationId: update-destination
summary: Zustellpunkt aktualisieren
description: Ermöglicht es bestimmte Attribute eines Zustellpunktes zu aktualisieren.
description: Aktualisiert einen Zustellpunkt.
tags:
- Destination Management
security:
......@@ -49,4 +49,4 @@ responses:
content:
application/json:
schema:
$ref: ../../responses/error-response.yml
\ No newline at end of file
$ref: ../../responses/error-response.yml
operationId: get-application-document
summary: Get Application Document
description: Ruf ein Dokument (Formular oder Anlage) der Application ab.
description: Ruf ein Dokument (z.B. Antragsformular / Anlage) der Application ab.
tags:
- Application Retrieval
security:
......@@ -40,4 +40,4 @@ responses:
content:
application/json:
schema:
$ref: ../../responses/error-response.yml
\ No newline at end of file
$ref: ../../responses/error-response.yml
operationId: add-application-document
summary: Add Application Document
description: 'Lädt ein verschlüsseltes und über Base64 kodiertes Antragsformuar oder Anhang hoch, um ihn dem Antrag hinzuzufügen.'
description: Fügt ein verschlüsseltes, base64 kodiertes Antragsformular / Anhang einem Antrag hinzu.
tags:
- Application Transfer
security:
......@@ -51,4 +51,4 @@ responses:
content:
application/json:
schema:
$ref: ../../responses/error-response.yml
\ No newline at end of file
$ref: ../../responses/error-response.yml
......@@ -6,4 +6,4 @@ schema:
format: uuid
minLength: 32
maxLength: 36
description: Die ID des Dokuments im Format einer UUID v4, die vom API-Nutzer selbst definiert werden kann, um Referenzen in den Fachdaten des Antrags zu ermöglichen
\ No newline at end of file
description: Die ID des Dokuments im Format einer UUID v4, die vom API-Nutzer selbst definiert werden kann, um Referenzen in den Fachdaten des Antrags zu ermöglichen.
description: 'Dieses Authentifizierungsmethode wird genutzt, um den Zugriff auf die API zu autorisieren. (RFC8725)'
description: Diese Authentifizierungsmethode wird genutzt, um den Zugriff auf die API nach RFC8725 zu autorisieren.
type: oauth2
flows:
clientCredentials:
......@@ -6,4 +6,4 @@ flows:
scopes:
'destination:send': Dieser Zufriffsbereich erlaubt es Anträge an Zustellpunkte über die Application Sender API zu senden.
'destination:manage': Erlaubt die volle Verwaltung der Zustellpunkte.
'destination:susbcribe': Dieser Zufriffsbereich erlaubt über den Callback erhaltene Anträge abzufragen und abzuarbeiten.
\ No newline at end of file
'destination:susbcribe': Dieser Zufriffsbereich erlaubt über den Callback erhaltene Anträge abzufragen und abzuarbeiten.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment