Skip to content

Commit aa695ec

Browse files
mshustovelasticmachine
mshustov
and
elasticmachine
authored
Normalize EOL symbol in platform docs (elastic#56021)
* use api-extractor generate command with api-documenter config * update docs Co-authored-by: Elastic Machine <[email protected]>
1 parent 17011b7 commit aa695ec

File tree

1,061 files changed

+18928
-18921
lines changed

Some content is hidden

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

1,061 files changed

+18928
-18921
lines changed

‎api-documenter.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"newlineKind": "lf",
3+
"outputTarget": "markdown"
4+
}

‎docs/development/core/public/index.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md)
4-
5-
## API Reference
6-
7-
## Packages
8-
9-
| Package | Description |
10-
| --- | --- |
11-
| [kibana-plugin-public](./kibana-plugin-public.md) | The Kibana Core APIs for client-side plugins.<!-- -->A plugin's <code>public/index</code> file must contain a named import, <code>plugin</code>, that implements which returns an object that implements .<!-- -->The plugin integrates with the core system via lifecycle events: <code>setup</code>, <code>start</code>, and <code>stop</code>. In each lifecycle method, the plugin will receive the corresponding core services available (either or ) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked. |
12-
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md)
4+
5+
## API Reference
6+
7+
## Packages
8+
9+
| Package | Description |
10+
| --- | --- |
11+
| [kibana-plugin-public](./kibana-plugin-public.md) | The Kibana Core APIs for client-side plugins.<!-- -->A plugin's <code>public/index</code> file must contain a named import, <code>plugin</code>, that implements which returns an object that implements .<!-- -->The plugin integrates with the core system via lifecycle events: <code>setup</code>, <code>start</code>, and <code>stop</code>. In each lifecycle method, the plugin will receive the corresponding core services available (either or ) and any interfaces returned by dependency plugins' lifecycle method. Anything returned by the plugin's lifecycle method will be exposed to downstream dependencies when their corresponding lifecycle methods are invoked. |
12+

‎docs/development/core/public/kibana-plugin-public.app.approute.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [App](./kibana-plugin-public.app.md) &gt; [appRoute](./kibana-plugin-public.app.approute.md)
4-
5-
## App.appRoute property
6-
7-
Override the application's routing path from `/app/${id}`<!-- -->. Must be unique across registered applications. Should not include the base path from HTTP.
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
appRoute?: string;
13-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [App](./kibana-plugin-public.app.md) &gt; [appRoute](./kibana-plugin-public.app.approute.md)
4+
5+
## App.appRoute property
6+
7+
Override the application's routing path from `/app/${id}`<!-- -->. Must be unique across registered applications. Should not include the base path from HTTP.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
appRoute?: string;
13+
```

‎docs/development/core/public/kibana-plugin-public.app.chromeless.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [App](./kibana-plugin-public.app.md) &gt; [chromeless](./kibana-plugin-public.app.chromeless.md)
4-
5-
## App.chromeless property
6-
7-
Hide the UI chrome when the application is mounted. Defaults to `false`<!-- -->. Takes precedence over chrome service visibility settings.
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
chromeless?: boolean;
13-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [App](./kibana-plugin-public.app.md) &gt; [chromeless](./kibana-plugin-public.app.chromeless.md)
4+
5+
## App.chromeless property
6+
7+
Hide the UI chrome when the application is mounted. Defaults to `false`<!-- -->. Takes precedence over chrome service visibility settings.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
chromeless?: boolean;
13+
```

‎docs/development/core/public/kibana-plugin-public.app.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [App](./kibana-plugin-public.app.md)
4-
5-
## App interface
6-
7-
Extension of [common app properties](./kibana-plugin-public.appbase.md) with the mount function.
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
export interface App extends AppBase
13-
```
14-
15-
## Properties
16-
17-
| Property | Type | Description |
18-
| --- | --- | --- |
19-
| [appRoute](./kibana-plugin-public.app.approute.md) | <code>string</code> | Override the application's routing path from <code>/app/${id}</code>. Must be unique across registered applications. Should not include the base path from HTTP. |
20-
| [chromeless](./kibana-plugin-public.app.chromeless.md) | <code>boolean</code> | Hide the UI chrome when the application is mounted. Defaults to <code>false</code>. Takes precedence over chrome service visibility settings. |
21-
| [mount](./kibana-plugin-public.app.mount.md) | <code>AppMount &#124; AppMountDeprecated</code> | A mount function called when the user navigates to this app's route. May have signature of [AppMount](./kibana-plugin-public.appmount.md) or [AppMountDeprecated](./kibana-plugin-public.appmountdeprecated.md)<!-- -->. |
22-
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [App](./kibana-plugin-public.app.md)
4+
5+
## App interface
6+
7+
Extension of [common app properties](./kibana-plugin-public.appbase.md) with the mount function.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface App extends AppBase
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [appRoute](./kibana-plugin-public.app.approute.md) | <code>string</code> | Override the application's routing path from <code>/app/${id}</code>. Must be unique across registered applications. Should not include the base path from HTTP. |
20+
| [chromeless](./kibana-plugin-public.app.chromeless.md) | <code>boolean</code> | Hide the UI chrome when the application is mounted. Defaults to <code>false</code>. Takes precedence over chrome service visibility settings. |
21+
| [mount](./kibana-plugin-public.app.mount.md) | <code>AppMount &#124; AppMountDeprecated</code> | A mount function called when the user navigates to this app's route. May have signature of [AppMount](./kibana-plugin-public.appmount.md) or [AppMountDeprecated](./kibana-plugin-public.appmountdeprecated.md)<!-- -->. |
22+

‎docs/development/core/public/kibana-plugin-public.app.mount.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [App](./kibana-plugin-public.app.md) &gt; [mount](./kibana-plugin-public.app.mount.md)
4-
5-
## App.mount property
6-
7-
A mount function called when the user navigates to this app's route. May have signature of [AppMount](./kibana-plugin-public.appmount.md) or [AppMountDeprecated](./kibana-plugin-public.appmountdeprecated.md)<!-- -->.
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
mount: AppMount | AppMountDeprecated;
13-
```
14-
15-
## Remarks
16-
17-
When function has two arguments, it will be called with a [context](./kibana-plugin-public.appmountcontext.md) as the first argument. This behavior is \*\*deprecated\*\*, and consumers should instead use [CoreSetup.getStartServices()](./kibana-plugin-public.coresetup.getstartservices.md)<!-- -->.
18-
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [App](./kibana-plugin-public.app.md) &gt; [mount](./kibana-plugin-public.app.mount.md)
4+
5+
## App.mount property
6+
7+
A mount function called when the user navigates to this app's route. May have signature of [AppMount](./kibana-plugin-public.appmount.md) or [AppMountDeprecated](./kibana-plugin-public.appmountdeprecated.md)<!-- -->.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
mount: AppMount | AppMountDeprecated;
13+
```
14+
15+
## Remarks
16+
17+
When function has two arguments, it will be called with a [context](./kibana-plugin-public.appmountcontext.md) as the first argument. This behavior is \*\*deprecated\*\*, and consumers should instead use [CoreSetup.getStartServices()](./kibana-plugin-public.coresetup.getstartservices.md)<!-- -->.
18+

‎docs/development/core/public/kibana-plugin-public.appbase.capabilities.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [capabilities](./kibana-plugin-public.appbase.capabilities.md)
4-
5-
## AppBase.capabilities property
6-
7-
Custom capabilities defined by the app.
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
capabilities?: Partial<Capabilities>;
13-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [capabilities](./kibana-plugin-public.appbase.capabilities.md)
4+
5+
## AppBase.capabilities property
6+
7+
Custom capabilities defined by the app.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
capabilities?: Partial<Capabilities>;
13+
```

