From 6c1c5a8d0657e85903ca565af1c65e4f8dc86461 Mon Sep 17 00:00:00 2001 From: Frank Schubert Date: Mon, 19 Dec 2022 14:54:48 +0100 Subject: [PATCH] Added swagger docs for /addressdb/getClusters --- public/docs/preorder-api.yaml | 42 +++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/public/docs/preorder-api.yaml b/public/docs/preorder-api.yaml index 9391a72c8..8efb00224 100644 --- a/public/docs/preorder-api.yaml +++ b/public/docs/preorder-api.yaml @@ -15,6 +15,48 @@ tags: - name: preorder description: Informationen zum Netzgebiet und Speichern von Vorbestellungen paths: + /addressdb/getClusters: + get: + tags: + - addressdb + summary: Gibt alle Cluster aus + description: Retourniert Liste aller Cluster mit ID und Name + operationId: getClusters + responses: + '200': + description: Successful operation + content: + "application/json": + schema: + type: object + properties: + status: + type: string + description: Status string + example: OK + result: + type: object + properties: + clusters: + type: array + items: + type: object + properties: + id: + type: string + description: ID des Clusters + example: "JP-TYO-01-4" + name: + type: string + description: Name des Clusters + example: "Tokyo - Akihabara Süd" + '400': + description: | + Bad Request + + Parameter missing or malformed + '401': + description: Unauthorized /addressdb/searchAddress: get: tags: