From 76e96a862ee5d5ddbc8b598fe04ca528a01a8029 Mon Sep 17 00:00:00 2001 From: Pieter Lexis Date: Wed, 15 Aug 2018 09:56:22 +0200 Subject: [PATCH] Write swagger documentation for #6668 --- docs/http-api/swagger/authoritative-api-swagger.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/http-api/swagger/authoritative-api-swagger.yaml b/docs/http-api/swagger/authoritative-api-swagger.yaml index 8c91d30ef..1088a6a17 100644 --- a/docs/http-api/swagger/authoritative-api-swagger.yaml +++ b/docs/http-api/swagger/authoritative-api-swagger.yaml @@ -70,6 +70,14 @@ paths: required: true description: The id of the server to retrieve type: string + - name: zone + in: query + required: false + type: string + description: | + When set to the name of a zone, only this zone is returned. + If no zone with that name exists, the response is an empty array. + This can e.g. be used to check if a zone exists in the database without having to guess/encode the zone's id or to check if a zone exists. responses: '200': description: An array of Zones -- 2.40.0