update docs

elastic · May 7, 2020 · 7134f4f · 7134f4f
1 parent f7a4801
commit 7134f4f
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 48 deletions.
diff --git a/docs/user/alerting/action-types/email.asciidoc b/docs/user/alerting/action-types/email.asciidoc
@@ -24,17 +24,17 @@ Password::  password for 'login' type authentication.
 
 [source,text]
 --
- id: 'my-email'
- name: preconfigured-email-action-type
- actionTypeId: .email
- config:
-   from: testsender@test.com <1.1>
-   host: validhostname <1.2>
-   port: 8080 <1.3>
-   secure: false <1.4>
- secrets:
-   user: testuser <2.1>
-   password: passwordkeystorevalue <2.2>
+ my-email:
+   name: preconfigured-email-action-type
+   actionTypeId: .email
+   config:
+     from: testsender@test.com <1.1>
+     host: validhostname <1.2>
+     port: 8080 <1.3>
+     secure: false <1.4>
+   secrets:
+     user: testuser <2.1>
+     password: passwordkeystorevalue <2.2>
 --
 
 `config` defines the action type specific to the configuration and contains the following properties:

diff --git a/docs/user/alerting/action-types/index.asciidoc b/docs/user/alerting/action-types/index.asciidoc
@@ -21,13 +21,13 @@ Execution time field::  This field will be automatically set to the time the ale
 
 [source,text]
 --
- id: 'my-index'
- name: action-type-index
- actionTypeId: .index
- config:
-   index: .kibana <1>
-   refresh: true <2>
-   executionTimeField: somedate <3>
+ my-index:
+   name: action-type-index
+   actionTypeId: .index
+   config:
+     index: .kibana <1>
+     refresh: true <2>
+     executionTimeField: somedate <3>
 --
 
 `config` defines the action type specific to the configuration and contains the following properties:

diff --git a/docs/user/alerting/action-types/pagerduty.asciidoc b/docs/user/alerting/action-types/pagerduty.asciidoc
@@ -141,13 +141,13 @@ Integration Key::   A 32 character PagerDuty Integration Key for an integration
 
 [source,text]
 --
- id: 'my-pagerduty'
- name: preconfigured-pagerduty-action-type
- actionTypeId: .pagerduty
- config:
-   apiUrl: https://test.host <1.1>
- secrets:
-   routingKey: testroutingkey <2.1>
+ my-pagerduty:
+   name: preconfigured-pagerduty-action-type
+   actionTypeId: .pagerduty
+   config:
+     apiUrl: https://test.host <1.1>
+   secrets:
+     routingKey: testroutingkey <2.1>
 --
 
 `config` defines the action type specific to the configuration and contains the following properties:

diff --git a/docs/user/alerting/action-types/server-log.asciidoc b/docs/user/alerting/action-types/server-log.asciidoc
@@ -18,9 +18,9 @@ Name::      The name of the connector. The name is used to identify a  connector
 
 [source,text]
 --
- id: 'my-server-log'
- name: test
- actionTypeId: .server-log
+ my-server-log:
+   name: test
+   actionTypeId: .server-log
 --
 
 [float]

diff --git a/docs/user/alerting/action-types/slack.asciidoc b/docs/user/alerting/action-types/slack.asciidoc
@@ -19,11 +19,11 @@ Webhook URL::   The URL of the incoming webhook. See https://api.slack.com/messa
 
 [source,text]
 --
- id: 'my-slack'
- name: preconfigured-slack-action-type
- actionTypeId: .slack
- config:
-   webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz' <1>
+ my-slack:
+   name: preconfigured-slack-action-type
+   actionTypeId: .slack
+   config:
+     webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz' <1>
 --
 
 `config` defines the action type specific to the configuration and contains the following properties:

diff --git a/docs/user/alerting/action-types/webhook.asciidoc b/docs/user/alerting/action-types/webhook.asciidoc
@@ -23,17 +23,17 @@ Password::  An optional password. If set, HTTP basic authentication is used. Cur
 
 [source,text]
 --
- id: 'my-webhook'
- name: preconfigured-webhook-action-type
- actionTypeId: .webhook
- config:
-   url: https://test.host <1.1>
-   method: POST <1.2>
-   headers: <1.3>
-     testheader: testvalue
- secrets:
-   user: testuser <2.1>
-   password: passwordkeystorevalue <2.2>
+ my-webhook:
+   name: preconfigured-webhook-action-type
+   actionTypeId: .webhook
+   config:
+     url: https://test.host <1.1>
+     method: POST <1.2>
+     headers: <1.3>
+       testheader: testvalue
+   secrets:
+     user: testuser <2.1>
+     password: passwordkeystorevalue <2.2>
 --
 
 `config` defines the action type specific to the configuration and contains the following properties:

diff --git a/docs/user/alerting/pre-configured-connectors.asciidoc b/docs/user/alerting/pre-configured-connectors.asciidoc
@@ -25,12 +25,12 @@ The following example shows a valid configuration of two out-of-the box connecto
 
 ```js
   xpack.actions.preconfigured:
-    - id: 'my-slack1'           <1>
+    my-slack1:                  <1>
       actionTypeId: .slack      <2>
       name: 'Slack #xyz'        <3>
       config:                   <4>
         webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz'
-    - id: 'webhook-service'
+    webhook-service:
       actionTypeId: .webhook
       name: 'Email service'
       config:
@@ -44,7 +44,7 @@ The following example shows a valid configuration of two out-of-the box connecto
         password: changeme
 ```
 
-<1> `id` is the action connector identifier.
+<1> the key is the action connector identifier, eg `my-slack1` in this example.
 <2> `actionTypeId` is the action type identifier.
 <3> `name` is the name of the preconfigured connector.
 <4> `config` is the action type specific to the configuration.
@@ -69,7 +69,7 @@ The following example shows a valid configuration of preconfigured action type w
 ```js
   xpack.actions.enabledActionTypes: ['.slack', '.email', '.index'] <1>
   xpack.actions.preconfigured:                                     <2>
-    - id: 'my-server-log'
+    my-server-log:
       actionTypeId: .server-log
       name: 'Server log #xyz'
 ```