From: Peter Thomassen <4242683+peterthomassen@users.noreply.github.com>
Date: Tue, 28 Jan 2020 08:48:50 +0000 (+0100)
Subject: docs: clarify Zone object description, closes #8748
X-Git-Tag: auth-4.3.0-beta1~8^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F8750%2Fhead;p=thirdparty%2Fpdns.git

docs: clarify Zone object description, closes #8748

Point out that the `rrsets` is only included at the zone detail endpoint
---

diff --git a/docs/http-api/swagger/authoritative-api-swagger.yaml b/docs/http-api/swagger/authoritative-api-swagger.yaml
index 86bc3921be..27c40047d7 100644
--- a/docs/http-api/swagger/authoritative-api-swagger.yaml
+++ b/docs/http-api/swagger/authoritative-api-swagger.yaml
@@ -918,7 +918,7 @@ definitions:
         type: array
         items:
           $ref: '#/definitions/RRSet'
-        description: 'RRSets in this zone'
+        description: 'RRSets in this zone (for zones/{zone_id} endpoint only; omitted during GET on the .../zones list endpoint)'
       serial:
         type: integer
         description: 'The SOA serial number'