From 2cd3f2ccfdc46619810a86d532504248fae85099 Mon Sep 17 00:00:00 2001
From: Frank Schubert <fronk@fronk.at>
Date: Mon, 12 Dec 2022 15:14:32 +0100
Subject: [PATCH] updated preorder-api.yaml, added /addressdb/searchAddress

---
 public/docs/preorder-api.yaml | 81 ++++++++++++++++++++++++++++++++++-
 1 file changed, 80 insertions(+), 1 deletion(-)

diff --git a/public/docs/preorder-api.yaml b/public/docs/preorder-api.yaml
index 01d0c792a..1388cd3f2 100644
--- a/public/docs/preorder-api.yaml
+++ b/public/docs/preorder-api.yaml
@@ -15,6 +15,79 @@ tags:
   - name: preorder
     description: Informationen zum Netzgebiet und Speichern von Vorbestellungen
 paths:
+  /addressdb/searchAddress:
+    get:
+      tags:
+        - addressdb
+      summary: Freitextsuche nach Adressen
+      description: Sucht Adressen die den Suchbegriff beinhalten. Retourniert Adressen mit Wohneinheiten
+      operationId: findAddresses
+      parameters:
+        - name: format
+          description: "Ausgabeformat: `flat` (Ein Array-Element pro Wohneinheit mit Gebäudedaten; **default**) oder `tree` (Ein Array-Element pro Gebäude mit Wohneinheiten-Array)"
+          in: query
+          schema:
+            type: string
+          example: flat
+        - name: search
+          description: Suchbegriff
+          in: query
+          schema:
+            type: string
+          required: true
+      responses:
+        '200':
+          description: |
+            Successful operation
+            
+            Der Rückgabewert `preorderType` gibt an, welche Vorbestelltypen an dieser Adresse erlaubt sind:
+            
+            | preorderType | description |
+            |--------------|-------------|
+            | interest     | Interessensbekundung |
+            | provision    | Vorsorgeanschluss |
+            | order        | Vollanschluss |
+            | reorder      | Nachbestellung (nach Bauabschluss) |
+            
+            Ein leeres Array bedeutet, dass derzeit kein Ausbau stattfindet/geplant ist.
+            
+            ---
+            
+            Ist bekannt, dass die Adresse zukünftig ausgebaut wird, steht im Feld `rollout_year` das geplante Ausbaujahr. `rollout_info` kann weitere informationen beinhalten.
+          content:
+            "application/json (format: tree)":
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                    description: Status string
+                    example: OK
+                  result:
+                    type: object
+                    properties:
+                      addresses:
+                        $ref: '#/components/schemas/AddressesTree'
+            "application/json (format: flat)":
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                    description: Status string
+                    example: OK
+                  result:
+                    type: object
+                    properties:
+                      addresses:
+                        $ref: '#/components/schemas/Addresses'
+        '400':
+          description: |
+            Bad Request
+            
+            Parameter missing or malformed
+        '401':
+          description: Unauthorized
   /addressdb/findAddress:
     get:
       tags:
@@ -24,7 +97,7 @@ paths:
       operationId: findAddresses
       parameters:
         - name: format
-          description: "Ausgabeformat: `flat` (Ein Array-Element pro Wohneinheit mit Gebäudedaten; **default**) oder `tree` (Ein Array-Element pro Gebäude mit Wohneinheiten-Array; **empfohlen**)"
+          description: "Ausgabeformat: `flat` (Ein Array-Element pro Wohneinheit mit Gebäudedaten; **default**) oder `tree` (Ein Array-Element pro Gebäude mit Wohneinheiten-Array)"
           in: query
           schema:
             type: string
@@ -67,6 +140,12 @@ paths:
             | provision    | Vorsorgeanschluss |
             | order        | Vollanschluss |
             | reorder      | Nachbestellung (nach Bauabschluss) |
+            
+            Ein leeres Array bedeutet, dass derzeit kein Ausbau stattfindet/geplant ist.
+            
+            ---
+            
+            Ist bekannt, dass die Adresse zukünftig ausgebaut wird, steht im Feld `rollout_year` das geplante Ausbaujahr. `rollout_info` kann weitere informationen beinhalten.
           content:
             "application/json (format: tree)":
               schema: