From: Miod Vallat <miod.vallat@powerdns.com>
Date: Fri, 11 Jul 2025 09:56:28 +0000 (+0200)
Subject: Sort metadata variables. Mention SOA-EDIT is readonly in the API.
X-Git-Tag: rec-5.4.0-alpha0~39^2~2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a0a2c4d875dc12f3e5602a0c3aff6e814821f07a;p=thirdparty%2Fpdns.git

Sort metadata variables. Mention SOA-EDIT is readonly in the API.

Signed-off-by: Miod Vallat <miod.vallat@powerdns.com>
---

diff --git a/docs/domainmetadata.rst b/docs/domainmetadata.rst
index 15738ea6df..4f895e18f3 100644
--- a/docs/domainmetadata.rst
+++ b/docs/domainmetadata.rst
@@ -25,6 +25,7 @@ The following options can only be read (not written to) via the HTTP API metadat
 * NSEC3NARROW
 * NSEC3PARAM
 * PRESIGNED
+* SOA-EDIT
 * TSIG-ALLOW-AXFR
 
 The option SOA-EDIT-API cannot be written or read via the HTTP API metadata endpoint.
@@ -59,27 +60,7 @@ records, add ``allow-axfr-ips=`` to ``pdns.conf``.
 
 .. _metadata-api-rectify:
 
-API-RECTIFY
------------
-.. versionadded:: 4.1.0
-
-This metadata item controls whether or not a zone is fully rectified on changes
-to the contents of a zone made through the :doc:`API <http-api/index>`.
-
-When the ``API-RECTIFY`` value is "1", the zone will be rectified on changes.
-Any other value means that it will not be rectified. If this is not set
-at all, rectifying of the zone depends on the config variable
-:ref:`setting-default-api-rectify`.
-
-.. _metadata-axfr-source:
-
-AXFR-SOURCE
------------
-
-The IP address to use as a source address for sending AXFR and IXFR
-requests.
-
-ALLOW-DNSUPDATE-FROM, TSIG-ALLOW-DNSUPDATE, FORWARD-DNSUPDATE, SOA-EDIT-DNSUPDATE, NOTIFY-DNSUPDATE
+ALLOW-DNSUPDATE-FROM, FORWARD-DNSUPDATE, NOTIFY-DNSUPDATE, SOA-EDIT-DNSUPDATE, TSIG-ALLOW-DNSUPDATE
 ---------------------------------------------------------------------------------------------------
 
 See the documentation on :ref:`Dynamic DNS update <dnsupdate-metadata>`.
@@ -99,11 +80,37 @@ number. e.g.:
     pdnsutil set-meta powerdns.org ALLOW-AXFR-FROM 2001:db8:53::1
 
 
+API-RECTIFY
+-----------
+.. versionadded:: 4.1.0
+
+This metadata item controls whether or not a zone is fully rectified on changes
+to the contents of a zone made through the :doc:`API <http-api/index>`.
+
+When the ``API-RECTIFY`` value is "1", the zone will be rectified on changes.
+Any other value means that it will not be rectified. If this is not set
+at all, rectifying of the zone depends on the config variable
+:ref:`setting-default-api-rectify`.
+
+.. _metadata-axfr-source:
+
 AXFR-MASTER-TSIG
 ----------------
 
 Use this named TSIG key to retrieve this zone from its primary, see :ref:`tsig-provision-signed-notify-axfr`.
 
+AXFR-SOURCE
+-----------
+
+The IP address to use as a source address for sending AXFR and IXFR
+requests.
+
+GSS-ACCEPTOR-PRINCIPAL
+----------------------
+
+Use this principal for accepting GSS context.
+(See :ref:`tsig-gss-tsig`).
+
 GSS-ALLOW-AXFR-PRINCIPAL
 ------------------------
 .. versionchanged:: 4.3.1
@@ -118,12 +125,6 @@ Allow this GSS principal to perform AXFR retrieval. Most commonly it is
 ``host/something@REALM``, ``DNS/something@REALM`` or ``user@REALM``.
 (See :ref:`tsig-gss-tsig`).
 
-GSS-ACCEPTOR-PRINCIPAL
-----------------------
-
-Use this principal for accepting GSS context.
-(See :ref:`tsig-gss-tsig`).
-
 IXFR
 ----