Skip to content

Commit 65c40ca

Browse files
Merge branch 'master' into fix/dashboard-query-bar-test
2 parents 668b230 + 4bd7b36 commit 65c40ca

File tree

267 files changed

+2950
-1198
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

267 files changed

+2950
-1198
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -391,9 +391,9 @@ Note that for VSCode, to enable "live" linting of TypeScript (and other) file ty
391391

392392
All user-facing labels and info texts in Kibana should be internationalized. Please take a look at the [readme](packages/kbn-i18n/README.md) and the [guideline](packages/kbn-i18n/GUIDELINE.md) of the i18n package on how to do so.
393393

394-
In order to enable translations in the React parts of the application, the top most component of every `ReactDOM.render` call should be an `I18nContext`:
394+
In order to enable translations in the React parts of the application, the top most component of every `ReactDOM.render` call should be the `Context` component from the `i18n` core service:
395395
```jsx
396-
import { I18nContext } from 'ui/i18n';
396+
const I18nContext = coreStart.i18n.Context;
397397

398398
ReactDOM.render(
399399
<I18nContext>

docs/apm/advanced-queries.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ When querying in the APM app, you're simply searching and selecting data from fi
55
Queries entered into the query bar are also added as parameters to the URL,
66
so it's easy to share a specific query or view with others.
77

8-
In the screenshot below, you can begin to see some of the transaction fields available for filtering on:
8+
In the screenshot below, you can begin to see some of the transaction fields available for filtering on:
99

1010
[role="screenshot"]
1111
image::apm/images/apm-query-bar.png[Example of the Kibana Query bar in APM app in Kibana]
@@ -25,7 +25,7 @@ TIP: Read the {kibana-ref}/kuery-query.html[Kibana Query Language Enhancements]
2525

2626
It may also be helpful to view your APM data in the {kibana-ref}/discover.html[Discover app].
2727
Querying documents in Discover works the same way as querying in the APM app,
28-
and all of the example queries listed above can also be used in the Discover app.
28+
and all of the example APM app queries can also be used in the Discover app.
2929

3030
[float]
3131
==== Example Discover app query

docs/canvas/canvas-function-reference.asciidoc

Lines changed: 17 additions & 17 deletions
Large diffs are not rendered by default.

docs/dev-tools/console/console.asciidoc

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ NOTE: You are unable to interact with the REST API of {kib} with the Console.
1818
[[console-api]]
1919
=== Write requests
2020

21-
Console understands commands in a cURL-like syntax.
22-
For example, the following is a `GET` request to the {es} `_search` API.
21+
Console understands commands in a cURL-like syntax.
22+
For example, the following is a `GET` request to the {es} `_search` API.
2323

2424
[source,js]
2525
----------------------------------
@@ -43,23 +43,23 @@ curl -XGET "http://localhost:9200/_search" -d'
4343
}'
4444
----------------------------------
4545

46-
If you paste the above command into Console, {kib} automatically converts it
46+
When you paste the command into Console, {kib} automatically converts it
4747
to Console syntax. Alternatively, if you want to want to see Console syntax in cURL,
48-
click the action icon (image:dev-tools/console/images/wrench.png[]) and select *Copy as cURL*.
48+
click the action icon (image:dev-tools/console/images/wrench.png[]) and select *Copy as cURL*.
4949

5050
[float]
5151
[[console-autocomplete]]
5252
==== Autocomplete
5353

5454
When you're typing a command, Console makes context-sensitive suggestions.
55-
These suggestions show you the parameters for each API and speed up your typing.
56-
To configure your preferences for autocomplete, go to
57-
<<configuring-console, Settings>>.
55+
These suggestions show you the parameters for each API and speed up your typing.
56+
To configure your preferences for autocomplete, go to
57+
<<configuring-console, Settings>>.
5858

5959
[float]
6060
[[auto-formatting]]
6161
==== Auto-formatting
62-
The auto-formatting
62+
The auto-formatting
6363
capability can help you format requests. Select one or more requests that you
6464
want to format, click the action icon (image:dev-tools/console/images/wrench.png[]),
6565
and then select *Auto indent*.
@@ -69,27 +69,27 @@ For example, you might have a request formatted like this:
6969
[role="screenshot"]
7070
image::dev-tools/console/images/copy-curl.png["Console close-up"]
7171

72-
Console adjusts the JSON body of the request to apply the indents.
72+
Console adjusts the JSON body of the request to apply the indents.
7373

7474
[role="screenshot"]
7575
image::dev-tools/console/images/request.png["Console close-up"]
7676

77-
If you select *Auto indent* on a request that is already well formatted,
78-
Console collapses the request body to a single line per document.
77+
If you select *Auto indent* on a request that is already well formatted,
78+
Console collapses the request body to a single line per document.
7979
This is helpful when working with the {es} {ref}/docs-bulk.html[bulk APIs].
8080

8181

8282

8383
[float]
8484
[[console-request]]
85-
=== Submit requests
85+
=== Submit requests
8686

87-
When you're ready to submit the request to {es}, click the
87+
When you're ready to submit the request to {es}, click the
8888
green triangle.
8989

9090
You can select multiple requests and submit them together.
91-
Console sends the requests to {es} one by one and shows the output
92-
in the response pane. Submitting multiple request is helpful when you're debugging an issue or trying query
91+
Console sends the requests to {es} one by one and shows the output
92+
in the response pane. Submitting multiple request is helpful when you're debugging an issue or trying query
9393
combinations in multiple scenarios.
9494

9595

@@ -105,15 +105,15 @@ the action icon (image:dev-tools/console/images/wrench.png[]) and select
105105
[[console-history]]
106106
=== Get your request history
107107

108-
Console maintains a list of the last 500 requests that {es} successfully executed.
108+
Console maintains a list of the last 500 requests that {es} successfully executed.
109109
To view your most recent requests, click *History*. If you select a request
110110
and click *Apply*, {kib} adds it to the editor at the current cursor position.
111111

112112
[float]
113113
[[configuring-console]]
114114
=== Configure Console settings
115115

116-
You can configure the Console font size, JSON syntax,
116+
You can configure the Console font size, JSON syntax,
117117
and autocomplete suggestions in *Settings*.
118118

119119
[role="screenshot"]
@@ -130,9 +130,7 @@ shortcuts, click *Help*.
130130
[[console-settings]]
131131
=== Disable Console
132132

133-
If you don’t want to use Console, you can disable it by setting `console.enabled`
134-
to `false` in your `kibana.yml` configuration file. Changing this setting
135-
causes the server to regenerate assets on the next startup,
133+
If you don’t want to use Console, you can disable it by setting `console.enabled`
134+
to `false` in your `kibana.yml` configuration file. Changing this setting
135+
causes the server to regenerate assets on the next startup,
136136
which might cause a delay before pages start being served.
137-
138-

docs/dev-tools/searchprofiler/more-complicated.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ POST test/_bulk
2525
// CONSOLE
2626
--
2727

28-
. From the {searchprofiler}, enter "test" in the Index field above the query editor to restrict profiled
28+
. From the {searchprofiler}, enter "test" in the *Index* field to restrict profiled
2929
queries to the `test` index.
3030

3131
. Replace the default `match_all` query in the query editor with a query that has two sub-query
@@ -66,7 +66,7 @@ components and includes a simple aggregation, like the example below.
6666
// NOTCONSOLE
6767
--
6868

69-
. Click *Profile* to profile the query and visualize the results.
69+
. Click *Profile* to profile the query and visualize the results.
7070
. Select the shard to view the query details.
7171
+
7272
[role="screenshot"]
@@ -100,5 +100,5 @@ Select the name of the shard to view the aggregation details and timing breakdow
100100
image::dev-tools/searchprofiler/images/gs10.png["Drilling into the first shard's details"]
101101

102102
For more information about how the {searchprofiler} works, how timings are calculated, and
103-
how to interpret various results, see
103+
how to interpret various results, see
104104
{ref}/search-profile.html#profiling-queries[Profiling queries].

docs/developer/core/development-dependencies.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ module.exports = window.angular;
9696

9797
What this shim does is fairly simple if you go line by line:
9898

99-
. makes sure that jQuery is loaded before angular (which actually runs the shim above)
99+
. makes sure that jQuery is loaded before angular (which actually runs the shim)
100100
. load the angular.js file from the node_modules directory
101101
. load the angular-elastic plugin, a plugin we want to always be included whenever we import angular
102102
. use the `ui/modules` module to add the module exported by angular-elastic as a dependency to the `kibana` angular module
103-
. finally, export the window.angular variable. This means that writing `import angular from 'angular';` will properly set the angular variable to the angular library, rather than undefined which is the default behavior.
103+
. finally, export the window.angular variable. This means that writing `import angular from 'angular';` will properly set the angular variable to the angular library, rather than undefined which is the default behavior.

docs/developer/core/development-modules.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ certain components. Here is a breakdown of those modules:
2020
the required modules and import them were they are actually necessary.
2121

2222
- *`import 'ui/autoload/all'`*
23-
Imports all of the above modules
23+
Imports all of the modules
2424

2525
[float]
2626
==== Resolving Require Paths
@@ -60,4 +60,4 @@ Here is how import/require statements are resolved to a file:
6060
** path/index + '.js'
6161
** path/index + '.json'
6262
** path/index
63-
* if none of the above paths matches then an error is thrown
63+
* if none of the paths matches then an error is thrown

docs/developer/plugin/development-plugin-feature-registration.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ init(server) {
175175
}
176176
-----------
177177

178-
Unlike the Canvas example above, Dev Tools does not require access to any saved objects to function. Dev Tools does specify an API endpoint, however. When this is configured, the Security plugin will automatically authorize access to any server API route that is tagged with `access:console`, similar to the following:
178+
Unlike the Canvas example, Dev Tools does not require access to any saved objects to function. Dev Tools does specify an API endpoint, however. When this is configured, the Security plugin will automatically authorize access to any server API route that is tagged with `access:console`, similar to the following:
179179

180180
["source","javascript"]
181181
-----------

docs/developer/plugin/development-plugin-localization.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ This outputs a `en.json` file inside the `translations` directory. To localize o
6868
Checking i18n does the following:
6969

7070
* Checks all existing labels for violations.
71-
* Takes translations from `.i18nrc.json` and compares them to the messages extracted and validated at the step above and:
71+
* Takes translations from `.i18nrc.json` and compares them to the messages extracted and validated.
7272
** Checks for unused translations. If you remove a label that has a corresponding translation, you must also remove the label from the translations file.
7373
** Checks for incompatible translations. If you add or remove a new parameter from an existing string, you must also remove the label from the translations file.
7474

@@ -86,7 +86,7 @@ node scripts/i18n_check --fix --include-config ../kibana-extra/myPlugin/.i18nrc.
8686
Kibana relies on several UI frameworks (ReactJS and AngularJS) and
8787
requires localization in different environments (browser and NodeJS).
8888
The internationalization engine is framework agnostic and consumable in
89-
all parts of Kibana (ReactJS, AngularJS and NodeJS).
89+
all parts of Kibana (ReactJS, AngularJS and NodeJS).
9090

9191
To simplify
9292
internationalization in UI frameworks, additional abstractions are
@@ -112,7 +112,7 @@ export const HELLO_WORLD = i18n.translate('hello.wonderful.world', {
112112
Full details are {repo}tree/master/packages/kbn-i18n#vanilla-js[here].
113113

114114
[float]
115-
===== i18n for React
115+
===== i18n for React
116116

117117
To localize strings in React, use either `FormattedMessage` or `i18n.translate`.
118118

@@ -138,7 +138,7 @@ Full details are {repo}tree/master/packages/kbn-i18n#react[here].
138138

139139

140140
[float]
141-
===== i18n for Angular
141+
===== i18n for Angular
142142

143143
You are encouraged to use `i18n.translate()` by statically importing `i18n` from `@kbn/i18n` wherever possible in your Angular code. Angular wrappers use the translation `service` with the i18n engine under the hood.
144144

docs/developer/pr-review.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Enhancements are pretty much always going to have extensive unit tests as a base
6767
[float]
6868
=== Product level review
6969

70-
Reviewers are not simply evaluating the code itself, they are also evaluating the quality of the user-facing change in the product. This generally means they need to check out the branch locally and "play around" with it. In addition to the "do we want this change in the product" details from above, the reviewer should be looking for bugs and evaluating how approachable and useful the feature is as implemented. Special attention should be given to error scenarios and edge cases to ensure they are all handled well within the product.
70+
Reviewers are not simply evaluating the code itself, they are also evaluating the quality of the user-facing change in the product. This generally means they need to check out the branch locally and "play around" with it. In addition to the "do we want this change in the product" details, the reviewer should be looking for bugs and evaluating how approachable and useful the feature is as implemented. Special attention should be given to error scenarios and edge cases to ensure they are all handled well within the product.
7171

7272

7373
[float]
@@ -107,7 +107,7 @@ Conflicting opinions between reviewers and authors happen, and sometimes it is h
107107

108108
Whether or not a bit of feedback is appropriate for a pull request is often dependent on the motivation for giving the feedback in the first place.
109109

110-
_Demanding_ an author make changes based primarily on the mindset of "how would I write this code?" isn't appropriate. The reviewer didn't write the code, and their critical purpose in the review process is not to craft the contribution into a form that is simply whatever they would have written if they had. If a reviewer wants to provide this type of feedback, they should qualify it as a "nit" as mentioned in the nitpicking section above to make it clear that the author can take it or leave it.
110+
_Demanding_ an author make changes based primarily on the mindset of "how would I write this code?" isn't appropriate. The reviewer didn't write the code, and their critical purpose in the review process is not to craft the contribution into a form that is simply whatever they would have written if they had. If a reviewer wants to provide this type of feedback, they should qualify it as a "nit" as mentioned in the nitpicking section to make it clear that the author can take it or leave it.
111111

112112
Inflammatory feedback such as "this is crap" isn't feedback at all. It's both mean and unhelpful, and it is never appropriate.
113113

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AuthNotHandled](./kibana-plugin-server.authnothandled.md)
4+
5+
## AuthNotHandled interface
6+
7+
8+
<b>Signature:</b>
9+
10+
```typescript
11+
export interface AuthNotHandled
12+
```
13+
14+
## Properties
15+
16+
| Property | Type | Description |
17+
| --- | --- | --- |
18+
| [type](./kibana-plugin-server.authnothandled.type.md) | <code>AuthResultType.notHandled</code> | |
19+
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AuthNotHandled](./kibana-plugin-server.authnothandled.md) &gt; [type](./kibana-plugin-server.authnothandled.type.md)
4+
5+
## AuthNotHandled.type property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
type: AuthResultType.notHandled;
11+
```
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AuthRedirected](./kibana-plugin-server.authredirected.md)
4+
5+
## AuthRedirected interface
6+
7+
8+
<b>Signature:</b>
9+
10+
```typescript
11+
export interface AuthRedirected extends AuthRedirectedParams
12+
```
13+
14+
## Properties
15+
16+
| Property | Type | Description |
17+
| --- | --- | --- |
18+
| [type](./kibana-plugin-server.authredirected.type.md) | <code>AuthResultType.redirected</code> | |
19+
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AuthRedirected](./kibana-plugin-server.authredirected.md) &gt; [type](./kibana-plugin-server.authredirected.type.md)
4+
5+
## AuthRedirected.type property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
type: AuthResultType.redirected;
11+
```
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AuthRedirectedParams](./kibana-plugin-server.authredirectedparams.md) &gt; [headers](./kibana-plugin-server.authredirectedparams.headers.md)
4+
5+
## AuthRedirectedParams.headers property
6+
7+
Headers to attach for auth redirect. Must include "location" header
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
headers: {
13+
location: string;
14+
} & ResponseHeaders;
15+
```
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AuthRedirectedParams](./kibana-plugin-server.authredirectedparams.md)
4+
5+
## AuthRedirectedParams interface
6+
7+
Result of auth redirection.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface AuthRedirectedParams
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [headers](./kibana-plugin-server.authredirectedparams.headers.md) | <code>{</code><br/><code> location: string;</code><br/><code> } &amp; ResponseHeaders</code> | Headers to attach for auth redirect. Must include "location" header |
20+

