diff --git a/docs/dev-tools/console/auto-formatting.asciidoc b/docs/dev-tools/console/auto-formatting.asciidoc deleted file mode 100644 index a7e69aa66337ec..00000000000000 --- a/docs/dev-tools/console/auto-formatting.asciidoc +++ /dev/null @@ -1,20 +0,0 @@ -[[auto-formatting]] -=== Auto formatting - -Console can help you format requests. Select one or more requests that you -want to format, click the action icon (image:dev-tools/console/images/wrench.png[]), -and select *Auto indent*. - -For example, you might have a request that is formatted like this: - -[role="screenshot"] -image::dev-tools/console/images/copy-curl.png["Console close-up"] - -Console adjusts the JSON body of the request to apply the indents. - -[role="screenshot"] -image::dev-tools/console/images/request.png["Console close-up"] - -If you select *Auto indent* on a request that is already well formatted, -Console collapses the request body to a single line per document. -This is helpful when working with {es}'s {ref}/docs-bulk.html[bulk APIs]. diff --git a/docs/dev-tools/console/configuring-console.asciidoc b/docs/dev-tools/console/configuring-console.asciidoc deleted file mode 100644 index f750aa7f51ba09..00000000000000 --- a/docs/dev-tools/console/configuring-console.asciidoc +++ /dev/null @@ -1,26 +0,0 @@ -[[configuring-console]] -=== Configuring Console - -You can configure Console to your preferences. - -[float] -==== Configuring settings - -*Settings* allows you to modify the font size and set the fileds for -autocomplete. - -[role="screenshot"] -image::dev-tools/console/images/console-settings.png["Console settings"] - - -[float] -[[console-settings]] -==== Disabling Console - -If you don’t want to use Console, you can disable it by setting `console.enabled` -to false in your `kibana.yml` configuration file. Changing this setting -causes the server to regenerate assets on the next startup, -which might cause a delay before pages start being served. - - - diff --git a/docs/dev-tools/console/console.asciidoc b/docs/dev-tools/console/console.asciidoc index f43b5dad70d96b..a678e7189abec4 100644 --- a/docs/dev-tools/console/console.asciidoc +++ b/docs/dev-tools/console/console.asciidoc @@ -1,22 +1,20 @@ [[console-kibana]] == Console -Console enables you to interact with the REST API of {es}. *Note:* You cannot -interact with {kib} API endpoints via Console. +Console enables you to interact with the REST API of {es}. You can: -Go to *Dev Tools > Console* to get started. +* Send requests to {es} and view the responses +* View API documentation +* Get your request history -Console has two main areas: - -* The *editor*, where you compose requests to send to {es}. -* The *response* pane, which displays the responses to the request. +To get started, go to *Dev Tools > Console*. [role="screenshot"] image::dev-tools/console/images/console.png["Console"] [float] [[console-api]] -=== Writing requests +=== Write requests Console understands commands in a cURL-like syntax. For example, the following is a `GET` request to the {es} `_search` API. @@ -47,51 +45,92 @@ If you paste the above command into Console, {kib} automatically converts it to Console syntax. Alternatively, if you want to want to see Console syntax in cURL, click the action icon (image:dev-tools/console/images/wrench.png[]) and select *Copy as cURL*. -For help with formatting requests, you can use Console's <> -feature. +[float] +[[console-autocomplete]] +==== Autocomplete + +When you're typing a command, Console makes context-sensitive suggestions. +These suggestions show you the parameters for each API and speed up your typing. +To configure your preferences for autocomplete, go to +<>. + +[float] +[[auto-formatting]] +==== Auto-formatting +The auto-formatting +capability can help you format requests. Select one or more requests that you +want to format, click the action icon (image:dev-tools/console/images/wrench.png[]), +and then select *Auto indent*. + +For example, you might have a request formatted like this: + +[role="screenshot"] +image::dev-tools/console/images/copy-curl.png["Console close-up"] + +Console adjusts the JSON body of the request to apply the indents. + +[role="screenshot"] +image::dev-tools/console/images/request.png["Console close-up"] + +If you select *Auto indent* on a request that is already well formatted, +Console collapses the request body to a single line per document. +This is helpful when working with the {es} {ref}/docs-bulk.html[bulk APIs]. + [float] [[console-request]] -=== Submitting requests +=== Submit requests -Once you enter a command in the editor, click the -green triangle to submit the request to {es}. +When you're ready to submit the request to {es}, click the +green triangle. You can select multiple requests and submit them together. Console sends the requests to {es} one by one and shows the output in the response pane. Submitting multiple request is helpful when you're debugging an issue or trying query combinations in multiple scenarios. -[float] -[[console-autocomplete]] -=== Using autocomplete - -When typing a command, Console makes context-sensitive suggestions. -These suggestions can help you explore parameters for each API and speed up typing. -To configure your preferences for autocomplete, go to -<>. [float] [[console-view-api]] -=== Viewing API docs +=== View API docs -You can view the documentation for an API endpoint by clicking -the action icon (image:dev-tools/console/images/wrench.png[]) and selecting +To view the documentation for an API endpoint, click +the action icon (image:dev-tools/console/images/wrench.png[]) and select *Open documentation*. [float] [[console-history]] -=== Getting your request history +=== Get your request history Console maintains a list of the last 500 requests that {es} successfully executed. To view your most recent requests, click *History*. If you select a request and click *Apply*, {kib} adds it to the editor at the current cursor position. +[float] +[[configuring-console]] +=== Configure Console settings + +You can configure the Console font size, JSON syntax, +and autocomplete suggestions in *Settings*. + +[role="screenshot"] +image::dev-tools/console/images/console-settings.png["Console Settings"] +[float] +[[keyboard-shortcuts]] +=== Get keyboard shortcuts + +For a list of available keyboard +shortcuts, click *Help*. + +[float] +[[console-settings]] +=== Disable Console -include::auto-formatting.asciidoc[] +If you don’t want to use Console, you can disable it by setting `console.enabled` +to `false` in your `kibana.yml` configuration file. Changing this setting +causes the server to regenerate assets on the next startup, +which might cause a delay before pages start being served. -include::keyboard-shortcuts.asciidoc[] -include::configuring-console.asciidoc[] diff --git a/docs/dev-tools/console/images/console-settings.png b/docs/dev-tools/console/images/console-settings.png index 0181ed8796e6f3..1edd249cc7ee17 100644 Binary files a/docs/dev-tools/console/images/console-settings.png and b/docs/dev-tools/console/images/console-settings.png differ diff --git a/docs/dev-tools/console/images/console.png b/docs/dev-tools/console/images/console.png index b820f9fb0a20da..090668afc29d19 100644 Binary files a/docs/dev-tools/console/images/console.png and b/docs/dev-tools/console/images/console.png differ diff --git a/docs/dev-tools/console/keyboard-shortcuts.asciidoc b/docs/dev-tools/console/keyboard-shortcuts.asciidoc deleted file mode 100644 index f71e04b0d3cfe7..00000000000000 --- a/docs/dev-tools/console/keyboard-shortcuts.asciidoc +++ /dev/null @@ -1,22 +0,0 @@ -[[keyboard-shortcuts]] -=== Keyboard shortcuts - -The keyboard shortcuts below can help you move quickly through Console. You can -also view these shortcuts by clicking *Help* in Console. - -[float] -==== General editing - -Ctrl/Cmd + I:: Auto indent current request. -Ctrl + Space:: Open Autocomplete (even if not typing). -Ctrl/Cmd + Enter:: Submit request. -Ctrl/Cmd + Up/Down:: Jump to the previous/next request start or end. -Ctrl/Cmd + Alt + L:: Collapse/expand current scope. -Ctrl/Cmd + Option + 0:: Collapse all scopes but the current one. Expand by adding a shift. - -[float] -==== When autocomplete is visible - -Down arrow:: Switch focus to autocomplete menu. Use arrows to further select a term. -Enter/Tab:: Select the currently selected or the top most term in autocomplete menu. -Esc:: Close autocomplete menu.