I changes the params object so that we can close #35

projectatomic · May 7, 2015 · 6771283 · 6771283
1 parent a0133dd
commit 6771283
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 6 deletions.
diff --git a/spec/0.0.2/README.md b/spec/0.0.2/README.md
@@ -174,26 +174,29 @@ source: uri://registry.devops.example.com
 
 #### <a name="paramsObject"></a>Parameters Object
 
-A set of Parameters the containerapp requires, has set some defaults for or needs user input.
+A list of Parameters the containerapp requires, has set some defaults for or needs user input.
 
 ##### Fields
 
 Field Name | Type | Description
 ---|:---:|---
+<a name="parametersName"></a>name| `string` | **Required.** The name of the parameter.
 <a name="parametersDescription"></a>description | `string` | **Required.** A human readable description of the parameter.
 <a name="parametersConstraints"></a>constraints | [ConstraintObject](#constraintObject) | **Optional** An optional definition of constraints to the parameter.
 <a name="parametersDefault"></a>default | `string` | **Optional** An optional default value for the parameter.
 
 ##### Parameters Object Example:
 
 ```yaml
+name: password
 description: mongoDB Admin password
 constraints: 
   - allowed_pattern: "[A-Z0-9]+"
     description: Must consist of characters and numbers only.
 ```
 ```js
 {
+  "name": "password",
   "description": "mongoDB Admin password",
   "constraints": [
     {

diff --git a/spec/0.0.2/examples/template/Nulecule b/spec/0.0.2/examples/template/Nulecule
@@ -26,9 +26,11 @@ graph:
             - provider1
     name: mycode
     params: 
-      password: 
+      -
+        name: password
         description: passphrase
-      username: 
+      -
+        name: username
         constraints: 
           - 
             allowed_pattern: "[A-Z0-9]+"

diff --git a/spec/0.0.2/param.json b/spec/0.0.2/param.json
@@ -4,8 +4,13 @@
     "title": "Parameter",
     "description": "Name of the parameter as used in artifacts",
     "type": "object",
-    "required": [ "description" ],
-    "properties": {
+    "required": [ "name", "description" ],
+    "properties": [{
+        "name": {
+            "description": "",
+            "type": "string",
+            "default": "null",
+        },
         "description": {
             "description": "A human readable description of the parameter.",
             "type": "string",
@@ -19,5 +24,5 @@
             "type": "string",
             "default": "null"
         }
-    }
+    }]
 }