Skip to content

Commit 8f5c13d

Browse files
committed
Merge branch 'master' into alerting/client-types
* master: increase delay to make sure license refetched (elastic#53882) Allow custom NP plugin paths in production (elastic#53562) [Maps] show custom color ramps in legend (elastic#53780) [Lens] Expression type on document can be null (elastic#53883) [SIEM] [Detection engine] Add user permission to detection engine (elastic#53778) Update dependency @elastic/charts to v16.0.2 (elastic#52619) Set consistent EOL symbol in core API docs (elastic#53815) [Logs UI] Refactor query bar state to hooks (elastic#52656) [Maps] pass getFieldFormatter to DynamicTextProperty (elastic#53937) Invalidate alert API Key when generating a new one (elastic#53732) [Logs UI] HTTP API for log entries (elastic#53798)
2 parents ae0314d + d64c4cb commit 8f5c13d

File tree

167 files changed

+5785
-3698
lines changed

Some content is hidden

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

167 files changed

+5785
-3698
lines changed

docs/development/core/public/kibana-plugin-public.chromedoctitle.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,6 @@ APIs for accessing and updating the document title.
1212
export interface ChromeDocTitle
1313
```
1414

15-
## Methods
16-
17-
| Method | Description |
18-
| --- | --- |
19-
| [change(newTitle)](./kibana-plugin-public.chromedoctitle.change.md) | Changes the current document title. |
20-
| [reset()](./kibana-plugin-public.chromedoctitle.reset.md) | Resets the document title to it's initial value. (meaning the one present in the title meta at application load.) |
21-
2215
## Example 1
2316

2417
How to change the title of the document
@@ -37,3 +30,10 @@ chrome.docTitle.reset()
3730

3831
```
3932

33+
## Methods
34+
35+
| Method | Description |
36+
| --- | --- |
37+
| [change(newTitle)](./kibana-plugin-public.chromedoctitle.change.md) | Changes the current document title. |
38+
| [reset()](./kibana-plugin-public.chromedoctitle.reset.md) | Resets the document title to it's initial value. (meaning the one present in the title meta at application load.) |
39+

docs/development/core/public/kibana-plugin-public.chromenavcontrols.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,6 @@
1212
export interface ChromeNavControls
1313
```
1414

15-
## Methods
16-
17-
| Method | Description |
18-
| --- | --- |
19-
| [registerLeft(navControl)](./kibana-plugin-public.chromenavcontrols.registerleft.md) | Register a nav control to be presented on the left side of the chrome header. |
20-
| [registerRight(navControl)](./kibana-plugin-public.chromenavcontrols.registerright.md) | Register a nav control to be presented on the right side of the chrome header. |
21-
2215
## Example
2316

2417
Register a left-side nav control rendered with React.
@@ -33,3 +26,10 @@ chrome.navControls.registerLeft({
3326

3427
```
3528

29+
## Methods
30+
31+
| Method | Description |
32+
| --- | --- |
33+
| [registerLeft(navControl)](./kibana-plugin-public.chromenavcontrols.registerleft.md) | Register a nav control to be presented on the left side of the chrome header. |
34+
| [registerRight(navControl)](./kibana-plugin-public.chromenavcontrols.registerright.md) | Register a nav control to be presented on the right side of the chrome header. |
35+

docs/development/core/public/kibana-plugin-public.chromestart.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,31 @@ ChromeStart allows plugins to customize the global chrome header UI and enrich t
1212
export interface ChromeStart
1313
```
1414

15+
## Remarks
16+
17+
While ChromeStart exposes many APIs, they should be used sparingly and the developer should understand how they affect other plugins and applications.
18+
19+
## Example 1
20+
21+
How to add a recently accessed item to the sidebar:
22+
23+
```ts
24+
core.chrome.recentlyAccessed.add('/app/map/1234', 'Map 1234', '1234');
25+
26+
```
27+
28+
## Example 2
29+
30+
How to set the help dropdown extension:
31+
32+
```tsx
33+
core.chrome.setHelpExtension(elem => {
34+
ReactDOM.render(<MyHelpComponent />, elem);
35+
return () => ReactDOM.unmountComponentAtNode(elem);
36+
});
37+
38+
```
39+
1540
## Properties
1641

1742
| Property | Type | Description |
@@ -43,28 +68,3 @@ export interface ChromeStart
4368
| [setIsCollapsed(isCollapsed)](./kibana-plugin-public.chromestart.setiscollapsed.md) | Set the collapsed state of the chrome navigation. |
4469
| [setIsVisible(isVisible)](./kibana-plugin-public.chromestart.setisvisible.md) | Set the temporary visibility for the chrome. This does nothing if the chrome is hidden by default and should be used to hide the chrome for things like full-screen modes with an exit button. |
4570

46-
## Remarks
47-
48-
While ChromeStart exposes many APIs, they should be used sparingly and the developer should understand how they affect other plugins and applications.
49-
50-
## Example 1
51-
52-
How to add a recently accessed item to the sidebar:
53-
54-
```ts
55-
core.chrome.recentlyAccessed.add('/app/map/1234', 'Map 1234', '1234');
56-
57-
```
58-
59-
## Example 2
60-
61-
How to set the help dropdown extension:
62-
63-
```tsx
64-
core.chrome.setHelpExtension(elem => {
65-
ReactDOM.render(<MyHelpComponent />, elem);
66-
return () => ReactDOM.unmountComponentAtNode(elem);
67-
});
68-
69-
```
70-

docs/development/core/public/kibana-plugin-public.contextsetup.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,6 @@ An object that handles registration of context providers and configuring handler
1212
export interface ContextSetup
1313
```
1414

15-
## Methods
16-
17-
| Method | Description |
18-
| --- | --- |
19-
| [createContextContainer()](./kibana-plugin-public.contextsetup.createcontextcontainer.md) | Creates a new [IContextContainer](./kibana-plugin-public.icontextcontainer.md) for a service owner. |
20-
2115
## Remarks
2216

2317
A [IContextContainer](./kibana-plugin-public.icontextcontainer.md) can be used by any Core service or plugin (known as the "service owner") which wishes to expose APIs in a handler function. The container object will manage registering context providers and configuring a handler with all of the contexts that should be exposed to the handler's plugin. This is dependent on the dependencies that the handler's plugin declares.
@@ -136,3 +130,9 @@ class VizRenderingPlugin {
136130

137131
```
138132

133+
## Methods
134+
135+
| Method | Description |
136+
| --- | --- |
137+
| [createContextContainer()](./kibana-plugin-public.contextsetup.createcontextcontainer.md) | Creates a new [IContextContainer](./kibana-plugin-public.icontextcontainer.md) for a service owner. |
138+

docs/development/core/public/kibana-plugin-public.icontextcontainer.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,6 @@ An object that handles registration of context providers and configuring handler
1212
export interface IContextContainer<THandler extends HandlerFunction<any>>
1313
```
1414

15-
## Methods
16-
17-
| Method | Description |
18-
| --- | --- |
19-
| [createHandler(pluginOpaqueId, handler)](./kibana-plugin-public.icontextcontainer.createhandler.md) | Create a new handler function pre-wired to context for the plugin. |
20-
| [registerContext(pluginOpaqueId, contextName, provider)](./kibana-plugin-public.icontextcontainer.registercontext.md) | Register a new context provider. |
21-
2215
## Remarks
2316

2417
A [IContextContainer](./kibana-plugin-public.icontextcontainer.md) can be used by any Core service or plugin (known as the "service owner") which wishes to expose APIs in a handler function. The container object will manage registering context providers and configuring a handler with all of the contexts that should be exposed to the handler's plugin. This is dependent on the dependencies that the handler's plugin declares.
@@ -78,3 +71,10 @@ class MyPlugin {
7871

7972
```
8073

74+
## Methods
75+
76+
| Method | Description |
77+
| --- | --- |
78+
| [createHandler(pluginOpaqueId, handler)](./kibana-plugin-public.icontextcontainer.createhandler.md) | Create a new handler function pre-wired to context for the plugin. |
79+
| [registerContext(pluginOpaqueId, contextName, provider)](./kibana-plugin-public.icontextcontainer.registercontext.md) | Register a new context provider. |
80+

docs/development/core/public/kibana-plugin-public.legacycoresetup.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ Setup interface exposed to the legacy platform via the `ui/new_platform` module.
1616
export interface LegacyCoreSetup extends CoreSetup<any>
1717
```
1818
19+
## Remarks
20+
21+
Some methods are not supported in the legacy platform and while present to make this type compatibile with [CoreSetup](./kibana-plugin-public.coresetup.md)<!-- -->, unsupported methods will throw exceptions when called.
22+
1923
## Properties
2024
2125
| Property | Type | Description |
2226
| --- | --- | --- |
2327
| [injectedMetadata](./kibana-plugin-public.legacycoresetup.injectedmetadata.md) | <code>InjectedMetadataSetup</code> | |
2428
25-
## Remarks
26-
27-
Some methods are not supported in the legacy platform and while present to make this type compatibile with [CoreSetup](./kibana-plugin-public.coresetup.md)<!-- -->, unsupported methods will throw exceptions when called.
28-

docs/development/core/public/kibana-plugin-public.legacycorestart.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ Start interface exposed to the legacy platform via the `ui/new_platform` module.
1616
export interface LegacyCoreStart extends CoreStart
1717
```
1818
19+
## Remarks
20+
21+
Some methods are not supported in the legacy platform and while present to make this type compatibile with [CoreStart](./kibana-plugin-public.corestart.md)<!-- -->, unsupported methods will throw exceptions when called.
22+
1923
## Properties
2024
2125
| Property | Type | Description |
2226
| --- | --- | --- |
2327
| [injectedMetadata](./kibana-plugin-public.legacycorestart.injectedmetadata.md) | <code>InjectedMetadataStart</code> | |
2428
25-
## Remarks
26-
27-
Some methods are not supported in the legacy platform and while present to make this type compatibile with [CoreStart](./kibana-plugin-public.corestart.md)<!-- -->, unsupported methods will throw exceptions when called.
28-

docs/development/core/public/kibana-plugin-public.savedobjectsclient.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ Saved Objects is Kibana's data persisentence mechanism allowing plugins to use E
1212
export declare class SavedObjectsClient
1313
```
1414

15+
## Remarks
16+
17+
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SavedObjectsClient` class.
18+
1519
## Properties
1620

1721
| Property | Modifiers | Type | Description |
@@ -30,7 +34,3 @@ export declare class SavedObjectsClient
3034
| [bulkUpdate(objects)](./kibana-plugin-public.savedobjectsclient.bulkupdate.md) | | Update multiple documents at once |
3135
| [update(type, id, attributes, { version, migrationVersion, references })](./kibana-plugin-public.savedobjectsclient.update.md) | | Updates an object |
3236

33-
## Remarks
34-
35-
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SavedObjectsClient` class.
36-

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ Access or manipulate the Kibana base path
1212
export declare class BasePath
1313
```
1414

15+
## Remarks
16+
17+
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BasePath` class.
18+
1519
## Properties
1620

1721
| Property | Modifiers | Type | Description |
@@ -22,7 +26,3 @@ export declare class BasePath
2226
| [serverBasePath](./kibana-plugin-server.basepath.serverbasepath.md) | | <code>string</code> | returns the server's basePath<!-- -->See [BasePath.get](./kibana-plugin-server.basepath.get.md) for getting the basePath value for a specific request |
2327
| [set](./kibana-plugin-server.basepath.set.md) | | <code>(request: KibanaRequest&lt;unknown, unknown, unknown, any&gt; &#124; LegacyRequest, requestSpecificBasePath: string) =&gt; void</code> | sets <code>basePath</code> value, specific for an incoming request. |
2428

25-
## Remarks
26-
27-
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BasePath` class.
28-

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,6 @@ See methods documentation for more detailed examples.
1414
export interface ConfigDeprecationFactory
1515
```
1616

17-
## Methods
18-
19-
| Method | Description |
20-
| --- | --- |
21-
| [rename(oldKey, newKey)](./kibana-plugin-server.configdeprecationfactory.rename.md) | Rename a configuration property from inside a plugin's configuration path. Will log a deprecation warning if the oldKey was found and deprecation applied. |
22-
| [renameFromRoot(oldKey, newKey)](./kibana-plugin-server.configdeprecationfactory.renamefromroot.md) | Rename a configuration property from the root configuration. Will log a deprecation warning if the oldKey was found and deprecation applied.<!-- -->This should be only used when renaming properties from different configuration's path. To rename properties from inside a plugin's configuration, use 'rename' instead. |
23-
| [unused(unusedKey)](./kibana-plugin-server.configdeprecationfactory.unused.md) | Remove a configuration property from inside a plugin's configuration path. Will log a deprecation warning if the unused key was found and deprecation applied. |
24-
| [unusedFromRoot(unusedKey)](./kibana-plugin-server.configdeprecationfactory.unusedfromroot.md) | Remove a configuration property from the root configuration. Will log a deprecation warning if the unused key was found and deprecation applied.<!-- -->This should be only used when removing properties from outside of a plugin's configuration. To remove properties from inside a plugin's configuration, use 'unused' instead. |
25-
2617
## Example
2718

2819

@@ -34,3 +25,12 @@ const provider: ConfigDeprecationProvider = ({ rename, unused }) => [
3425

3526
```
3627

28+
## Methods
29+
30+
| Method | Description |
31+
| --- | --- |
32+
| [rename(oldKey, newKey)](./kibana-plugin-server.configdeprecationfactory.rename.md) | Rename a configuration property from inside a plugin's configuration path. Will log a deprecation warning if the oldKey was found and deprecation applied. |
33+
| [renameFromRoot(oldKey, newKey)](./kibana-plugin-server.configdeprecationfactory.renamefromroot.md) | Rename a configuration property from the root configuration. Will log a deprecation warning if the oldKey was found and deprecation applied.<!-- -->This should be only used when renaming properties from different configuration's path. To rename properties from inside a plugin's configuration, use 'rename' instead. |
34+
| [unused(unusedKey)](./kibana-plugin-server.configdeprecationfactory.unused.md) | Remove a configuration property from inside a plugin's configuration path. Will log a deprecation warning if the unused key was found and deprecation applied. |
35+
| [unusedFromRoot(unusedKey)](./kibana-plugin-server.configdeprecationfactory.unusedfromroot.md) | Remove a configuration property from the root configuration. Will log a deprecation warning if the unused key was found and deprecation applied.<!-- -->This should be only used when removing properties from outside of a plugin's configuration. To remove properties from inside a plugin's configuration, use 'unused' instead. |
36+

0 commit comments

Comments
 (0)