]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
docs: zone: `modified_at` is a separate property when updating RRSets 15836/head
authorUwe Kleine-König <uwe@kleine-koenig.org>
Mon, 14 Jul 2025 12:40:19 +0000 (14:40 +0200)
committerUwe Kleine-König <uwe@kleine-koenig.org>
Mon, 14 Jul 2025 12:41:33 +0000 (14:41 +0200)
`modified_at` is a stand alone property, so it warrants its own item in
the RRSet object properties.

docs/common/api/zone.rst

index c4b1fb7b27d336136d162deb1d18bdd363a14e74..7fcb8a7ebb3b5e81a587a46ea870fdb730938ed1 100644 (file)
@@ -10,7 +10,8 @@ RRSet
   :property integer ttl: DNS TTL of the records, in seconds. MUST NOT be included when ``changetype`` is set to "DELETE".
   :property string changetype: MUST be added when updating the RRSet. Must be ``REPLACE`` or ``DELETE``. With ``DELETE``, all existing RRs matching ``name`` and ``type`` will be deleted,  including all comments. With ``REPLACE``: when ``records`` is present, all existing RRs matching ``name`` and ``type`` will be deleted, and then new records given in ``records`` will be created. If no records are left, any existing comments will be deleted as well. When ``comments`` is present, all existing comments for the RRs matching ``name`` and ``type`` will be deleted, and then new comments given in ``comments`` will be created.
   :property [RREntry] records: All records in this RRSet. When updating records, this is the list of new records (replacing the old ones). Must be empty when ``changetype`` is set to ``DELETE``. An empty list results in deletion of all records (and comments).
-  :property [Comment] comments: List of :json:object:`Comment`. 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.
+  :property [Comment] comments: List of :json:object:`Comment`. Must be empty when ``changetype`` is set to ``DELETE``. An empty list results in deletion of all comments.
+  :property integer modified_at: optional timestamp, defaults to the current server time.
 
 RREntry
 -------