Merge branch 'master' into feature/anforderungen

README.md

@@ -1,9 +1,16 @@
 # Unterlagen API
+
+### Scope der API
+Die Übertragung der Unterlagen des Verbrauchers zum Produktanbieter.
+
+### wichtigste Use Cases
 API um die [digitale Unterlagenakte](https://europace2.zendesk.com/hc/de/sections/360004174293-Die-digitale-Unterlagenakte) zu bedienen. Mit dieser API können folgende Aktionen durchgeführt werden:
 * Als Vertrieb kann ein Dokument am Vorgang hochgeladen werden.
 * Als Vertrieb kann ein Dokument kategorisiert werden und somit in eine Unterlage umgewandet werden.
 * Als Vertrieb können Unterlagen an Anträgen für Produktanbieter freigegeben werden.
 * Als Vertrieb und Produktanbieter können freigegebene Unterlagen an einem Antrag abgerufen werden.
+  * Hinweis zu Antragsdokumenten in Baufismart: nicht abrufbar sind Antragsdokumente wie z.b. die Kreditentscheidungsinformation oder die Selbstauskunft zum Antrag. Diese Dokumente können per https://github.com/europace/baufismart-antraege-api abgerufen werden.
+
 
 
 
@@ -37,6 +44,7 @@ Erste Schritte zur Nutzung der Europace APIs sind [hier](https://docs.api.europa
 Bitte benutze [![Authentication](https://img.shields.io/badge/Auth-OAuth2-green)](https://github.com/europace/authorization-api), um Zugang zur API bekommen.
 
 Um die API verwenden zu können, benötigt der OAuth2-Client folgende Scopes:
+
 | Scope                             | API Use case |
 |-----------------------------------|---------------------------------|
 | `unterlagen:dokument:lesen`       | als Vertrieb, Abruf der Metadaten und des Inhalts hochgeladener Dokumente. |

swagger.yaml

@@ -672,6 +672,53 @@ paths:
             - unterlagen:unterlage:lesen
       tags:
         - Seiten
+    put:
+      summary: Sortierung der Seiten Ändern
+      description: Seiten werden werden in der angegeben Reihenfolge gespeichert. Es kann die Liste aller Seiten oder auch eine Teilliste davon übergeben werden. Bei einer Teilliste wird die Position in der Gesamtliste durch die erste Seite der Teilliste bestimmt.
+      operationId: setzeReihenfolge
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: "#/components/schemas/SeitenReferenz"
+        description: Die Seiten-Referenzen der Seiten, die in dieser Reihenfolge gespeichert werden sollen.
+        required: true
+      responses:
+        "200":
+          description: Ok
+        "400":
+          description: Fehler in den Eingabedaten.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        "401":
+          description: Authentifizierung fehlgeschlagen durch z.b. fehlender/ungültiger Authorization Header
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        "403":
+          description: Authorisierung fehlgeschlagen durch z.b. fehlende Berechtigung auf den Vorgang
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        default:
+          description: Unerwarteter Fehler
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+      security:
+        - europace_oauth2_legacy:
+            - API
+        - europace_oauth2:
+            - unterlagen:unterlage:schreiben
+      tags:
+        - Seiten
   "/dokumente/zuordnung/{kategorie}":
     put:
       summary: Zuordnung (Kategorie und Bezug) für mehrere Seiten setzen
@@ -689,13 +736,6 @@ paths:
           required: false
           schema:
             type: string
-        - name: antragsNummer
-          in: query
-          description: z.T. beziehen sich die Angaben in der Seite auf Angaben im Vorgang
-            zum Zeitpunkt, als der Antrag angenommen wurde.
-          required: false
-          schema:
-            type: string
       requestBody:
         content:
           application/json: