Browse Source

feat(api): deprecate unnecessary fields in Domain.keys

Peter Thomassen 3 years ago
parent
commit
a9f410d671
2 changed files with 6 additions and 6 deletions
  1. 2 2
      api/desecapi/pdns.py
  2. 4 4
      docs/dns/domains.rst

+ 2 - 2
api/desecapi/pdns.py

@@ -98,8 +98,8 @@ def get_keys(domain):
     field_map = {
         'dnskey': 'dnskey',
         'cds': 'ds',
-        'flags': 'flags',
-        'keytype': 'keytype',
+        'flags': 'flags',  # deprecated
+        'keytype': 'keytype',  # deprecated
     }
     return [{v: key[k] for k, v in field_map.items()}
              for key in r.json()

+ 4 - 4
docs/dns/domains.rst

@@ -27,8 +27,8 @@ A JSON object representing a domain has the following structure::
                     "6006 13 2 f34b75...",
                     "6006 13 4 2fdcf8..."
                 ],
-                "flags": 257,
-                "keytype": "csk"
+                "flags": 257,  # deprecated
+                "keytype": "csk"  # deprecated
             },
             ...
         ],
@@ -50,8 +50,8 @@ Field details:
     :Access mode: read-only
 
     Array with DNSSEC key information.  Each entry contains ``DNSKEY`` and
-    ``DS`` record contents (the latter being computed from the former), plus
-    some more technical information.  For delegation of DNSSEC-secured domains,
+    ``DS`` record contents (the latter being computed from the former).
+    For delegation of DNSSEC-secured domains,
     the parent domain needs to publish these ``DS`` records.  (This usually
     involves telling your registrar/registry about those records, and they
     will publish them for you.)