]> granicus.if.org Git - pdns/commitdiff
Improve API docs a bit
authorChristian Hofstaedtler <christian@hofstaedtler.name>
Sun, 25 Jan 2015 18:27:39 +0000 (19:27 +0100)
committerChristian Hofstaedtler <christian@hofstaedtler.name>
Sun, 25 Jan 2015 18:27:39 +0000 (19:27 +0100)
Based on feedback from issue #2064; no idea so far how to better
describe how comments work.

docs/markdown/httpapi/api_spec.md

index c8f928bb23970a350b1b183686e360eb14bddd6c..442abb27892629d0f4d647315ffee9f389bc33f1 100644 (file)
@@ -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