Skip to content

Commit

Permalink
Improve API docs a bit
Browse files Browse the repository at this point in the history
Based on feedback from issue PowerDNS#2064; no idea so far how to better
describe how comments work.
  • Loading branch information
zeha committed Jan 25, 2015
1 parent cc59bce commit 9bbdbea
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/markdown/httpapi/api_spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 9bbdbea

Please sign in to comment.