reminder to describe subdomain keys with dots

[pdns-pipe-nmc.git] / SPEC.md

diff --git a/SPEC.md b/SPEC.md
index 5c659b75853cbed01c1c5f7611b8e1152c165383..1c1292ce803bf65d6558f3bd641045cdbd72768c 100644 (file)
--- a/SPEC.md
+++ b/SPEC.md
@@ -17,8 +17,9 @@ This specification is implemented by the `pdns-pipe-nmc` program.
 
 ### `DomObj` Object
 
 
 ### `DomObj` Object
 

-`DomObj` either a `String` containing a dotted quad (see Note below),
-or a JSON `Map`, with the following attributes, all optional:
+`DomObj` is a data structure that is associated with an FQDN. It is
+either a `String` containing a dotted quad (see Note below), or a
+JSON `Map`, with the following attributes, all optional:

 
 | Key         | Type                                  | Comment                                    |
 |-------------|---------------------------------------|--------------------------------------------|
 
 | Key         | Type                                  | Comment                                    |
 |-------------|---------------------------------------|--------------------------------------------|


@@ -188,7 +189,7 @@ Does not translate into any DNS RR. Contains Tor hidden service address.
 
 #### i2p attribute
 
 
 #### i2p attribute
 

-Does not translate into any DNS RR. Contains an object with three
+Does not translate into any DNS RR. It is a JSON Map with three

 optional String attributes: `"destination"`, `"name"` and `"b32"`.
 
 ```
 optional String attributes: `"destination"`, `"name"` and `"b32"`.
 
 ```


@@ -306,6 +307,9 @@ the current domain object.
 
 #### map attribute
 
 
 #### map attribute
 

+FIXME - explain handling of the keys with dots.
+Also, add checks to the code to disallow empty elements.
+

 JSON Map object containing subdomain names as its keys and domain
 objects as values. Element of the map with empty key "" has special
 meaning: the value of this map element is merged into the current
 JSON Map object containing subdomain names as its keys and domain
 objects as values. Element of the map with empty key "" has special
 meaning: the value of this map element is merged into the current