Added swagger docs for /addressdb/getClusters

This commit is contained in:
Frank Schubert
2022-12-19 14:54:48 +01:00
parent 41ad786a68
commit 6c1c5a8d06

View File

@@ -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: