From: Kevin P. Fleming Date: Mon, 30 Nov 2020 11:40:27 +0000 (-0500) Subject: Clarify description of putZone API operation. X-Git-Tag: rec-4.5.0-alpha1~64^2 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F9788%2Fhead;p=thirdparty%2Fpdns.git Clarify description of putZone API operation. Rather than listing *some* of the ignored fields, and thus needing to keep that list up to date as fields are added to the zone structure, instead list the fields that putZone actually uses to modify the zone. --- diff --git a/docs/http-api/swagger/authoritative-api-swagger.yaml b/docs/http-api/swagger/authoritative-api-swagger.yaml index 7009c4e403..eefcaa447b 100644 --- a/docs/http-api/swagger/authoritative-api-swagger.yaml +++ b/docs/http-api/swagger/authoritative-api-swagger.yaml @@ -211,8 +211,8 @@ paths: description: 'Returns 204 No Content on success.' put: - summary: Modifies basic zone data (metadata). - description: 'Allowed fields in client body: all except id, url and name. Returns 204 No Content on success.' + summary: Modifies basic zone data. + description: 'The only fields in the zone structure which can be modified are: kind, masters, account, soa_edit, soa_edit_api, api_rectify, dnssec, and nsec3param. All other fields are ignored.' operationId: putZone tags: - zones