‎docs/development/core/public/kibana-plugin-public.appbase.category.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [category](./kibana-plugin-public.appbase.category.md)
4-
5-
## AppBase.category property
6-
7-
The category definition of the product See [AppCategory](./kibana-plugin-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
category?: AppCategory;
13-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [category](./kibana-plugin-public.appbase.category.md)
4+
5+
## AppBase.category property
6+
7+
The category definition of the product See [AppCategory](./kibana-plugin-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
category?: AppCategory;
13+
```

‎docs/development/core/public/kibana-plugin-public.appbase.chromeless.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [chromeless](./kibana-plugin-public.appbase.chromeless.md)
4-
5-
## AppBase.chromeless property
6-
7-
Hide the UI chrome when the application is mounted. Defaults to `false`<!-- -->. Takes precedence over chrome service visibility settings.
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
chromeless?: boolean;
13-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [chromeless](./kibana-plugin-public.appbase.chromeless.md)
4+
5+
## AppBase.chromeless property
6+
7+
Hide the UI chrome when the application is mounted. Defaults to `false`<!-- -->. Takes precedence over chrome service visibility settings.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
chromeless?: boolean;
13+
```

‎docs/development/core/public/kibana-plugin-public.appbase.euiicontype.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [euiIconType](./kibana-plugin-public.appbase.euiicontype.md)
4-
5-
## AppBase.euiIconType property
6-
7-
A EUI iconType that will be used for the app's icon. This icon takes precendence over the `icon` property.
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
euiIconType?: string;
13-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [euiIconType](./kibana-plugin-public.appbase.euiicontype.md)
4+
5+
## AppBase.euiIconType property
6+
7+
A EUI iconType that will be used for the app's icon. This icon takes precendence over the `icon` property.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
euiIconType?: string;
13+
```

‎docs/development/core/public/kibana-plugin-public.appbase.icon.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [icon](./kibana-plugin-public.appbase.icon.md)
4-
5-
## AppBase.icon property
6-
7-
A URL to an image file used as an icon. Used as a fallback if `euiIconType` is not provided.
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
icon?: string;
13-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [icon](./kibana-plugin-public.appbase.icon.md)
4+
5+
## AppBase.icon property
6+
7+
A URL to an image file used as an icon. Used as a fallback if `euiIconType` is not provided.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
icon?: string;
13+
```

‎docs/development/core/public/kibana-plugin-public.appbase.id.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [id](./kibana-plugin-public.appbase.id.md)
4-
5-
## AppBase.id property
6-
7-
The unique identifier of the application
8-
9-
<b>Signature:</b>
10-
11-
```typescript
12-
id: string;
13-
```
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md) &gt; [id](./kibana-plugin-public.appbase.id.md)
4+
5+
## AppBase.id property
6+
7+
The unique identifier of the application
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
id: string;
13+
```

‎docs/development/core/public/kibana-plugin-public.appbase.md

+30-30
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2-
3-
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md)
4-
5-
## AppBase interface
6-
7-
8-
<b>Signature:</b>
9-
10-
```typescript
11-
export interface AppBase
12-
```
13-
14-
## Properties
15-
16-
| Property | Type | Description |
17-
| --- | --- | --- |
18-
| [capabilities](./kibana-plugin-public.appbase.capabilities.md) | <code>Partial&lt;Capabilities&gt;</code> | Custom capabilities defined by the app. |
19-
| [category](./kibana-plugin-public.appbase.category.md) | <code>AppCategory</code> | The category definition of the product See [AppCategory](./kibana-plugin-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference |
20-
| [chromeless](./kibana-plugin-public.appbase.chromeless.md) | <code>boolean</code> | Hide the UI chrome when the application is mounted. Defaults to <code>false</code>. Takes precedence over chrome service visibility settings. |
21-
| [euiIconType](./kibana-plugin-public.appbase.euiicontype.md) | <code>string</code> | A EUI iconType that will be used for the app's icon. This icon takes precendence over the <code>icon</code> property. |
22-
| [icon](./kibana-plugin-public.appbase.icon.md) | <code>string</code> | A URL to an image file used as an icon. Used as a fallback if <code>euiIconType</code> is not provided. |
23-
| [id](./kibana-plugin-public.appbase.id.md) | <code>string</code> | The unique identifier of the application |
24-
| [navLinkStatus](./kibana-plugin-public.appbase.navlinkstatus.md) | <code>AppNavLinkStatus</code> | The initial status of the application's navLink. Defaulting to <code>visible</code> if <code>status</code> is <code>accessible</code> and <code>hidden</code> if status is <code>inaccessible</code> See [AppNavLinkStatus](./kibana-plugin-public.appnavlinkstatus.md) |
25-
| [order](./kibana-plugin-public.appbase.order.md) | <code>number</code> | An ordinal used to sort nav links relative to one another for display. |
26-
| [status](./kibana-plugin-public.appbase.status.md) | <code>AppStatus</code> | The initial status of the application. Defaulting to <code>accessible</code> |
27-
| [title](./kibana-plugin-public.appbase.title.md) | <code>string</code> | The title of the application. |
28-
| [tooltip](./kibana-plugin-public.appbase.tooltip.md) | <code>string</code> | A tooltip shown when hovering over app link. |
29-
| [updater$](./kibana-plugin-public.appbase.updater_.md) | <code>Observable&lt;AppUpdater&gt;</code> | An [AppUpdater](./kibana-plugin-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-public.appupdatablefields.md) at runtime. |
30-
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [AppBase](./kibana-plugin-public.appbase.md)
4+
5+
## AppBase interface
6+
7+
8+
<b>Signature:</b>
9+
10+
```typescript
11+
export interface AppBase
12+
```
13+
14+
## Properties
15+
16+
| Property | Type | Description |
17+
| --- | --- | --- |
18+
| [capabilities](./kibana-plugin-public.appbase.capabilities.md) | <code>Partial&lt;Capabilities&gt;</code> | Custom capabilities defined by the app. |
19+
| [category](./kibana-plugin-public.appbase.category.md) | <code>AppCategory</code> | The category definition of the product See [AppCategory](./kibana-plugin-public.appcategory.md) See DEFAULT\_APP\_CATEGORIES for more reference |
20+
| [chromeless](./kibana-plugin-public.appbase.chromeless.md) | <code>boolean</code> | Hide the UI chrome when the application is mounted. Defaults to <code>false</code>. Takes precedence over chrome service visibility settings. |
21+
| [euiIconType](./kibana-plugin-public.appbase.euiicontype.md) | <code>string</code> | A EUI iconType that will be used for the app's icon. This icon takes precendence over the <code>icon</code> property. |
22+
| [icon](./kibana-plugin-public.appbase.icon.md) | <code>string</code> | A URL to an image file used as an icon. Used as a fallback if <code>euiIconType</code> is not provided. |
23+
| [id](./kibana-plugin-public.appbase.id.md) | <code>string</code> | The unique identifier of the application |
24+
| [navLinkStatus](./kibana-plugin-public.appbase.navlinkstatus.md) | <code>AppNavLinkStatus</code> | The initial status of the application's navLink. Defaulting to <code>visible</code> if <code>status</code> is <code>accessible</code> and <code>hidden</code> if status is <code>inaccessible</code> See [AppNavLinkStatus](./kibana-plugin-public.appnavlinkstatus.md) |
25+
| [order](./kibana-plugin-public.appbase.order.md) | <code>number</code> | An ordinal used to sort nav links relative to one another for display. |
26+
| [status](./kibana-plugin-public.appbase.status.md) | <code>AppStatus</code> | The initial status of the application. Defaulting to <code>accessible</code> |
27+
| [title](./kibana-plugin-public.appbase.title.md) | <code>string</code> | The title of the application. |
28+
| [tooltip](./kibana-plugin-public.appbase.tooltip.md) | <code>string</code> | A tooltip shown when hovering over app link. |
29+
| [updater$](./kibana-plugin-public.appbase.updater_.md) | <code>Observable&lt;AppUpdater&gt;</code> | An [AppUpdater](./kibana-plugin-public.appupdater.md) observable that can be used to update the application [AppUpdatableFields](./kibana-plugin-public.appupdatablefields.md) at runtime. |
30+

0 commit comments

Comments
 (0)