You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@brooklyn.apache.org by sv...@apache.org on 2016/09/30 14:58:49 UTC
[1/2] brooklyn-docs git commit: Add documentation about pinned field
for Brooklyn parameters
Repository: brooklyn-docs
Updated Branches:
refs/heads/master 7e13af295 -> 152b418ce
Add documentation about pinned field for Brooklyn parameters
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/a12ebc83
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/a12ebc83
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/a12ebc83
Branch: refs/heads/master
Commit: a12ebc83c58493004b0dc4a206eed43c44bcb778
Parents: cf63c03
Author: Thomas Bouron <th...@cloudsoftcorp.com>
Authored: Tue Sep 27 12:19:16 2016 +0100
Committer: Thomas Bouron <th...@cloudsoftcorp.com>
Committed: Fri Sep 30 15:50:41 2016 +0100
----------------------------------------------------------------------
guide/yaml/yaml-reference.md | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/brooklyn-docs/blob/a12ebc83/guide/yaml/yaml-reference.md
----------------------------------------------------------------------
diff --git a/guide/yaml/yaml-reference.md b/guide/yaml/yaml-reference.md
index bcdf121..6895318 100644
--- a/guide/yaml/yaml-reference.md
+++ b/guide/yaml/yaml-reference.md
@@ -72,6 +72,7 @@ the entity being defined, with these being the most common:
obvious coercion is supported so
`timestamp` accepts most common ISO date formats, `duration` accepts `5m`, and port accepts `8080+`
* `default`: a default value; this will be coerced to the declared `type`
+ * `pinned`: mark the parameter as pinned (always displayed) for the UI. The default is `true`
* `constraints`: a list of constraints the parameter should meet;
currently `required` is supported, with the default being not required
@@ -81,16 +82,18 @@ the entity being defined, with these being the most common:
~~~ yaml
brooklyn.parameters:
-# user.age parameter is required, and fully specified
+# user.age parameter is required, pinned and fully specified
- name: user.age
type: integer
label: Age
description: the age of the user
+ pinned: true
constraints:
- required
-# user.name is optional, and has a default
+# user.name is optional, is not pinned and has a default
- name: user.name
default: You
+ pinned: false
# shorthand notation: displayName will be an optional config of type string with no default
- displayName
~~~
[2/2] brooklyn-docs git commit: Closes #112
Posted by sv...@apache.org.
Closes #112
Add documentation about pinned field for Brooklyn parameters
This depends on https://github.com/apache/brooklyn-server/pull/358
Project: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/commit/152b418c
Tree: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/tree/152b418c
Diff: http://git-wip-us.apache.org/repos/asf/brooklyn-docs/diff/152b418c
Branch: refs/heads/master
Commit: 152b418cee2a8ab2532eb30a9c93e242c1f5618c
Parents: 7e13af2 a12ebc8
Author: Svetoslav Neykov <sv...@cloudsoftcorp.com>
Authored: Fri Sep 30 17:58:38 2016 +0300
Committer: Svetoslav Neykov <sv...@cloudsoftcorp.com>
Committed: Fri Sep 30 17:58:38 2016 +0300
----------------------------------------------------------------------
guide/yaml/yaml-reference.md | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
----------------------------------------------------------------------