From 9bbdbea158c49658be50afb8e0a750383361efc9 Mon Sep 17 00:00:00 2001 From: Christian Hofstaedtler Date: Sun, 25 Jan 2015 19:27:39 +0100 Subject: [PATCH] Improve API docs a bit Based on feedback from issue #2064; no idea so far how to better describe how comments work. --- docs/markdown/httpapi/api_spec.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/markdown/httpapi/api_spec.md b/docs/markdown/httpapi/api_spec.md index c8f928bb2..442abb278 100644 --- a/docs/markdown/httpapi/api_spec.md +++ b/docs/markdown/httpapi/api_spec.md @@ -356,12 +356,14 @@ zone_collection Turning on DNSSEC with custom keys: just create the zone with `dnssec` set to `false`, and add keys using the cryptokeys REST interface. Have -at least one of them `active` set to `true`. +at least one of them `active` set to `true`. **TODO**: not yet +implemented. Changes made through the Zones API will always yield valid zone data, -and the zone will be properly "rectified". If changes are made through -other means (e.g. direct database access), this is not guranteed to be -true and clients SHOULD trigger rectify. +and the zone will be properly "rectified" (**TODO**: not yet +implemented). If changes are made through other means (e.g. direct +database access), this is not guranteed to be true and clients SHOULD +trigger rectify. Backends might implement additional features (by coincidence or not). These things are not supported through the API. @@ -470,6 +472,7 @@ Having `type` inside an RR differ from `type` at the top level is an error. List of new comments (replacing the old ones). Must be empty when `changetype` is set to `DELETE`. An empty list results in deletion of all comments. `modified_at` is optional and defaults to the current server time. + `account` is a field with user-defined meaning. #### PUT -- 2.40.0