[DOCS] Add Dev Tools warning to Security App API subpages (elastic#686)…

… (elastic#697) * Added note about dev tool. * Added missing space after note. * Added missing spaces before note. * Adding note to remaining topics. * Added note to other three topics. * Inserting note to newly added Timeline topics.
nastasha-solomon · May 24, 2021 · 864599a · 864599a
1 parent 90fe910
commit 864599a
Show file tree

Hide file tree

Showing 68 changed files with 383 additions and 229 deletions.
diff --git a/docs/cases/api/actions-api/cases-actions-api-intro.asciidoc b/docs/cases/api/actions-api/cases-actions-api-intro.asciidoc
@@ -8,6 +8,8 @@ You can push {es-sec} cases to these third-party systems:
 * {jira} (including Jira Service Desk)
 * {ibm-r}
 
+NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].
+
 To push cases, you need to create a connector using the {kib} Actions API,
 which stores the information required to interface with the external system.
 
@@ -35,6 +37,8 @@ required for updating the the {es-sec} case.
 Creates a connector, which can then be used to open and update cases in external
 systems.
 
+NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].
+
 ==== Request URL
 
 `POST <kibana host>:<port>/api/actions/action`
@@ -183,6 +187,8 @@ A JSON object with a connector `id` that is required to push cases to {sn}.
 
 Updates a connector.
 
+NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].
+
 ==== Request URL
 
 `PUT <kibana host>:<port>/api/actions/action/<connector ID>`
@@ -288,6 +294,8 @@ The updated JSON connector object.
 
 Creates a new or updates an existing external incident from a {es-sec} case.
 
+NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].
+
 NOTE: You can only send cases to external systems after you have
 <<register-connector, created>> a connector. After you have sent the case to
 an external system, you must call <<cases-api-associate-sn-incident>> to update

diff --git a/docs/cases/api/cases-api/case-api-update-connector.asciidoc b/docs/cases/api/cases-api/case-api-update-connector.asciidoc
@@ -3,6 +3,8 @@
 
 Updates the connector's case closure settings.
 
+NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].
+
 Connectors are used to interface with external systems. You can only call this
 method after you have created a connector (see <<register-connector>>). After a
 connector has been created and assigned, call <<cases-actions-api-execute>> to
@@ -42,7 +44,7 @@ are pushed.
 
 |`id` |String |The ID of the connector you want to use for sending cases to external systems. |Yes
 |`name` |String a|The connector name. |Yes
-|`type` |String a|The type of the connector. 
+|`type` |String a|The type of the connector.
 
 Must be one of these:
 
@@ -80,13 +82,13 @@ NOTE: Fields can be set but are not being used by case configuration. You can se
 
 ===== Example request
 
