updated api doc

This commit is contained in:
Frank Schubert
2022-10-13 17:13:41 +02:00
parent 944784dc5c
commit fed31288d5

View File

@@ -55,6 +55,7 @@ paths:
| interest | Interessensbekundung |
| provision | Vorsorgeanschluss |
| order | Vollanschluss |
| reorder | Nachbestellung (nach Bauabschluss) |
content:
application/json:
schema:
@@ -226,6 +227,7 @@ paths:
| interest | Interessensbekundung|
| provision | Vorsorgeanschluss|
| order | Vollanschluss|
| reorder | Nachbestellung (nach Bauabschluss) |
---
@@ -381,9 +383,21 @@ components:
type: string
description: Tür
example: 1337
gps_lat:
typee: float
description: Breitengrad der GPS-Koordinate (Dezimal)
example: 48.517560
gps_long:
typee: float
description: Längengrad der GPS-Koordinate (Dezimal)
example: 13.950665
rollout_year:
type: integer
description: Jahr des geplanten Ausbaus
example: 2024
preorderTypes:
type: array
example: ["interest", "provision", "order"]
example: ["interest", "provision", "order", "reorder"]
description: |
Erlaubte Vorbestelltypen:
@@ -392,6 +406,7 @@ components:
| interest | Interessensbekundung |
| provision | Vorsorgeanschluss |
| order | Vollanschluss |
| reorder | Nachbestellung (nach Bauabschluss) |
items:
type: string
required:
@@ -483,6 +498,7 @@ components:
| interest | Interessensbekundung|
| provision | Vorsorgeanschluss|
| order | Vollanschluss|
| reorder | Nachbestellung (nach Bauabschluss) |
acceptMarketing:
type: boolean
description: Zustimmung Datenspeicherung/-weitergabe
@@ -497,6 +513,7 @@ components:
description: Informationen zu Rücktrittsrecht akzeptiert
address:
type: object
description: Anschlussadresse
properties:
street:
type: string
@@ -541,7 +558,11 @@ components:
example: im Carport
customer:
type: object
description: Vertragsinhaber
properties:
type:
enum: ["owner","tenant"]
description: Ist `customer` Besitzer oder Bewohner
company:
type: string
description: Firmenname Kunde