Add XPathing to spec

projectatomic · Dec 17, 2015 · f324e8e · f324e8e
1 parent f88dd67
commit f324e8e
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 2 deletions.
diff --git a/spec/README.md b/spec/README.md
@@ -218,6 +218,42 @@ constraints:
 ```
 
 
+##### JSON Pointers 
+JSON Pointers (otherwise known as XPathing) are supported by the Nulecule specification by implementing [RFC 6902](https://tools.ietf.org/html/rfc6902).
+A value can be provided by using the pointer reference within the JSON/Yaml format.
+
+ex.
+```yaml
+description: mongoDB Admin password
+hidden: true
+constraints:
+  - allowed_pattern: "[A-Z0-9]+"
+    description: Must consist of characters and numbers only.
+    default: 0
+    param:
+      - /spec/containers/0/param
+```
+```json
+{
+  "name": "password",
+  "description": "mongoDB Admin password",
+  "hidden": true,
+  "constraints": [
+    {
+      "allowed_pattern": "[A-Z0-9]+",
+      "description": "Must consist of characters and numbers only.",
+      "default": 0,
+      "param": {
+          "description": "An array of XPath strings per RFC 6902.",
+          "type": "array",
+          "default": null
+      }
+    }
+  ]
+}
+```
+
+
 ##### Parameters Object Example:
 
 ```yaml

diff --git a/spec/param.json b/spec/param.json
@@ -30,8 +30,8 @@
             "default": false
         },
         "param": [
-          '/spec/containers/0/param',
-          '/spec/containers/1/param'
+          "/spec/containers/0/param",
+          "/spec/containers/1/param"
         ]
     }
 }