github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

Support owner and description attributes inside the Manifest file, use in API docs (#101786) (#101841)

Browse source 
* Support owner and description in manifest file, add to mdx output for each plugin

* Update parse_kibana_platform_plugin.ts

* edit a couple kibana.jsons

* Update write_plugin_mdx_docs.ts

* update api docs

* Update core server manifest plugin types

* update core docs

* Fix type_check failure

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Stacey Gammon 2021-06-10 15:18:24 -04:00 • committed by GitHub
parent 91db79e446
commit d2ee3daa6d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
121 changed files with 1959 additions and 309 deletions
Download patch file Download diff file Expand all files Collapse all files

10
api_docs/actions.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import actionsObj from './actions.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 116 | 0 | 116 | 7 |
## Server
### Setup

10
api_docs/advanced_settings.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import advancedSettingsObj from './advanced_settings.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 23 | 0 | 22 | 1 |
## Client
### Setup

10
api_docs/alerting.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import alertingObj from './alerting.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 213 | 0 | 213 | 15 |
## Client
### Setup

10
api_docs/apm.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import apmObj from './apm.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 37 | 0 | 37 | 30 |
## Client
### Setup

10
api_docs/apm_oss.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import apmOssObj from './apm_oss.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 4 | 0 | 4 | 0 |
## Server
### Setup

10
api_docs/banners.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import bannersObj from './banners.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 9 | 0 | 9 | 0 |
## Common
### Interfaces

10
api_docs/bfetch.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import bfetchObj from './bfetch.json';
Considering using bfetch capabilities when fetching large amounts of data. This services supports batching HTTP requests and streaming responses back.
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 73 | 1 | 62 | 2 |
## Client
### Start

10
api_docs/canvas.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import canvasObj from './canvas.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 6 | 0 | 5 | 3 |
## Client
### Setup

10
api_docs/cases.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import casesObj from './cases.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 406 | 0 | 381 | 13 |
## Client
### Start

10
api_docs/charts.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import chartsObj from './charts.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 190 | 2 | 159 | 1 |
## Client
### Start

10
api_docs/cloud.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import cloudObj from './cloud.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 20 | 0 | 20 | 0 |
## Client
### Setup

10
api_docs/console.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import consoleObj from './console.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2 | 0 | 2 | 0 |
## Server
### Setup

10
api_docs/core.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import coreObj from './core.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2273 | 148 | 1052 | 26 |
## Client
### Classes

10
api_docs/core_application.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import coreApplicationObj from './core_application.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2273 | 148 | 1052 | 26 |
## Client
### Classes

10
api_docs/core_chrome.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import coreChromeObj from './core_chrome.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2273 | 148 | 1052 | 26 |
## Client
### Interfaces

10
api_docs/core_http.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import coreHttpObj from './core_http.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2273 | 148 | 1052 | 26 |
## Client
### Interfaces

10
api_docs/core_saved_objects.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import coreSavedObjectsObj from './core_saved_objects.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2273 | 148 | 1052 | 26 |
## Client
### Classes

10
api_docs/dashboard.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import dashboardObj from './dashboard.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 145 | 1 | 133 | 9 |
## Client
### Setup

10
api_docs/dashboard_enhanced.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import dashboardEnhancedObj from './dashboard_enhanced.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 51 | 0 | 50 | 0 |
## Client
### Setup

10
api_docs/dashboard_mode.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import dashboardModeObj from './dashboard_mode.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 11 | 0 | 11 | 0 |
## Server
### Classes

140
api_docs/data.json
View file

@ -12447,34 +12447,6 @@
"lineNumber": 222
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.ts",
"lineNumber": 11
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.ts",
"lineNumber": 16
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/page.tsx",
"lineNumber": 25
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/page.tsx",
"lineNumber": 162
}
},
{
"plugin": "infra",
"link": {
@ -12951,6 +12923,20 @@
"lineNumber": 11
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.ts",
"lineNumber": 11
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.ts",
"lineNumber": 16
}
},
{
"plugin": "ml",
"link": {
@ -15862,20 +15848,6 @@
"lineNumber": 11
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/actions_panel/actions_panel.tsx",
"lineNumber": 25
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/actions_panel/actions_panel.tsx",
"lineNumber": 28
}
},
{
"plugin": "infra",
"link": {
@ -16485,48 +16457,6 @@
"lineNumber": 57
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts",
"lineNumber": 14
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts",
"lineNumber": 27
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts",
"lineNumber": 213
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts",
"lineNumber": 234
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/actions.ts",
"lineNumber": 12
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/actions.ts",
"lineNumber": 17
}
},
{
"plugin": "observability",
"link": {
@ -34667,34 +34597,6 @@
"lineNumber": 222
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.ts",
"lineNumber": 11
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.ts",
"lineNumber": 16
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/page.tsx",
"lineNumber": 25
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/page.tsx",
"lineNumber": 162
}
},
{
"plugin": "infra",
"link": {
@ -35171,6 +35073,20 @@
"lineNumber": 11
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.ts",
"lineNumber": 11
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.ts",
"lineNumber": 16
}
},
{
"plugin": "ml",
"link": {

10
api_docs/data.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import dataObj from './data.json';
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3809 | 107 | 3257 | 75 |
## Client
### Setup

10
api_docs/data_autocomplete.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import dataAutocompleteObj from './data_autocomplete.json';
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3809 | 107 | 3257 | 75 |
## Client
### Interfaces

10
api_docs/data_enhanced.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import dataEnhancedObj from './data_enhanced.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 16 | 0 | 16 | 2 |
## Client
### Start

10
api_docs/data_field_formats.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import dataFieldFormatsObj from './data_field_formats.json';
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3809 | 107 | 3257 | 75 |
## Client
### Consts, variables and types

98
api_docs/data_index_patterns.json
View file

@ -6220,34 +6220,6 @@
"lineNumber": 222
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.ts",
"lineNumber": 11
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.ts",
"lineNumber": 16
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/page.tsx",
"lineNumber": 25
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/page.tsx",
"lineNumber": 162
}
},
{
"plugin": "infra",
"link": {
@ -6724,6 +6696,20 @@
"lineNumber": 11
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.ts",
"lineNumber": 11
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/util/field_types_utils.ts",
"lineNumber": 16
}
},
{
"plugin": "ml",
"link": {
@ -9635,20 +9621,6 @@
"lineNumber": 11
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/actions_panel/actions_panel.tsx",
"lineNumber": 25
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/actions_panel/actions_panel.tsx",
"lineNumber": 28
}
},
{
"plugin": "infra",
"link": {
@ -10258,48 +10230,6 @@
"lineNumber": 57
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts",
"lineNumber": 14
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts",
"lineNumber": 27
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts",
"lineNumber": 213
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts",
"lineNumber": 234
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/actions.ts",
"lineNumber": 12
}
},
{
"plugin": "ml",
"link": {
"path": "x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/actions.ts",
"lineNumber": 17
}
},
{
"plugin": "observability",
"link": {

10
api_docs/data_index_patterns.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import dataIndexPatternsObj from './data_index_patterns.json';
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3809 | 107 | 3257 | 75 |
## Server
### Functions

10
api_docs/data_query.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import dataQueryObj from './data_query.json';
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3809 | 107 | 3257 | 75 |
## Client
### Functions

10
api_docs/data_search.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import dataSearchObj from './data_search.json';
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3809 | 107 | 3257 | 75 |
## Client
### Functions

10
api_docs/data_ui.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import dataUiObj from './data_ui.json';
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3809 | 107 | 3257 | 75 |
## Client
### Functions

724
api_docs/data_visualizer.json
View file

@ -3,7 +3,69 @@
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"interfaces": [
{
"parentPluginId": "dataVisualizer",
"id": "def-public.IndexDataVisualizerViewProps",
"type": "Interface",
"tags": [],
"label": "IndexDataVisualizerViewProps",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx",
"lineNumber": 119
},
"deprecated": false,
"children": [
{
"parentPluginId": "dataVisualizer",
"id": "def-public.IndexDataVisualizerViewProps.currentIndexPattern",
"type": "Object",
"tags": [],
"label": "currentIndexPattern",
"description": [],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"source": {
"path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx",
"lineNumber": 120
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-public.IndexDataVisualizerViewProps.currentSavedSearch",
"type": "CompoundType",
"tags": [],
"label": "currentSavedSearch",
"description": [],
"signature": [
{
"pluginId": "dataVisualizer",
"scope": "common",
"docId": "kibDataVisualizerPluginApi",
"section": "def-common.SavedSearchSavedObject",
"text": "SavedSearchSavedObject"
},
" | null"
],
"source": {
"path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx",
"lineNumber": 121
},
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
@ -15,11 +77,11 @@
"label": "DataVisualizerPluginStart",
"description": [],
"signature": [
"{ getFileDataVisualizerComponent: () => Promise<React.FC<{}>>; getMaxBytesFormatted: () => string; }"
"{ getFileDataVisualizerComponent: () => Promise<React.FC<{}>>; getIndexDataVisualizerComponent: () => Promise<React.FC<{}>>; getMaxBytesFormatted: () => string; }"
],
"source": {
"path": "x-pack/plugins/data_visualizer/public/plugin.ts",
"lineNumber": 33
"lineNumber": 38
},
"deprecated": false,
"lifecycle": "start",
@ -46,8 +108,8 @@
"label": "DataVisualizerTableState",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types.ts",
"lineNumber": 14
"path": "x-pack/plugins/data_visualizer/common/types/index.ts",
"lineNumber": 19
},
"deprecated": false,
"children": [
@ -59,8 +121,8 @@
"label": "pageSize",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types.ts",
"lineNumber": 15
"path": "x-pack/plugins/data_visualizer/common/types/index.ts",
"lineNumber": 20
},
"deprecated": false
},
@ -72,8 +134,8 @@
"label": "pageIndex",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types.ts",
"lineNumber": 16
"path": "x-pack/plugins/data_visualizer/common/types/index.ts",
"lineNumber": 21
},
"deprecated": false
},
@ -85,8 +147,8 @@
"label": "sortField",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types.ts",
"lineNumber": 17
"path": "x-pack/plugins/data_visualizer/common/types/index.ts",
"lineNumber": 22
},
"deprecated": false
},
@ -98,8 +160,8 @@
"label": "sortDirection",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types.ts",
"lineNumber": 18
"path": "x-pack/plugins/data_visualizer/common/types/index.ts",
"lineNumber": 23
},
"deprecated": false
},
@ -114,8 +176,8 @@
"string[]"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types.ts",
"lineNumber": 19
"path": "x-pack/plugins/data_visualizer/common/types/index.ts",
"lineNumber": 24
},
"deprecated": false
},
@ -130,8 +192,8 @@
"string[]"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types.ts",
"lineNumber": 20
"path": "x-pack/plugins/data_visualizer/common/types/index.ts",
"lineNumber": 25
},
"deprecated": false
},
@ -143,8 +205,579 @@
"label": "showDistributions",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types.ts",
"lineNumber": 21
"path": "x-pack/plugins/data_visualizer/common/types/index.ts",
"lineNumber": 26
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.DocumentCountBuckets",
"type": "Interface",
"tags": [],
"label": "DocumentCountBuckets",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 22
},
"deprecated": false,
"children": [
{
"parentPluginId": "dataVisualizer",
"id": "def-common.DocumentCountBuckets.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 23
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.DocumentCounts",
"type": "Interface",
"tags": [],
"label": "DocumentCounts",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 26
},
"deprecated": false,
"children": [
{
"parentPluginId": "dataVisualizer",
"id": "def-common.DocumentCounts.buckets",
"type": "Object",
"tags": [],
"label": "buckets",
"description": [],
"signature": [
{
"pluginId": "dataVisualizer",
"scope": "common",
"docId": "kibDataVisualizerPluginApi",
"section": "def-common.DocumentCountBuckets",
"text": "DocumentCountBuckets"
},
" | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 27
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.DocumentCounts.interval",
"type": "number",
"tags": [],
"label": "interval",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 28
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldRequestConfig",
"type": "Interface",
"tags": [],
"label": "FieldRequestConfig",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 16
},
"deprecated": false,
"children": [
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldRequestConfig.fieldName",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 17
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldRequestConfig.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"number\" | \"boolean\" | \"date\" | \"keyword\" | \"text\" | \"ip\" | \"geo_point\" | \"geo_shape\" | \"unknown\""
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 18
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldRequestConfig.cardinality",
"type": "number",
"tags": [],
"label": "cardinality",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 19
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats",
"type": "Interface",
"tags": [],
"label": "FieldVisStats",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 31
},
"deprecated": false,
"children": [
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.cardinality",
"type": "number",
"tags": [],
"label": "cardinality",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 32
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 33
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.sampleCount",
"type": "number",
"tags": [],
"label": "sampleCount",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 34
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.trueCount",
"type": "number",
"tags": [],
"label": "trueCount",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 35
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.falseCount",
"type": "number",
"tags": [],
"label": "falseCount",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 36
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.earliest",
"type": "number",
"tags": [],
"label": "earliest",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 37
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.latest",
"type": "number",
"tags": [],
"label": "latest",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 38
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.documentCounts",
"type": "Object",
"tags": [],
"label": "documentCounts",
"description": [],
"signature": [
"{ buckets?: ",
{
"pluginId": "dataVisualizer",
"scope": "common",
"docId": "kibDataVisualizerPluginApi",
"section": "def-common.DocumentCountBuckets",
"text": "DocumentCountBuckets"
},
" | undefined; interval?: number | undefined; } | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 39
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.avg",
"type": "number",
"tags": [],
"label": "avg",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 43
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.distribution",
"type": "Object",
"tags": [],
"label": "distribution",
"description": [],
"signature": [
"{ percentiles: ",
{
"pluginId": "dataVisualizer",
"scope": "common",
"docId": "kibDataVisualizerPluginApi",
"section": "def-common.Percentile",
"text": "Percentile"
},
"[]; maxPercentile: number; minPercentile: 0; } | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 44
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.fieldName",
"type": "string",
"tags": [],
"label": "fieldName",
"description": [],
"signature": [
"string | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 49
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.isTopValuesSampled",
"type": "CompoundType",
"tags": [],
"label": "isTopValuesSampled",
"description": [],
"signature": [
"boolean | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 50
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.max",
"type": "number",
"tags": [],
"label": "max",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 51
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.median",
"type": "number",
"tags": [],
"label": "median",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 52
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.min",
"type": "number",
"tags": [],
"label": "min",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 53
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.topValues",
"type": "Array",
"tags": [],
"label": "topValues",
"description": [],
"signature": [
"{ key: React.ReactText; doc_count: number; }[] | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 54
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.topValuesSampleSize",
"type": "number",
"tags": [],
"label": "topValuesSampleSize",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 55
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.topValuesSamplerShardSize",
"type": "number",
"tags": [],
"label": "topValuesSamplerShardSize",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 56
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.examples",
"type": "Array",
"tags": [],
"label": "examples",
"description": [],
"signature": [
"(string | object)[] | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 57
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.timeRangeEarliest",
"type": "number",
"tags": [],
"label": "timeRangeEarliest",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 58
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.FieldVisStats.timeRangeLatest",
"type": "number",
"tags": [],
"label": "timeRangeLatest",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 59
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.Percentile",
"type": "Interface",
"tags": [],
"label": "Percentile",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 10
},
"deprecated": false,
"children": [
{
"parentPluginId": "dataVisualizer",
"id": "def-common.Percentile.percent",
"type": "number",
"tags": [],
"label": "percent",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 11
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.Percentile.minValue",
"type": "number",
"tags": [],
"label": "minValue",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 12
},
"deprecated": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.Percentile.maxValue",
"type": "number",
"tags": [],
"label": "maxValue",
"description": [],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/field_request_config.ts",
"lineNumber": 13
},
"deprecated": false
}
@ -216,8 +849,8 @@
"any[]"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types.ts",
"lineNumber": 10
"path": "x-pack/plugins/data_visualizer/common/types/index.ts",
"lineNumber": 17
},
"deprecated": false,
"initialIsOpen": false
@ -230,11 +863,11 @@
"label": "JobFieldType",
"description": [],
"signature": [
"\"number\" | \"boolean\" | \"date\" | \"text\" | \"keyword\" | \"ip\" | \"geo_point\" | \"geo_shape\" | \"unknown\""
"\"number\" | \"boolean\" | \"date\" | \"keyword\" | \"text\" | \"ip\" | \"geo_point\" | \"geo_shape\" | \"unknown\""
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types.ts",
"lineNumber": 12
"path": "x-pack/plugins/data_visualizer/common/types/job_field_type.ts",
"lineNumber": 9
},
"deprecated": false,
"initialIsOpen": false
@ -287,6 +920,47 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.OMIT_FIELDS",
"type": "Array",
"tags": [],
"label": "OMIT_FIELDS",
"description": [],
"signature": [
"string[]"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/constants.ts",
"lineNumber": 33
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.SavedSearchSavedObject",
"type": "Type",
"tags": [],
"label": "SavedSearchSavedObject",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-public.SimpleSavedObject",
"text": "SimpleSavedObject"
},
"<any>"
],
"source": {
"path": "x-pack/plugins/data_visualizer/common/types/index.ts",
"lineNumber": 29
},
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "dataVisualizer",
"id": "def-common.UI_SETTING_MAX_FILE_SIZE",
@ -325,4 +999,4 @@
}
]
}
}
}

33
api_docs/data_visualizer.mdx
View file

@ -1,29 +1,42 @@
---
id: kibFileDataVisualizerPluginApi
slug: /kibana-dev-docs/fileDataVisualizerPluginApi
title: fileDataVisualizer
id: kibDataVisualizerPluginApi
slug: /kibana-dev-docs/dataVisualizerPluginApi
title: dataVisualizer
image: https://source.unsplash.com/400x175/?github
summary: API docs for the fileDataVisualizer plugin
summary: API docs for the dataVisualizer plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileDataVisualizer']
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import fileDataVisualizerObj from './file_data_visualizer.json';
import dataVisualizerObj from './data_visualizer.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 59 | 1 | 59 | 0 |
## Client
### Start
<DocDefinitionList data={[fileDataVisualizerObj.client.start]}/>
<DocDefinitionList data={[dataVisualizerObj.client.start]}/>
### Interfaces
<DocDefinitionList data={dataVisualizerObj.client.interfaces}/>
## Common
### Objects
<DocDefinitionList data={fileDataVisualizerObj.common.objects}/>
<DocDefinitionList data={dataVisualizerObj.common.objects}/>
### Interfaces
<DocDefinitionList data={fileDataVisualizerObj.common.interfaces}/>
<DocDefinitionList data={dataVisualizerObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={fileDataVisualizerObj.common.misc}/>
<DocDefinitionList data={dataVisualizerObj.common.misc}/>

22
api_docs/deprecations.mdx
View file

@ -1250,8 +1250,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [utils.d.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/components/custom_url_editor/utils.d.ts#L37) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [edit_utils.d.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/edit_utils.d.ts#L8) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [edit_utils.d.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/edit_utils.d.ts#L11) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [actions_panel.tsx#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/actions_panel/actions_panel.tsx#L25) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [actions_panel.tsx#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/actions_panel/actions_panel.tsx#L28) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [new_job_utils.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/new_job/utils/new_job_utils.ts#L11) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [new_job_utils.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/new_job/utils/new_job_utils.ts#L34) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [exploration_query_bar.tsx#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/exploration_query_bar/exploration_query_bar.tsx#L14) | - |
@ -1260,12 +1258,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [editor.tsx#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/components/custom_url_editor/editor.tsx#L62) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [custom_urls.tsx#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/tabs/custom_urls.tsx#L40) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [custom_urls.tsx#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/tabs/custom_urls.tsx#L57) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [lens_utils.ts#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts#L14) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [lens_utils.ts#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts#L27) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [lens_utils.ts#L213](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts#L213) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [lens_utils.ts#L234](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts#L234) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [actions.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/actions.ts#L12) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [actions.ts#L17](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/actions.ts#L17) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [explorer_query_bar.tsx#L17](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/explorer/components/explorer_query_bar/explorer_query_bar.tsx#L17) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [explorer_query_bar.tsx#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/explorer/components/explorer_query_bar/explorer_query_bar.tsx#L31) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [explorer_query_bar.tsx#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/explorer/components/explorer_query_bar/explorer_query_bar.tsx#L100) | - |
@ -1275,8 +1267,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [common.ts#L222](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/data_grid/common.ts#L222) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [field_types_utils.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.ts#L11) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [field_types_utils.ts#L16](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.ts#L16) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [page.tsx#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/page.tsx#L25) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [page.tsx#L162](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/page.tsx#L162) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [field_types_utils.test.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.test.ts#L8) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [field_types_utils.test.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.test.ts#L19) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [field_types_utils.test.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.test.ts#L40) | - |
@ -1286,8 +1276,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [common.ts#L222](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/data_grid/common.ts#L222) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [field_types_utils.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.ts#L11) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [field_types_utils.ts#L16](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.ts#L16) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [page.tsx#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/page.tsx#L25) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [page.tsx#L162](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/page.tsx#L162) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [field_types_utils.test.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.test.ts#L8) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [field_types_utils.test.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.test.ts#L19) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [field_types_utils.test.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.test.ts#L40) | - |
@ -1316,8 +1304,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [utils.d.ts#L37](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/components/custom_url_editor/utils.d.ts#L37) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [edit_utils.d.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/edit_utils.d.ts#L8) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [edit_utils.d.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/edit_utils.d.ts#L11) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [actions_panel.tsx#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/actions_panel/actions_panel.tsx#L25) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [actions_panel.tsx#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/actions_panel/actions_panel.tsx#L28) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [new_job_utils.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/new_job/utils/new_job_utils.ts#L11) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [new_job_utils.ts#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/new_job/utils/new_job_utils.ts#L34) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [exploration_query_bar.tsx#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/data_frame_analytics/pages/analytics_exploration/components/exploration_query_bar/exploration_query_bar.tsx#L14) | - |
@ -1326,12 +1312,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [editor.tsx#L62](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/components/custom_url_editor/editor.tsx#L62) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [custom_urls.tsx#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/tabs/custom_urls.tsx#L40) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [custom_urls.tsx#L57](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/jobs/jobs_list/components/edit_job_flyout/tabs/custom_urls.tsx#L57) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [lens_utils.ts#L14](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts#L14) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [lens_utils.ts#L27](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts#L27) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [lens_utils.ts#L213](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts#L213) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [lens_utils.ts#L234](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/lens_utils.ts#L234) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [actions.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/actions.ts#L12) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [actions.ts#L17](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/components/field_data_row/action_menu/actions.ts#L17) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [explorer_query_bar.tsx#L17](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/explorer/components/explorer_query_bar/explorer_query_bar.tsx#L17) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [explorer_query_bar.tsx#L31](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/explorer/components/explorer_query_bar/explorer_query_bar.tsx#L31) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [explorer_query_bar.tsx#L100](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/explorer/components/explorer_query_bar/explorer_query_bar.tsx#L100) | - |
@ -1341,8 +1321,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [common.ts#L222](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/components/data_grid/common.ts#L222) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [field_types_utils.ts#L11](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.ts#L11) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [field_types_utils.ts#L16](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.ts#L16) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [page.tsx#L25](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/page.tsx#L25) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [page.tsx#L162](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/datavisualizer/index_based/page.tsx#L162) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [field_types_utils.test.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.test.ts#L8) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [field_types_utils.test.ts#L19](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.test.ts#L19) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [field_types_utils.test.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/ml/public/application/util/field_types_utils.test.ts#L40) | - |

10
api_docs/dev_tools.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import devToolsObj from './dev_tools.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 10 | 0 | 8 | 2 |
## Client
### Setup

10
api_docs/discover.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import discoverObj from './discover.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 64 | 0 | 51 | 6 |
## Client
### Setup

10
api_docs/discover_enhanced.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import discoverEnhancedObj from './discover_enhanced.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 39 | 0 | 37 | 2 |
## Client
### Classes

10
api_docs/embeddable.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import embeddableObj from './embeddable.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 449 | 4 | 379 | 3 |
## Client
### Setup

10
api_docs/embeddable_enhanced.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import embeddableEnhancedObj from './embeddable_enhanced.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 14 | 0 | 14 | 0 |
## Client
### Setup

10
api_docs/encrypted_saved_objects.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import encryptedSavedObjectsObj from './encrypted_saved_objects.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 30 | 0 | 28 | 3 |
## Server
### Setup

10
api_docs/enterprise_search.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import enterpriseSearchObj from './enterprise_search.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2 | 0 | 2 | 0 |
## Server
### Objects

10
api_docs/es_ui_shared.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import esUiSharedObj from './es_ui_shared.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 88 | 4 | 86 | 1 |
## Client
### Objects

10
api_docs/event_log.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import eventLogObj from './event_log.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 70 | 0 | 70 | 4 |
## Server
### Setup

10
api_docs/expressions.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import expressionsObj from './expressions.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 1871 | 57 | 1444 | 5 |
## Client
### Setup

10
api_docs/features.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import featuresObj from './features.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 215 | 0 | 97 | 2 |
## Client
### Setup

10
api_docs/file_upload.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import fileUploadObj from './file_upload.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 128 | 4 | 128 | 1 |
## Client
### Start

10
api_docs/fleet.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import fleetObj from './fleet.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 1071 | 15 | 981 | 8 |
## Client
### Setup

10
api_docs/global_search.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import globalSearchObj from './global_search.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 68 | 0 | 14 | 5 |
## Client
### Setup

10
api_docs/home.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import homeObj from './home.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 89 | 0 | 65 | 5 |
## Client
### Setup

10
api_docs/index_lifecycle_management.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import indexLifecycleManagementObj from './index_lifecycle_management.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 5 | 0 | 5 | 0 |
## Client
### Interfaces

10
api_docs/index_management.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import indexManagementObj from './index_management.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 162 | 12 | 157 | 3 |
## Client
### Functions

10
api_docs/index_pattern_field_editor.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import indexPatternFieldEditorObj from './index_pattern_field_editor.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 31 | 1 | 29 | 4 |
## Client
### Start

10
api_docs/index_pattern_management.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import indexPatternManagementObj from './index_pattern_management.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 46 | 0 | 46 | 4 |
## Client
### Setup

10
api_docs/infra.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import infraObj from './infra.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 23 | 0 | 20 | 4 |
## Client
### Objects

10
api_docs/ingest_pipelines.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import ingestPipelinesObj from './ingest_pipelines.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 9 | 0 | 9 | 4 |
## Client
### Classes

10
api_docs/inspector.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import inspectorObj from './inspector.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 101 | 6 | 78 | 4 |
## Client
### Setup

10
api_docs/kibana_legacy.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import kibanaLegacyObj from './kibana_legacy.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 93 | 3 | 85 | 1 |
## Client
### Functions

10
api_docs/kibana_react.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import kibanaReactObj from './kibana_react.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 245 | 1 | 216 | 4 |
## Client
### Objects

10
api_docs/kibana_utils.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import kibanaUtilsObj from './kibana_utils.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 551 | 5 | 373 | 8 |
## Client
### Objects

10
api_docs/lens.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import lensObj from './lens.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 172 | 0 | 161 | 16 |
## Client
### Interfaces

10
api_docs/license_api_guard.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import licenseApiGuardObj from './license_api_guard.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 8 | 0 | 8 | 0 |
## Server
### Classes

10
api_docs/license_management.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import licenseManagementObj from './license_management.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3 | 0 | 3 | 0 |
## Client
### Setup

10
api_docs/licensing.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import licensingObj from './licensing.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 120 | 0 | 44 | 8 |
## Client
### Setup

10
api_docs/lists.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import listsObj from './lists.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 151 | 0 | 143 | 38 |
## Client
### Setup

10
api_docs/management.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import managementObj from './management.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 38 | 0 | 38 | 4 |
## Client
### Setup

10
api_docs/maps.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import mapsObj from './maps.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 196 | 2 | 195 | 11 |
## Client
### Start

10
api_docs/maps_ems.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import mapsEmsObj from './maps_ems.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 75 | 1 | 75 | 0 |
## Client
### Setup

10
api_docs/metrics_entities.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import metricsEntitiesObj from './metrics_entities.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 9 | 0 | 6 | 1 |
## Server
### Setup

10
api_docs/ml.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import mlObj from './ml.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 274 | 10 | 270 | 32 |
## Client
### Start

10
api_docs/monitoring.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import monitoringObj from './monitoring.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 10 | 0 | 10 | 2 |
## Server
### Setup

10
api_docs/navigation.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import navigationObj from './navigation.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 31 | 0 | 31 | 2 |
## Client
### Setup

10
api_docs/newsfeed.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import newsfeedObj from './newsfeed.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 17 | 0 | 17 | 0 |
## Client
### Setup

10
api_docs/observability.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import observabilityObj from './observability.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 194 | 0 | 194 | 10 |
## Client
### Setup

10
api_docs/osquery.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import osqueryObj from './osquery.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 10 | 0 | 10 | 0 |
## Client
### Setup

10
api_docs/presentation_util.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import presentationUtilObj from './presentation_util.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 125 | 1 | 121 | 3 |
## Client
### Setup

10
api_docs/remote_clusters.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import remoteClustersObj from './remote_clusters.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 4 | 0 | 4 | 0 |
## Client
### Setup

10
api_docs/reporting.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import reportingObj from './reporting.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 133 | 1 | 132 | 19 |
## Client
### Start

10
api_docs/rollup.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import rollupObj from './rollup.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 20 | 0 | 20 | 0 |
## Common
### Objects

10
api_docs/rule_registry.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import ruleRegistryObj from './rule_registry.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 43 | 0 | 43 | 6 |
## Server
### Setup

10
api_docs/runtime_fields.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import runtimeFieldsObj from './runtime_fields.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 24 | 0 | 19 | 2 |
## Client
### Setup

10
api_docs/saved_objects.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import savedObjectsObj from './saved_objects.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 211 | 3 | 197 | 5 |
## Client
### Setup

10
api_docs/saved_objects_management.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import savedObjectsManagementObj from './saved_objects_management.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 96 | 0 | 85 | 0 |
## Client
### Setup

10
api_docs/saved_objects_tagging.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import savedObjectsTaggingObj from './saved_objects_tagging.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 54 | 0 | 50 | 0 |
## Client
### Start

10
api_docs/saved_objects_tagging_oss.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import savedObjectsTaggingOssObj from './saved_objects_tagging_oss.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 89 | 3 | 50 | 0 |
## Client
### Setup

10
api_docs/screenshot_mode.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import screenshotModeObj from './screenshot_mode.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 21 | 0 | 16 | 1 |
## Client
### Setup

10
api_docs/security.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import securityObj from './security.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 95 | 0 | 45 | 11 |
## Client
### Setup

10
api_docs/security_oss.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import securityOssObj from './security_oss.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 12 | 0 | 9 | 3 |
## Client
### Setup

10
api_docs/security_solution.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import securitySolutionObj from './security_solution.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 32 | 0 | 32 | 6 |
## Client
### Setup

10
api_docs/share.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import shareObj from './share.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 67 | 1 | 61 | 4 |
## Client
### Setup

10
api_docs/snapshot_restore.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import snapshotRestoreObj from './snapshot_restore.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 22 | 1 | 22 | 1 |
## Common
### Objects

10
api_docs/spaces.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import spacesObj from './spaces.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 96 | 0 | 0 | 0 |
## Client
### Setup

10
api_docs/spaces_oss.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import spacesOssObj from './spaces_oss.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 71 | 0 | 5 | 0 |
## Client
### Setup

10
api_docs/stack_alerts.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import stackAlertsObj from './stack_alerts.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 4 | 0 | 4 | 0 |
## Server
### Consts, variables and types

10
api_docs/task_manager.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import taskManagerObj from './task_manager.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 44 | 0 | 18 | 7 |
## Server
### Setup

10
api_docs/telemetry.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import telemetryObj from './telemetry.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 42 | 0 | 0 | 0 |
## Client
### Setup

10
api_docs/telemetry_collection_manager.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import telemetryCollectionManagerObj from './telemetry_collection_manager.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 29 | 0 | 29 | 4 |
## Server
### Setup

10
api_docs/telemetry_collection_xpack.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import telemetryCollectionXpackObj from './telemetry_collection_xpack.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 1 | 0 | 1 | 0 |
## Server
### Consts, variables and types

10
api_docs/telemetry_management_section.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import telemetryManagementSectionObj from './telemetry_management_section.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 14 | 0 | 13 | 0 |
## Client
### Setup

10
api_docs/timelines.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import timelinesObj from './timelines.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 6 | 0 | 6 | 1 |
## Client
### Setup

10
api_docs/triggers_actions_ui.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import triggersActionsUiObj from './triggers_actions_ui.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 237 | 1 | 228 | 19 |
## Client
### Setup

10
api_docs/ui_actions.mdx
View file

@ -11,6 +11,16 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
import uiActionsObj from './ui_actions.json';
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 127 | 0 | 88 | 11 |
## Client
### Setup

Some files were not shown because too many files have changed in this diff Show more