-Changes the connector's case closure option: 
+Changes the connector's case closure option:
 
 [source,sh]
 --------------------------------------------------
 PATCH api/cases/configure
 {
-  "connector": { 
+  "connector": {
     "id": "131d4448-abe0-4789-939d-8ef60680b498",
     "name": "My connector",
     "type": ".jira",
@@ -100,15 +102,15 @@ PATCH api/cases/configure
 
 ==== Response code
 
-`200`:: 
+`200`::
    Indicates a successful call.
 
 ===== Example response
 
 [source,json]
 --------------------------------------------------
 {
-  "connector": { 
+  "connector": {
     "id": "131d4448-abe0-4789-939d-8ef60680b498",
     "name": "My connector",
     "type": ".jira",
@@ -131,4 +133,3 @@ PATCH api/cases/configure
   "version": "WzIwMywxXQ=="
 }
 --------------------------------------------------
-
diff --git a/docs/cases/api/cases-api/cases-api-add-comment.asciidoc b/docs/cases/api/cases-api/cases-api-add-comment.asciidoc
@@ -3,13 +3,15 @@
 
 Adds a comment to an existing case.
 
+NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].
+
 ==== Request URL
 
 `POST <kibana host>:<port>/api/cases/<case ID>/comments`
 
 ===== URL parts
 
-The URL must include the `case ID` of the case to which you are adding a 
+The URL must include the `case ID` of the case to which you are adding a
 comment. Call <<cases-api-find-cases>> to retrieve case IDs.
 
 ==== Request body
@@ -45,7 +47,7 @@ POST api/cases/293f1bc0-74f6-11ea-b83a-553aecdb28b6/comments
 
 ==== Response code
 
-`200`:: 
+`200`::
    Indicates a successful call.
 
 ==== Response payload
@@ -102,4 +104,4 @@ comment, and the comment's ID, version, and creation time.
     "username": "moneypenny"
   }
 }
---------------------------------------------------
+--------------------------------------------------
diff --git a/docs/cases/api/cases-api/cases-api-assign-connector.asciidoc b/docs/cases/api/cases-api/cases-api-assign-connector.asciidoc
@@ -3,6 +3,8 @@
 
 Sets the default connector in the {es-sec-ui}.
 
+NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].
+
 Connectors are used to interface with external systems. You can only call this
 method after you have created a connector (see <<register-connector>>). After a
 connector has been created and assigned, call <<cases-actions-api-execute>> to
@@ -44,7 +46,7 @@ are pushed.
 
 |`id` |String |The ID of the connector you want to use for sending cases to external systems. |Yes
 |`name` |String a|The connector name. |Yes
-|`type` |String a|The type of the connector. 
+|`type` |String a|The type of the connector.
 
 Must be one of these:
 
@@ -85,7 +87,7 @@ NOTE: Fields can be set but are not being used by case configuration. You can se
 --------------------------------------------------
 POST api/cases/configure
 {
-  "connector": { 
+  "connector": {
     "id": "131d4448-abe0-4789-939d-8ef60680b498",
     "name": "Jira",
     "type": ".jira",
@@ -97,15 +99,15 @@ POST api/cases/configure
 
 ==== Response code
 
-`200`:: 
+`200`::
    Indicates a successful call.
-   
+
 ==== Example response
 
 [source,json]
 --------------------------------------------------
 {
-  "connector": { 
+  "connector": {
     "id": "131d4448-abe0-4789-939d-8ef60680b498",
     "name": "Jira",
     "type": ".jira",
@@ -120,7 +122,7 @@ POST api/cases/configure
   },
   "error": null,
   "mappings":[
-    { 
+    {
       "source":"title", <1>
       "target":"summary",
       "action_type": "overwrite"
@@ -152,4 +154,4 @@ the {jira} `description` field is overwritten.
 
 <3> {es-sec} case `comments` fields are mapped to {jira} `comments` fields.
 When a {es-sec} `comments` field is updated and sent to {jira}, the updated
-text is appended to the {jira} `comments` field.
+text is appended to the {jira} `comments` field.
diff --git a/docs/cases/api/cases-api/cases-api-associate-sn.asciidoc b/docs/cases/api/cases-api/cases-api-associate-sn.asciidoc
@@ -3,6 +3,8 @@
 
 Adds the data returned from an external system to the specified case.
 
+NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].
+
 After sending a new or updated case to an external system using the
 <<cases-actions-api-execute, Actions API>>, you must associate
 the external system's returned object with the case in {es-sec}.
@@ -53,9 +55,9 @@ POST api/cases/718265d0-733a-11ea-a0b2-c51ea50a58e2/_push
 
 ==== Response code
 
-`200`:: 
+`200`::
    Indicates a successful call.
-   
+
 ==== Response payload
 
 The updated JSON case object.
@@ -110,4 +112,4 @@ The updated JSON case object.
     "syncAlerts": true
   },
 }
---------------------------------------------------
+--------------------------------------------------
diff --git a/docs/cases/api/cases-api/cases-api-create.asciidoc b/docs/cases/api/cases-api/cases-api-create.asciidoc
@@ -3,6 +3,8 @@
 
 Creates a new case.
 
+NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].
+
 ==== Request URL
 
 `POST <kibana host>:<port>/api/cases`
@@ -36,7 +38,7 @@ settings. |Yes
 used for pushing case updates to external systems (returned when calling
 <<cases-api-find-connectors>>). |Yes
 |`name` |String a|The connector name. |Yes
-|`type` |String a|The type of the connector. 
+|`type` |String a|The type of the connector.
 
 Must be one of these:
 
@@ -107,7 +109,7 @@ POST api/cases
 
 ==== Response code
 
-`200`:: 
+`200`::
    Indicates a successful call.
 
 ==== Response payload

diff --git a/docs/cases/api/cases-api/cases-api-delete-all-comments.asciidoc b/docs/cases/api/cases-api/cases-api-delete-all-comments.asciidoc
@@ -3,6 +3,8 @@
 
 Deletes all comments from the specified case.
 
+NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].
+
 ==== Request URL
 
 `DELETE <kibana host>:<port>/api/cases/<case ID>/comments`
@@ -24,5 +26,5 @@ DELETE api/cases/a18b38a0-71b0-11ea-a0b2-c51ea50a58e2/comments
 
 ==== Response code
 
-`204`:: 
-   Indicates a successful call.
+`204`::
+   Indicates a successful call.
diff --git a/docs/cases/api/cases-api/cases-api-delete-case.asciidoc b/docs/cases/api/cases-api/cases-api-delete-case.asciidoc
@@ -3,6 +3,8 @@
 
 Deletes the specified cases and all associated comments.
 
+NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].
+
 ==== Request URL
 
 `DELETE <kibana host>:<port>/api/cases?ids=["<case ID1>","<case ID2>"]`
@@ -29,5 +31,5 @@ DELETE api/cases?ids=%5B%222e3a54f0-6754-11ea-a1c2-e3a8bc9f7aca%22%2C%2240b9a450
 
 ==== Response code
 
-`204`:: 
-   Indicates a successful call.
+`204`::
+   Indicates a successful call.
diff --git a/docs/cases/api/cases-api/cases-api-delete-comment.asciidoc b/docs/cases/api/cases-api/cases-api-delete-comment.asciidoc
@@ -3,6 +3,8 @@
 
 Deletes the specified comment.
 
+NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].
+
 ==== Request URL
 
 `DELETE <kibana host>:<port>/api/cases/<case ID>/comments/<comment ID>`
@@ -29,5 +31,5 @@ DELETE api/cases/a18b38a0-71b0-11ea-a0b2-c51ea50a58e2/comments/71ec1870-725b-11e
 
 ==== Response code
 
-`204`:: 
-   Indicates a successful call.
+`204`::
+   Indicates a successful call.
diff --git a/docs/cases/api/cases-api/cases-api-find-cases.asciidoc b/docs/cases/api/cases-api/cases-api-find-cases.asciidoc
@@ -1,9 +1,11 @@
 [[cases-api-find-cases]]
 === Find cases
 
-Retrieves a paginated subset of cases. By default, the first page is returned 
+Retrieves a paginated subset of cases. By default, the first page is returned
 with 20 results per page.
 
+NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].
+
 NOTE: Cases are saved objects. See
 {kibana-ref}/saved-objects-api-find.html[Find objects API] for more query
 parameters.
@@ -44,7 +46,7 @@ query.
 
 ===== Example request
 
-Retrieves the first five cases with the `phishing` tag, in ascending order by 
+Retrieves the first five cases with the `phishing` tag, in ascending order by
 last update time.
 
 [source,sh]
@@ -55,7 +57,7 @@ GET api/cases/_find?page=1&perPage=5&sortField=updatedAt&sortOrder=asc&tags=phis
 
 ==== Response code
 
-`200`:: 
+`200`::
    Indicates a successful call.
 
 ==== Response payload
@@ -140,7 +142,7 @@ A JSON object listing the retrieved cases.
         }
       },
       "settings": {
-        "syncAlerts": false 
+        "syncAlerts": false
       },
       "tags": [
         "phishing",
@@ -152,4 +154,4 @@ A JSON object listing the retrieved cases.
   "count_open_cases": 2,
   "count_closed_cases": 0
 }
---------------------------------------------------
+--------------------------------------------------
diff --git a/docs/cases/api/cases-api/cases-api-find-connectors.asciidoc b/docs/cases/api/cases-api/cases-api-find-connectors.asciidoc
@@ -3,6 +3,8 @@
 
 Retrieves a paginated subset of all connectors.
 
+NOTE: The {kib} Console supports only Elasticsearch APIs. You cannot interact with the {kib} APIs with the Console and must use `curl` or another HTTP tool instead. For more information, refer to https://www.elastic.co/guide/en/kibana/current/console-kibana.html[Console].
+
 NOTE: Only {sn}, {jira}, and {ibm-r} connectors are returned. For more information on
 connectors, see <<actions-api-overview>>.
 
@@ -20,9 +22,9 @@ GET api/cases/configure/connectors/_find
 
 ==== Response code
 
-`200`:: 
+`200`::
    Indicates a successful call.
-   
+
 ==== Response payload
 
 A JSON object describing the connectors and their settings.
@@ -56,4 +58,4 @@ A JSON object describing the connectors and their settings.
     }
   ]
 }
---------------------------------------------------
+--------------------------------------------------