Skip to content
This repository was archived by the owner on Jan 19, 2018. It is now read-only.

Commit 6771283

Browse files
committed
I changes the params object so that we can close #35
1 parent a0133dd commit 6771283

3 files changed

Lines changed: 16 additions & 6 deletions

File tree

spec/0.0.2/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,26 +174,29 @@ source: uri://registry.devops.example.com
174174

175175
#### <a name="paramsObject"></a>Parameters Object
176176

177-
A set of Parameters the containerapp requires, has set some defaults for or needs user input.
177+
A list of Parameters the containerapp requires, has set some defaults for or needs user input.
178178

179179
##### Fields
180180

181181
Field Name | Type | Description
182182
---|:---:|---
183+
<a name="parametersName"></a>name| `string` | **Required.** The name of the parameter.
183184
<a name="parametersDescription"></a>description | `string` | **Required.** A human readable description of the parameter.
184185
<a name="parametersConstraints"></a>constraints | [ConstraintObject](#constraintObject) | **Optional** An optional definition of constraints to the parameter.
185186
<a name="parametersDefault"></a>default | `string` | **Optional** An optional default value for the parameter.
186187

187188
##### Parameters Object Example:
188189

189190
```yaml
191+
name: password
190192
description: mongoDB Admin password
191193
constraints:
192194
- allowed_pattern: "[A-Z0-9]+"
193195
description: Must consist of characters and numbers only.
194196
```
195197
```js
196198
{
199+
"name": "password",
197200
"description": "mongoDB Admin password",
198201
"constraints": [
199202
{

spec/0.0.2/examples/template/Nulecule

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,11 @@ graph:
2626
- provider1
2727
name: mycode
2828
params:
29-
password:
29+
-
30+
name: password
3031
description: passphrase
31-
username:
32+
-
33+
name: username
3234
constraints:
3335
-
3436
allowed_pattern: "[A-Z0-9]+"

spec/0.0.2/param.json

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,13 @@
44
"title": "Parameter",
55
"description": "Name of the parameter as used in artifacts",
66
"type": "object",
7-
"required": [ "description" ],
8-
"properties": {
7+
"required": [ "name", "description" ],
8+
"properties": [{
9+
"name": {
10+
"description": "",
11+
"type": "string",
12+
"default": "null",
13+
},
914
"description": {
1015
"description": "A human readable description of the parameter.",
1116
"type": "string",
@@ -19,5 +24,5 @@
1924
"type": "string",
2025
"default": "null"
2126
}
22-
}
27+
}]
2328
}

0 commit comments

Comments
 (0)