]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
Write swagger documentation for #6668 6668/head
authorPieter Lexis <pieter.lexis@powerdns.com>
Wed, 15 Aug 2018 07:56:22 +0000 (09:56 +0200)
committerChris Hofstaedtler <chris.hofstaedtler@deduktiva.com>
Wed, 15 Aug 2018 09:04:37 +0000 (11:04 +0200)
docs/http-api/swagger/authoritative-api-swagger.yaml

index 8c91d30ef23d53edef51cfe9811a97b493f9c5ff..1088a6a1791e7833c18cfb662c76fea1b389251c 100644 (file)
@@ -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