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 7009c4e403b216e5db2657828cde6073b5982b64..eefcaa447b1edf868eb9963694f40125b4791004 100644 (file)
--- 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