diff --git a/public/docs/preorder-api.yaml b/public/docs/preorder-api.yaml index 69faca6ba..e38d1ba9c 100644 --- a/public/docs/preorder-api.yaml +++ b/public/docs/preorder-api.yaml @@ -584,6 +584,47 @@ paths: oneOf: - $ref: "#/components/schemas/timestampString" - $ref: "#/components/schemas/timestampInt" + responses: + '200': + description: | + Successful operation + + Mögliche Werte für Rückgabewert `status`: + + | code | text | description | + |------|------|-------------| + | 10 | new | Neu | + | 110 | Underground construction planning | Tiefbau in Planung | + | 120 | Underground construction planning finished | Tiefbau Planung abgeschlossen | + | 130 | Underground construction work assigned | Bauauftrag zugeteilt | + | 140 | Conduit at property border | Rohr an Grundstücksgrenze | + | 200 | Conduit in building | Rohr im Gebäude | + | 210 | Fiber planning | Leitungsplan in Arbeit | + | 220 | Fiber planning finished | Leitungsplan abgeschlossen | + | 230 | Fiber installation work assigned | Bauauftrag zugeteilt | + | 235 | Fiber on property line | Faser an Grundstücksgrenze | + | 240 | Fiber in building | Faser im Gebäude | + | 245 | OTO intalled | Anschlussbox installiert | + | 250 | ONT ready | ONT vorbereitet | + | 260 | ONT picked up or shipped | ONT abgeholt oder versandt | + | 300 | ONT installed | ONT in Betrieb | + | 500 | Finished | Fertiggestellt | + | 899 | Cancelled | Storniert/Gekündigt | + content: + application/json: + schema: + type: object + properties: + status: + type: string + description: Status string + example: OK + result: + type: array + items: + $ref: '#/components/schemas/preorderStatusDetail' + '401': + description: Unauthorized /preorder/{code}: get: tags: