Skip to content

Commit

Permalink
Merge branch 'master' of github.com:elastic/kibana into feature-fleet
Browse files Browse the repository at this point in the history
  • Loading branch information
mattapperson committed Jul 23, 2019
2 parents db5fc8f + 751f2ee commit 997490f
Show file tree
Hide file tree
Showing 506 changed files with 6,697 additions and 8,650 deletions.
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,11 @@
/x-pack/legacy/plugins/spaces/ @elastic/kibana-security
/x-pack/legacy/plugins/encrypted_saved_objects/ @elastic/kibana-security
/src/legacy/server/csp/ @elastic/kibana-security
/x-pack/plugins/security/ @elastic/kibana-security

# Kibana Stack Services
/packages/kbn-analytics/ @elastic/kibana-stack-services
/src/legacy/core_plugins/ui_metric/ @elastic/kibana-stack-services
/x-pack/legacy/plugins/telemetry @elastic/kibana-stack-services
/x-pack/legacy/plugins/alerting @elastic/kibana-stack-services
/x-pack/legacy/plugins/actions @elastic/kibana-stack-services
Expand Down
1 change: 1 addition & 0 deletions .i18nrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"paths": {
"common.ui": "src/legacy/ui",
"data": "src/legacy/core_plugins/data",
"kibana_react": "src/legacy/core_plugins/kibana_react",
"server": "src/legacy/server",
"console": "src/legacy/core_plugins/console",
"core": "src/core",
Expand Down
24 changes: 12 additions & 12 deletions docs/canvas/canvas-function-reference.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -1161,7 +1161,7 @@ Default: `""`
|`style`
|The CSS font properties for the content. For example, `font-family` or `font-weight`.

Default: `{<<font_fn>>}`
Default: `{font}`
|===

*Returns:* `render`
Expand Down Expand Up @@ -1213,13 +1213,13 @@ Default: `""`
|`style`
|The CSS font properties for the metric. For example, `font-family` or `font-weight`.

Default: `{<<font_fn>> size=48 family="'Open Sans', Helvetica, Arial, sans-serif" color="#000000" align=center lHeight=48}`.
Default: `{font size=48 family="'Open Sans', Helvetica, Arial, sans-serif" color="#000000" align=center lHeight=48}`.

|`labelFont`
|`style`
|The CSS font properties for the label. For example, `font-family` or `font-weight`.

Default: `{<<font_fn>> size=14 family="'Open Sans', Helvetica, Arial, sans-serif" color="#000000" align=center}`.
Default: `{font size=14 family="'Open Sans', Helvetica, Arial, sans-serif" color="#000000" align=center}`.
|===

*Returns:* `render`
Expand Down Expand Up @@ -1305,7 +1305,7 @@ Configures a pie chart element.
|`style`
|The CSS font properties for the labels. For example, `font-family` or `font-weight`.

Default: `{<<font_fn>>}`
Default: `{font}`

|`hole`
|`number`
Expand Down Expand Up @@ -1335,7 +1335,7 @@ Default: `false`
|`palette`
|A `palette` object for describing the colors to use in this pie chart

Default: `{<<palette_fn>>}`
Default: `{palette}`

|`radius`
|`string`, `number`
Expand Down Expand Up @@ -1373,13 +1373,13 @@ Configures a plot element.
|`seriesStyle`
|The default style to use for every series.

Default: `{<<seriesStyle_fn>> points=5}`
Default: `{seriesStyle points=5}`

|`font`
|`style`
|The CSS font properties for the labels. For example, `font-family` or `font-weight`.

Default: `{<<font_fn>>}`
Default: `{font}`

|`legend`
|`string`, `boolean`
Expand All @@ -1391,7 +1391,7 @@ Default: `"ne"`
|`palette`
|A `palette` object for describing the colors to use in this chart

Default: `{<<palette_fn>>}`
Default: `{palette}`

|`seriesStyle` †
|`seriesStyle`
Expand Down Expand Up @@ -1512,7 +1512,7 @@ Default: `20`
|`style`
|The CSS font properties for the label. For example, `font-family` or `font-weight`.

Default: `{<<font_fn>> size=24 family="'Open Sans', Helvetica, Arial, sans-serif" color="#000000" align=center}`
Default: `{font size=24 family="'Open Sans', Helvetica, Arial, sans-serif" color="#000000" align=center}`

|`label`
|`boolean`, `string`
Expand Down Expand Up @@ -1572,7 +1572,7 @@ Default: `".canvasRenderEl{\n\n}"`
|`containerStyle`
|The style for the container, including background, border, and opacity.

Default: `{<<containerStyle_fn>>}`
Default: `{containerStyle}`
|===

*Returns:* `render`
Expand Down Expand Up @@ -1726,7 +1726,7 @@ Alias: `format`
[[rowCount_fn]]
=== `rowCount`

Returns the number of rows. Pairs with `<<ply_fn>>` to get the count of unique column values, or combinations of unique column values.
Returns the number of rows. Pairs with <<ply_fn>> to get the count of unique column values, or combinations of unique column values.

*Accepts:* `datatable`

Expand Down Expand Up @@ -1964,7 +1964,7 @@ Configures a table element.
|`style`
|The CSS font properties for the contents of the table. For example, `font-family` or `font-weight`.

Default: `{<<font_fn>>}`
Default: `{font}`

|`paginate`
|`boolean`
Expand Down
20 changes: 0 additions & 20 deletions docs/dev-tools/console/auto-formatting.asciidoc

This file was deleted.

26 changes: 0 additions & 26 deletions docs/dev-tools/console/configuring-console.asciidoc

This file was deleted.

95 changes: 67 additions & 28 deletions docs/dev-tools/console/console.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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 <<auto-formatting, auto formatting>>
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
<<configuring-console, Settings>>.

[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
<<configuring-console, Settings>>.

[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[]
Binary file modified docs/dev-tools/console/images/console-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/dev-tools/console/images/console.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 0 additions & 22 deletions docs/dev-tools/console/keyboard-shortcuts.asciidoc

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The interface that should be returned by a `PluginInitializer`<!-- -->.
<b>Signature:</b>

```typescript
export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends {} = {}, TPluginsStart extends {} = {}>
export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends object = object, TPluginsStart extends object = object>
```

## Methods
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ The `plugin` export at the root of a plugin's `public` directory should conform
<b>Signature:</b>

```typescript
export declare type PluginInitializer<TSetup, TStart, TPluginsSetup extends Record<string, any> = {}, TPluginsStart extends Record<string, any> = {}> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
export declare type PluginInitializer<TSetup, TStart, TPluginsSetup extends object = object, TPluginsStart extends object = object> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
```
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
<b>Signature:</b>

```typescript
export declare type APICaller = (endpoint: string, clientParams: Record<string, unknown>, options?: CallAPIOptions) => Promise<unknown>;
export declare type APICaller = (endpoint: string, clientParams: Record<string, any>, options?: CallAPIOptions) => Promise<unknown>;
```
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ export interface AuthResultData
| Property | Type | Description |
| --- | --- | --- |
| [headers](./kibana-plugin-server.authresultdata.headers.md) | <code>AuthHeaders</code> | Auth specific headers to authenticate a user against Elasticsearch. |
| [state](./kibana-plugin-server.authresultdata.state.md) | <code>Record&lt;string, unknown&gt;</code> | Data to associate with an incoming request. Any downstream plugin may get access to the data. |
| [state](./kibana-plugin-server.authresultdata.state.md) | <code>Record&lt;string, any&gt;</code> | Data to associate with an incoming request. Any downstream plugin may get access to the data. |

Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Data to associate with an incoming request. Any downstream plugin may get access
<b>Signature:</b>

```typescript
state: Record<string, unknown>;
state: Record<string, any>;
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Calls specified endpoint with provided clientParams on behalf of the Kibana inte
<b>Signature:</b>

```typescript
callAsInternalUser: (endpoint: string, clientParams?: Record<string, unknown>, options?: CallAPIOptions | undefined) => Promise<any>;
callAsInternalUser: (endpoint: string, clientParams?: Record<string, any>, options?: CallAPIOptions | undefined) => Promise<any>;
```
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export declare class ClusterClient

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [callAsInternalUser](./kibana-plugin-server.clusterclient.callasinternaluser.md) | | <code>(endpoint: string, clientParams?: Record&lt;string, unknown&gt;, options?: CallAPIOptions &#124; undefined) =&gt; Promise&lt;any&gt;</code> | Calls specified endpoint with provided clientParams on behalf of the Kibana internal user. |
| [callAsInternalUser](./kibana-plugin-server.clusterclient.callasinternaluser.md) | | <code>(endpoint: string, clientParams?: Record&lt;string, any&gt;, options?: CallAPIOptions &#124; undefined) =&gt; Promise&lt;any&gt;</code> | Calls specified endpoint with provided clientParams on behalf of the Kibana internal user. |

## Methods

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The interface that should be returned by a `PluginInitializer`<!-- -->.
<b>Signature:</b>

```typescript
export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends {} = {}, TPluginsStart extends {} = {}>
export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends object = object, TPluginsStart extends object = object>
```

## Methods
Expand Down
Loading

0 comments on commit 997490f

Please sign in to comment.