updates doc on action parameter variable mustache escaping #88521
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pmuellr
added
Feature:Alerting
v8.0.0
release_note:skip
|
Pinging @elastic/kibana-alerting-services (Team:Alerting Services) |
gmmorris
approved these changes
Jan 19, 2021
|
|
||
| - for the <<email-action-type, Email>> connector, the `message` action configuration property escapes any characters that would be interpreted as Markdown | ||
| - for the <<slack-action-type, Slack>> connector, the `message` action configuration property escapes any characters that would be interpreted as Slack markdown | ||
| - for the <<webhook-action-type, Webhook>> connector, the `body` action configuration property escapes any characters that are invalid in JSON string values |
There was a problem hiding this comment.
I'm not sure I'd understand what action configuration property means if I came in without knowledge of the framework internals.
Perhaps we should just call it the message field? Or something like that, as it's a form field which the user inputs at creation, right?
There was a problem hiding this comment.
heh, ya, I was working from the docs, where action "params" wasn't referred to as params, but a property, and so the resulting word salad was a bit unwieldy. Will wordsmith that one a bit more, see if I can find other references to a param like that somewhere ...
There was a problem hiding this comment.
Poking around the docs, action params seem to be referred to as "Action configuration" in the docs, and such references refer to the enclosed "properties":
So, unless we want to use some brand new terminology, I think "action configuration property" is probably the right choice. cc: @gchaps ?
There was a problem hiding this comment.
++ to "action configuration property"
|
@elasticmachine merge upstream |
gchaps
reviewed
Jan 20, 2021
|
|
||
| [role="screenshot"] | ||
| image::images/alert-flyout-action-variables.png[Passing alert values to an action] | ||
|
|
||
| There are some cases where the variable values will be "escaped", when used in a context where escaping is needed: |
There was a problem hiding this comment.
Suggested change
| There are some cases where the variable values will be "escaped", when used in a context where escaping is needed: | |
| Some cases exist where the variable values will be "escaped", when used in a context where escaping is needed: |
|
|
||
| [role="screenshot"] | ||
| image::images/alert-flyout-action-variables.png[Passing alert values to an action] | ||
|
|
||
| There are some cases where the variable values will be "escaped", when used in a context where escaping is needed: | ||
|
|
||
| - for the <<email-action-type, Email>> connector, the `message` action configuration property escapes any characters that would be interpreted as Markdown |
There was a problem hiding this comment.
Suggested change
| - for the <<email-action-type, Email>> connector, the `message` action configuration property escapes any characters that would be interpreted as Markdown | |
| - For the <<email-action-type, Email>> connector, the `message` action configuration property escapes any characters that would be interpreted as Markdown. |
| There are some cases where the variable values will be "escaped", when used in a context where escaping is needed: | ||
|
|
||
| - for the <<email-action-type, Email>> connector, the `message` action configuration property escapes any characters that would be interpreted as Markdown | ||
| - for the <<slack-action-type, Slack>> connector, the `message` action configuration property escapes any characters that would be interpreted as Slack markdown |
There was a problem hiding this comment.
Suggested change
| - for the <<slack-action-type, Slack>> connector, the `message` action configuration property escapes any characters that would be interpreted as Slack markdown | |
| - For the <<slack-action-type, Slack>> connector, the `message` action configuration property escapes any characters that would be interpreted as Slack Markdown. |
|
|
||
| - for the <<email-action-type, Email>> connector, the `message` action configuration property escapes any characters that would be interpreted as Markdown | ||
| - for the <<slack-action-type, Slack>> connector, the `message` action configuration property escapes any characters that would be interpreted as Slack markdown | ||
| - for the <<webhook-action-type, Webhook>> connector, the `body` action configuration property escapes any characters that are invalid in JSON string values |
There was a problem hiding this comment.
Suggested change
| - for the <<webhook-action-type, Webhook>> connector, the `body` action configuration property escapes any characters that are invalid in JSON string values | |
| - For the <<webhook-action-type, Webhook>> connector, the `body` action configuration property escapes any characters that are invalid in JSON string values. |
|
|
||
| - for the <<email-action-type, Email>> connector, the `message` action configuration property escapes any characters that would be interpreted as Markdown | ||
| - for the <<slack-action-type, Slack>> connector, the `message` action configuration property escapes any characters that would be interpreted as Slack markdown | ||
| - for the <<webhook-action-type, Webhook>> connector, the `body` action configuration property escapes any characters that are invalid in JSON string values |
There was a problem hiding this comment.
++ to "action configuration property"
pmuellr
added a commit
to pmuellr/kibana
that referenced
this pull request
Jan 21, 2021
…8521) Provides more detail on mustache variable escaping within action parameter templates.
pmuellr
added a commit
to pmuellr/kibana
that referenced
this pull request
Jan 21, 2021
…8521) Provides more detail on mustache variable escaping within action parameter templates.
pmuellr
added a commit
that referenced
this pull request
Jan 21, 2021
pmuellr
added a commit
that referenced
this pull request
Jan 21, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
resolves #87933
Summary
Updates the docs discussing action parameter templating with mustache, and the escaping of values during the rendering of the templates. The text being replaced mentioned HTML escaping, but as of PR #83919, we no longer ever do HTML escaping, but do some action type-specific escaping for some action parameters, described in this PR.
Checklist
Delete any items that are not applicable to this PR.