docs/development/core/server/kibana-plugin-server.authresult.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@
88
<b>Signature:</b>
99

1010
```typescript
11-
export declare type AuthResult = Authenticated;
11+
export declare type AuthResult = Authenticated | AuthNotHandled | AuthRedirected;
1212
```

docs/development/core/server/kibana-plugin-server.authresultparams.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## AuthResultParams interface
66

7-
Result of an incoming request authentication.
7+
Result of successful authentication.
88

99
<b>Signature:</b>
1010

docs/development/core/server/kibana-plugin-server.authresulttype.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,6 @@ export declare enum AuthResultType
1616
| Member | Value | Description |
1717
| --- | --- | --- |
1818
| authenticated | <code>&quot;authenticated&quot;</code> | |
19+
| notHandled | <code>&quot;notHandled&quot;</code> | |
20+
| redirected | <code>&quot;redirected&quot;</code> | |
1921

docs/development/core/server/kibana-plugin-server.authtoolkit.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,6 @@ export interface AuthToolkit
1717
| Property | Type | Description |
1818
| --- | --- | --- |
1919
| [authenticated](./kibana-plugin-server.authtoolkit.authenticated.md) | <code>(data?: AuthResultParams) =&gt; AuthResult</code> | Authentication is successful with given credentials, allow request to pass through |
20+
| [notHandled](./kibana-plugin-server.authtoolkit.nothandled.md) | <code>() =&gt; AuthResult</code> | User has no credentials. Allows user to access a resource when authRequired: 'optional' Rejects a request when authRequired: true |
21+
| [redirected](./kibana-plugin-server.authtoolkit.redirected.md) | <code>(headers: {</code><br/><code> location: string;</code><br/><code> } &amp; ResponseHeaders) =&gt; AuthResult</code> | Redirect user to IdP when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional' |
2022

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AuthToolkit](./kibana-plugin-server.authtoolkit.md) &gt; [notHandled](./kibana-plugin-server.authtoolkit.nothandled.md)
4+
5+
## AuthToolkit.notHandled property
6+
7+
User has no credentials. Allows user to access a resource when authRequired: 'optional' Rejects a request when authRequired: true
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
notHandled: () => AuthResult;
13+
```

0 commit comments

Comments
 (0)