Github user neykov commented on a diff in the pull request:
https://github.com/apache/brooklyn-docs/pull/148#discussion_r100338415
--- Diff: guide/yaml/yaml-reference.md ---
@@ -213,6 +213,9 @@ concise DSL defined here:
`$brooklyn:root()`.
* `$brooklyn:formatString("pattern e.g. %s %s", "field 1", "field 2")`
returns a future which creates the formatted string
with the given parameters, where parameters may be strings *or* other
tasks such as `attributeWhenReady`
+* `$brooklyn:urlEncode("val")` returns a future which creates a string
with the characters escaped
+ so it is a valid part of a URL. The parameter can be a string *or*
another task. For example,
+ `$brooklyn:urlEncode($brooklyn:config(\"mykey\"))`
--- End diff --
Let me repeat my concerns about this functionality here - see
https://github.com/apache/brooklyn-server/pull/551#issuecomment-278158142.
At the very least can you document that this is meant only for query
parameters. While not perfect it can do the job until improved. The various
parts of the URL have different rules for escaping so this won't work
universally.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
