mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 09:48:58 -04:00
Merge branch 'master' into issue-102704-change-apm-default
This commit is contained in:
restrry
commit
c3a167eb40
473 changed files with 14376 additions and 5019 deletions
File diff suppressed because one or more lines are too long
|
|
@ -10,7 +10,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
---
|
||||
import apmObj from './apm.json';
|
||||
|
||||
|
||||
The user interface for Elastic APM
|
||||
|
||||
Contact [APM UI](https://github.com/orgs/elastic/teams/apm-ui) for questions regarding this plugin.
|
||||
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 223 | 2 | 192 | 3 |
|
||||
| 285 | 4 | 253 | 3 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
@ -53,12 +53,18 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
|
|||
|
||||
## Common
|
||||
|
||||
### Objects
|
||||
<DocDefinitionList data={chartsObj.common.objects}/>
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={chartsObj.common.functions}/>
|
||||
|
||||
### Interfaces
|
||||
<DocDefinitionList data={chartsObj.common.interfaces}/>
|
||||
|
||||
### Enums
|
||||
<DocDefinitionList data={chartsObj.common.enums}/>
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={chartsObj.common.misc}/>
|
||||
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2293 | 27 | 1020 | 29 |
|
||||
| 2300 | 27 | 1019 | 29 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -1664,7 +1664,7 @@
|
|||
"tags": [],
|
||||
"label": "euiIconType",
|
||||
"description": [
|
||||
"\nA EUI iconType that will be used for the app's icon. This icon\ntakes precendence over the `icon` property."
|
||||
"\nA EUI iconType that will be used for the app's icon. This icon\ntakes precedence over the `icon` property."
|
||||
],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2293 | 27 | 1020 | 29 |
|
||||
| 2300 | 27 | 1019 | 29 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2293 | 27 | 1020 | 29 |
|
||||
| 2300 | 27 | 1019 | 29 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -1249,7 +1249,7 @@
|
|||
"tags": [],
|
||||
"label": "fetch",
|
||||
"description": [
|
||||
"Makes an HTTP request. Defaults to a GET request unless overriden. See {@link HttpHandler} for options."
|
||||
"Makes an HTTP request. Defaults to a GET request unless overridden. See {@link HttpHandler} for options."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2293 | 27 | 1020 | 29 |
|
||||
| 2300 | 27 | 1019 | 29 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -5600,7 +5600,7 @@
|
|||
"tags": [],
|
||||
"label": "objectTransformError",
|
||||
"description": [
|
||||
"\nError returned when a {@link SavedObjectsExportTransform | export tranform} threw an error"
|
||||
"\nError returned when a {@link SavedObjectsExportTransform | export transform} threw an error"
|
||||
],
|
||||
"signature": [
|
||||
"(objects: ",
|
||||
|
|
@ -5656,7 +5656,7 @@
|
|||
"tags": [],
|
||||
"label": "invalidTransformError",
|
||||
"description": [
|
||||
"\nError returned when a {@link SavedObjectsExportTransform | export tranform} performed an invalid operation\nduring the transform, such as removing objects from the export, or changing an object's type or id."
|
||||
"\nError returned when a {@link SavedObjectsExportTransform | export transform} performed an invalid operation\nduring the transform, such as removing objects from the export, or changing an object's type or id."
|
||||
],
|
||||
"signature": [
|
||||
"(objectKeys: string[]) => ",
|
||||
|
|
@ -6599,7 +6599,7 @@
|
|||
],
|
||||
"label": "resolveImportErrors",
|
||||
"description": [
|
||||
"\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed informations.\n"
|
||||
"\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed information.\n"
|
||||
],
|
||||
"signature": [
|
||||
"({ readStream, createNewCopies, namespace, retries, }: ",
|
||||
|
|
@ -16148,7 +16148,7 @@
|
|||
"tags": [],
|
||||
"label": "SavedObjectsClientContract",
|
||||
"description": [
|
||||
"\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state.\n\n## SavedObjectsClient errors\n\nSince the SavedObjectsClient has its hands in everything we\nare a little paranoid about the way we present errors back to\nto application code. Ideally, all errors will be either:\n\n 1. Caused by bad implementation (ie. undefined is not a function) and\n as such unpredictable\n 2. An error that has been classified and decorated appropriately\n by the decorators in {@link SavedObjectsErrorHelpers}\n\nType 1 errors are inevitable, but since all expected/handle-able errors\nshould be Type 2 the `isXYZError()` helpers exposed at\n`SavedObjectsErrorHelpers` should be used to understand and manage error\nresponses from the `SavedObjectsClient`.\n\nType 2 errors are decorated versions of the source error, so if\nthe elasticsearch client threw an error it will be decorated based\non its type. That means that rather than looking for `error.body.error.type` or\ndoing substring checks on `error.body.error.reason`, just use the helpers to\nunderstand the meaning of the error:\n\n ```js\n if (SavedObjectsErrorHelpers.isNotFoundError(error)) {\n // handle 404\n }\n\n if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) {\n // 401 handling should be automatic, but in case you wanted to know\n }\n\n // always rethrow the error unless you handle it\n throw error;\n ```\n\n### 404s from missing index\n\nFrom the perspective of application code and APIs the SavedObjectsClient is\na black box that persists objects. One of the internal details that users have\nno control over is that we use an elasticsearch index for persistance and that\nindex might be missing.\n\nAt the time of writing we are in the process of transitioning away from the\noperating assumption that the SavedObjects index is always available. Part of\nthis transition is handling errors resulting from an index missing. These used\nto trigger a 500 error in most cases, and in others cause 404s with different\nerror messages.\n\nFrom my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The\nobject the request/call was targeting could not be found. This is why #14141\ntakes special care to ensure that 404 errors are generic and don't distinguish\nbetween index missing or document missing.\n\nSee {@link SavedObjectsClient}\nSee {@link SavedObjectsErrorHelpers}\n"
|
||||
"\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state.\n\n## SavedObjectsClient errors\n\nSince the SavedObjectsClient has its hands in everything we\nare a little paranoid about the way we present errors back to\nto application code. Ideally, all errors will be either:\n\n 1. Caused by bad implementation (ie. undefined is not a function) and\n as such unpredictable\n 2. An error that has been classified and decorated appropriately\n by the decorators in {@link SavedObjectsErrorHelpers}\n\nType 1 errors are inevitable, but since all expected/handle-able errors\nshould be Type 2 the `isXYZError()` helpers exposed at\n`SavedObjectsErrorHelpers` should be used to understand and manage error\nresponses from the `SavedObjectsClient`.\n\nType 2 errors are decorated versions of the source error, so if\nthe elasticsearch client threw an error it will be decorated based\non its type. That means that rather than looking for `error.body.error.type` or\ndoing substring checks on `error.body.error.reason`, just use the helpers to\nunderstand the meaning of the error:\n\n ```js\n if (SavedObjectsErrorHelpers.isNotFoundError(error)) {\n // handle 404\n }\n\n if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) {\n // 401 handling should be automatic, but in case you wanted to know\n }\n\n // always rethrow the error unless you handle it\n throw error;\n ```\n\n### 404s from missing index\n\nFrom the perspective of application code and APIs the SavedObjectsClient is\na black box that persists objects. One of the internal details that users have\nno control over is that we use an elasticsearch index for persistence and that\nindex might be missing.\n\nAt the time of writing we are in the process of transitioning away from the\noperating assumption that the SavedObjects index is always available. Part of\nthis transition is handling errors resulting from an index missing. These used\nto trigger a 500 error in most cases, and in others cause 404s with different\nerror messages.\n\nFrom my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The\nobject the request/call was targeting could not be found. This is why #14141\ntakes special care to ensure that 404 errors are generic and don't distinguish\nbetween index missing or document missing.\n\nSee {@link SavedObjectsClient}\nSee {@link SavedObjectsErrorHelpers}\n"
|
||||
],
|
||||
"signature": [
|
||||
"{ get: <T = unknown>(type: string, id: string, options?: ",
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2293 | 27 | 1020 | 29 |
|
||||
| 2300 | 27 | 1019 | 29 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -2424,10 +2424,6 @@
|
|||
"path": "src/plugins/dashboard/public/plugin.tsx",
|
||||
"deprecated": true,
|
||||
"references": [
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"path": "x-pack/plugins/security_solution/public/overview/containers/overview_cti_links/index.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"path": "x-pack/plugins/security_solution/public/overview/containers/overview_risky_host_links/use_risky_hosts_dashboard_button_href.ts"
|
||||
|
|
@ -2435,6 +2431,10 @@
|
|||
{
|
||||
"plugin": "securitySolution",
|
||||
"path": "x-pack/plugins/security_solution/public/overview/containers/overview_risky_host_links/use_risky_hosts_dashboard_links.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"path": "x-pack/plugins/security_solution/public/overview/containers/overview_cti_links/index.tsx"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
|
|||
|
|
@ -617,7 +617,15 @@
|
|||
"section": "def-server.SerializableRecord",
|
||||
"text": "SerializableRecord"
|
||||
},
|
||||
">): void; }"
|
||||
">): void; setAnonymousAccessServiceProvider: (provider: () => ",
|
||||
{
|
||||
"pluginId": "share",
|
||||
"scope": "common",
|
||||
"docId": "kibSharePluginApi",
|
||||
"section": "def-common.AnonymousAccessServiceContract",
|
||||
"text": "AnonymousAccessServiceContract"
|
||||
},
|
||||
") => void; }"
|
||||
],
|
||||
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
|
||||
"deprecated": false
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3181 | 43 | 2796 | 48 |
|
||||
| 3192 | 43 | 2807 | 48 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3181 | 43 | 2796 | 48 |
|
||||
| 3192 | 43 | 2807 | 48 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3181 | 43 | 2796 | 48 |
|
||||
| 3192 | 43 | 2807 | 48 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -2277,13 +2277,7 @@
|
|||
"label": "uiSettingsClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.IUiSettingsClient",
|
||||
"text": "IUiSettingsClient"
|
||||
}
|
||||
"{ get: <T = any>(key: string) => Promise<T>; }"
|
||||
],
|
||||
"path": "src/plugins/data/server/search/types.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -28577,7 +28571,7 @@
|
|||
"label": "fn",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(input: null, args: Arguments) => any"
|
||||
"(input: null, args: Arguments) => { type: \"kibana_filter\"; meta: { negate: boolean; alias: string; disabled: boolean; }; query: any; }"
|
||||
],
|
||||
"path": "src/plugins/data/common/search/expressions/kibana_filter.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3181 | 43 | 2796 | 48 |
|
||||
| 3192 | 43 | 2807 | 48 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3181 | 43 | 2796 | 48 |
|
||||
| 3192 | 43 | 2807 | 48 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -4734,6 +4734,18 @@
|
|||
"plugin": "lens",
|
||||
"path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts"
|
||||
|
|
@ -4754,18 +4766,6 @@
|
|||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/components/filter_label.tsx"
|
||||
|
|
@ -13245,18 +13245,14 @@
|
|||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewField.subType",
|
||||
"type": "Object",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "subType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubType",
|
||||
"text": "IFieldSubType"
|
||||
},
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/data_view_field.ts",
|
||||
|
|
@ -13307,6 +13303,82 @@
|
|||
"path": "src/plugins/data_views/common/fields/data_view_field.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewField.isSubtypeNested",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "isSubtypeNested",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => boolean"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/data_view_field.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewField.isSubtypeMulti",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "isSubtypeMulti",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => boolean"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/data_view_field.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewField.getSubtypeNested",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getSubtypeNested",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubTypeNested",
|
||||
"text": "IFieldSubTypeNested"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/data_view_field.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewField.getSubtypeMulti",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getSubtypeMulti",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubTypeMulti",
|
||||
"text": "IFieldSubTypeMulti"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/data_view_field.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewField.deleteCount",
|
||||
|
|
@ -13331,13 +13403,9 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"() => { count: number; script: string | undefined; lang: \"painless\" | \"expression\" | \"mustache\" | \"java\" | undefined; conflictDescriptions: Record<string, string[]> | undefined; name: string; type: string; esTypes: string[] | undefined; scripted: boolean; searchable: boolean; aggregatable: boolean; readFromDocValues: boolean; subType: ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubType",
|
||||
"text": "IFieldSubType"
|
||||
},
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined; customLabel: string | undefined; }"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/data_view_field.ts",
|
||||
|
|
@ -16470,6 +16538,18 @@
|
|||
"plugin": "lens",
|
||||
"path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/types.ts"
|
||||
|
|
@ -16490,18 +16570,6 @@
|
|||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "observability",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/exploratory_view/components/filter_label.tsx"
|
||||
|
|
@ -19769,6 +19837,106 @@
|
|||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.getFieldSubtypeMulti",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getFieldSubtypeMulti",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(field: Pick<",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.DataViewFieldBase",
|
||||
"text": "DataViewFieldBase"
|
||||
},
|
||||
", \"subType\">) => ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubTypeMulti",
|
||||
"text": "IFieldSubTypeMulti"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/utils.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.getFieldSubtypeMulti.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "field",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ subType?: ",
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined; }"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/utils.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.getFieldSubtypeNested",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getFieldSubtypeNested",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(field: Pick<",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.DataViewFieldBase",
|
||||
"text": "DataViewFieldBase"
|
||||
},
|
||||
", \"subType\">) => ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubTypeNested",
|
||||
"text": "IFieldSubTypeNested"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/utils.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.getFieldSubtypeNested.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "field",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ subType?: ",
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined; }"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/utils.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.getIndexPatternLoadMeta",
|
||||
|
|
@ -19838,6 +20006,48 @@
|
|||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.isMultiField",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "isMultiField",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(field: Pick<",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.DataViewFieldBase",
|
||||
"text": "DataViewFieldBase"
|
||||
},
|
||||
", \"subType\">) => boolean"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/utils.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.isMultiField.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "field",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ subType?: ",
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined; }"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/utils.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.isNestedField",
|
||||
|
|
@ -19846,18 +20056,19 @@
|
|||
"label": "isNestedField",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(field: ",
|
||||
"(field: Pick<",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.IFieldType",
|
||||
"text": "IFieldType"
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.DataViewFieldBase",
|
||||
"text": "DataViewFieldBase"
|
||||
},
|
||||
") => boolean"
|
||||
", \"subType\">) => boolean"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/utils.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
|
|
@ -19867,20 +20078,16 @@
|
|||
"label": "field",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.IFieldType",
|
||||
"text": "IFieldType"
|
||||
}
|
||||
"{ subType?: ",
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined; }"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/fields/utils.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
|
@ -20754,18 +20961,14 @@
|
|||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.FieldSpecExportFmt.subType",
|
||||
"type": "Object",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "subType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubType",
|
||||
"text": "IFieldSubType"
|
||||
},
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/types.ts",
|
||||
|
|
@ -22411,14 +22614,6 @@
|
|||
"plugin": "monitoring",
|
||||
"path": "x-pack/plugins/monitoring/public/lib/kuery.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts"
|
||||
|
|
@ -22631,14 +22826,6 @@
|
|||
"plugin": "timelines",
|
||||
"path": "x-pack/plugins/timelines/public/mock/index_pattern.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"path": "x-pack/plugins/security_solution/target/types/common/search_strategy/index_fields/index.d.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"path": "x-pack/plugins/security_solution/target/types/common/search_strategy/index_fields/index.d.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "infra",
|
||||
"path": "x-pack/plugins/infra/target/types/public/containers/with_kuery_autocompletion.d.ts"
|
||||
|
|
@ -22903,6 +23090,14 @@
|
|||
"plugin": "infra",
|
||||
"path": "x-pack/plugins/infra/public/pages/metrics/index.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "securitySolution",
|
||||
"path": "x-pack/plugins/security_solution/public/common/store/sourcerer/model.ts"
|
||||
|
|
@ -24924,19 +25119,19 @@
|
|||
},
|
||||
{
|
||||
"plugin": "visualizations",
|
||||
"path": "src/plugins/visualizations/public/saved_visualizations/saved_visualization_references/controls_references.ts"
|
||||
"path": "src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "visualizations",
|
||||
"path": "src/plugins/visualizations/public/saved_visualizations/saved_visualization_references/controls_references.ts"
|
||||
"path": "src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "visualizations",
|
||||
"path": "src/plugins/visualizations/public/saved_visualizations/saved_visualization_references/timeseries_references.ts"
|
||||
"path": "src/plugins/visualizations/public/utils/saved_visualization_references/timeseries_references.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "visualizations",
|
||||
"path": "src/plugins/visualizations/public/saved_visualizations/saved_visualization_references/timeseries_references.ts"
|
||||
"path": "src/plugins/visualizations/public/utils/saved_visualization_references/timeseries_references.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "dashboard",
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 671 | 6 | 531 | 5 |
|
||||
| 681 | 6 | 541 | 5 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibDataPluginApi" section="def-common.IndexPatternListItem" text="IndexPatternListItem"/> | dataViews, indexPatternManagement, data | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-server.IndexPatternAttributes" text="IndexPatternAttributes"/> | dataViews, discover, ml, transform, canvas | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-server.IndexPatternsService" text="IndexPatternsService"/> | dataViews, visTypeTimeseries, maps, lens, discover | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | fleet, indexPatternFieldEditor, discover, dashboard, lens, ml, stackAlerts, indexPatternManagement, visTypeMetric, visTypePie, visTypeTable, visTypeTimeseries, visTypeXy, visTypeVislib | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | fleet, indexPatternFieldEditor, discover, dashboard, lens, ml, stackAlerts, indexPatternManagement, visTypePie, visTypeTable, visTypeTimeseries, visTypeXy, visTypeVislib | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-server.DataPluginStart.fieldFormats" text="fieldFormats"/> | reporting, visTypeTimeseries | - |
|
||||
| <DocLink id="kibDataViewsPluginApi" section="def-server.DataViewsServerPluginStart.indexPatternsServiceFactory" text="indexPatternsServiceFactory"/> | data, lens, visTypeTimeseries, infra, maps, visTypeTimelion | - |
|
||||
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectsStart.settings" text="settings"/> | dashboard, maps, graph, visualize | - |
|
||||
|
|
@ -178,7 +178,6 @@ Safe to remove.
|
|||
| <DocLink id="kibDataPluginApi" section="def-common.getPhraseFilterValue" text="getPhraseFilterValue"/> |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.isExistsFilter" text="isExistsFilter"/> |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.isMatchAllFilter" text="isMatchAllFilter"/> |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.isMissingFilter" text="isMissingFilter"/> |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.isPhraseFilter" text="isPhraseFilter"/> |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.isPhrasesFilter" text="isPhrasesFilter"/> |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.isRangeFilter" text="isRangeFilter"/> |
|
||||
|
|
@ -203,7 +202,6 @@ Safe to remove.
|
|||
| <DocLink id="kibDataPluginApi" section="def-common.PhraseFilter" text="PhraseFilter"/> |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.MatchAllFilter" text="MatchAllFilter"/> |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.CustomFilter" text="CustomFilter"/> |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.MissingFilter" text="MissingFilter"/> |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.FilterMeta" text="FilterMeta"/> |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.getKbnFieldType" text="getKbnFieldType"/> |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.getFilterableKbnTypeNames" text="getFilterableKbnTypeNames"/> |
|
||||
|
|
|
|||
|
|
@ -205,12 +205,12 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibDataPluginApi" section="def-public.IndexPattern" text="IndexPattern"/> | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IndexPatternField" text="IndexPatternField"/> | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField)+ 2 more | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 14 more | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 13 more | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IndexPatternAttributes" text="IndexPatternAttributes"/> | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternAttributes), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/utils.ts#:~:text=IndexPatternAttributes), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/utils.ts#:~:text=IndexPatternAttributes), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/utils.ts#:~:text=IndexPatternAttributes), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/utils.ts#:~:text=IndexPatternAttributes), [scripted_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/deprecations/scripted_fields.ts#:~:text=IndexPatternAttributes), [scripted_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/deprecations/scripted_fields.ts#:~:text=IndexPatternAttributes) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IndexPatternSpec" text="IndexPatternSpec"/> | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternSpec), [create_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/routes/create_index_pattern.ts#:~:text=IndexPatternSpec), [create_index_pattern.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/routes/create_index_pattern.ts#:~:text=IndexPatternSpec) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IndexPatternType" text="IndexPatternType"/> | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternType) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IndexPatternListItem" text="IndexPatternListItem"/> | [data_views.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_views.ts#:~:text=IndexPatternListItem), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternListItem) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 14 more | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 13 more | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IndexPatternAttributes" text="IndexPatternAttributes"/> | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternAttributes), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/utils.ts#:~:text=IndexPatternAttributes), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/utils.ts#:~:text=IndexPatternAttributes), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/utils.ts#:~:text=IndexPatternAttributes), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/utils.ts#:~:text=IndexPatternAttributes), [scripted_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/deprecations/scripted_fields.ts#:~:text=IndexPatternAttributes), [scripted_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/deprecations/scripted_fields.ts#:~:text=IndexPatternAttributes) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPatternsApiClient" text="IIndexPatternsApiClient"/> | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IIndexPatternsApiClient), [index_patterns_api_client.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/index_patterns_api_client.ts#:~:text=IIndexPatternsApiClient), [index_patterns_api_client.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/index_patterns_api_client.ts#:~:text=IIndexPatternsApiClient) | - |
|
||||
|
|
@ -230,7 +230,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibDataPluginApi" section="def-common.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getNonScriptedFields) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.DataView.getScriptedFields" text="getScriptedFields"/> | [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=getScriptedFields), [data_views.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_views.ts#:~:text=getScriptedFields), [register_index_pattern_usage_collection.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/register_index_pattern_usage_collection.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=getScriptedFields)+ 1 more | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-server.IndexPatternField" text="IndexPatternField"/> | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField)+ 2 more | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 14 more | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 13 more | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-server.IndexPatternAttributes" text="IndexPatternAttributes"/> | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternAttributes), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/utils.ts#:~:text=IndexPatternAttributes), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/utils.ts#:~:text=IndexPatternAttributes), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/utils.ts#:~:text=IndexPatternAttributes), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/utils.ts#:~:text=IndexPatternAttributes), [scripted_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/deprecations/scripted_fields.ts#:~:text=IndexPatternAttributes), [scripted_fields.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/server/deprecations/scripted_fields.ts#:~:text=IndexPatternAttributes) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-server.IndexPattern" text="IndexPattern"/> | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-server.IndexPatternsService" text="IndexPatternsService"/> | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternsService) | - |
|
||||
|
|
@ -678,7 +678,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibDataPluginApi" section="def-public.IndexPattern" text="IndexPattern"/> | [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=IndexPattern), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=IndexPattern), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=IndexPattern), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=IndexPattern), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=IndexPattern), [lens_attributes.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/lens_attributes.ts#:~:text=IndexPattern), [lens_attributes.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/lens_attributes.ts#:~:text=IndexPattern), [lens_attributes.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/lens_attributes.ts#:~:text=IndexPattern), [default_configs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/default_configs.ts#:~:text=IndexPattern), [default_configs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/default_configs.ts#:~:text=IndexPattern)+ 38 more | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IndexPatternSpec" text="IndexPatternSpec"/> | [observability_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts#:~:text=IndexPatternSpec), [observability_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts#:~:text=IndexPatternSpec) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | [observability_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts#:~:text=indexPatterns), [observability_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts#:~:text=indexPatterns), [observability_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/pages/alerts/index.tsx#:~:text=indexPatterns), [observability_index_patterns.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.test.ts#:~:text=indexPatterns), [observability_index_patterns.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.test.ts#:~:text=indexPatterns), [observability_index_patterns.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.test.ts#:~:text=indexPatterns), [observability_index_patterns.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.test.ts#:~:text=indexPatterns), [observability_index_patterns.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.test.ts#:~:text=indexPatterns), [observability_index_patterns.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.test.ts#:~:text=indexPatterns)+ 5 more | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=esFilters), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=esFilters), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=esFilters), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=esFilters), [filter_value_label.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx#:~:text=esFilters), [filter_value_label.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx#:~:text=esFilters), [filter_value_label.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx#:~:text=esFilters), [filter_value_label.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx#:~:text=esFilters) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | [filter_value_label.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx#:~:text=esFilters), [filter_value_label.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx#:~:text=esFilters), [filter_value_label.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx#:~:text=esFilters), [filter_value_label.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx#:~:text=esFilters), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=esFilters), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=esFilters), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=esFilters), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=esFilters) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.ExistsFilter" text="ExistsFilter"/> | [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=ExistsFilter), [utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/configurations/utils.ts#:~:text=ExistsFilter) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.Filter" text="Filter"/> | [filter_value_label.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx#:~:text=Filter), [filter_value_label.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx#:~:text=Filter) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IndexPatternSpec" text="IndexPatternSpec"/> | [observability_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts#:~:text=IndexPatternSpec), [observability_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts#:~:text=IndexPatternSpec), [observability_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts#:~:text=IndexPatternSpec), [observability_index_patterns.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/observability/public/components/shared/exploratory_view/utils/observability_index_patterns.ts#:~:text=IndexPatternSpec) | - |
|
||||
|
|
@ -836,15 +836,15 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibDashboardPluginApi" section="def-public.DashboardStart.dashboardUrlGenerator" text="dashboardUrlGenerator"/> | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/containers/overview_cti_links/index.tsx#:~:text=dashboardUrlGenerator), [use_risky_hosts_dashboard_button_href.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/containers/overview_risky_host_links/use_risky_hosts_dashboard_button_href.ts#:~:text=dashboardUrlGenerator), [use_risky_hosts_dashboard_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/containers/overview_risky_host_links/use_risky_hosts_dashboard_links.tsx#:~:text=dashboardUrlGenerator) | - |
|
||||
| <DocLink id="kibDashboardPluginApi" section="def-public.DashboardStart.dashboardUrlGenerator" text="dashboardUrlGenerator"/> | [use_risky_hosts_dashboard_button_href.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/containers/overview_risky_host_links/use_risky_hosts_dashboard_button_href.ts#:~:text=dashboardUrlGenerator), [use_risky_hosts_dashboard_links.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/containers/overview_risky_host_links/use_risky_hosts_dashboard_links.tsx#:~:text=dashboardUrlGenerator), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/containers/overview_cti_links/index.tsx#:~:text=dashboardUrlGenerator) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IndexPattern" text="IndexPattern"/> | [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [entry_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/entry_item.tsx#:~:text=IndexPattern), [entry_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/entry_item.tsx#:~:text=IndexPattern), [entry_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/entry_item.tsx#:~:text=IndexPattern), [list_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/list_item.tsx#:~:text=IndexPattern), [list_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/list_item.tsx#:~:text=IndexPattern)+ 30 more | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IndexPatternField" text="IndexPatternField"/> | [field_name_cell.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/event_details/table/field_name_cell.tsx#:~:text=IndexPatternField), [field_name_cell.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/event_details/table/field_name_cell.tsx#:~:text=IndexPatternField), [field_name_cell.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/event_details/table/field_name_cell.tsx#:~:text=IndexPatternField), [field_name_cell.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/event_details/table/field_name_cell.tsx#:~:text=IndexPatternField) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#:~:text=IIndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#:~:text=IIndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#:~:text=IIndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#:~:text=IIndexPattern), [action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#:~:text=IIndexPattern), [action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/timeline/helpers.tsx#:~:text=IIndexPattern)+ 76 more | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#:~:text=IIndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#:~:text=IIndexPattern), [action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#:~:text=IIndexPattern), [action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/timeline/helpers.tsx#:~:text=IIndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/timeline/helpers.tsx#:~:text=IIndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/url_state/types.ts#:~:text=IIndexPattern)+ 74 more | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | [middleware.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=indexPatterns), [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/plugin.tsx#:~:text=indexPatterns), [dependencies_start_mock.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/mock/endpoint/dependencies_start_mock.ts#:~:text=indexPatterns) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/timeline/query_bar/index.tsx#:~:text=esFilters), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/timeline/query_bar/index.tsx#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters)+ 15 more | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/timeline/query_bar/index.tsx#:~:text=esFilters), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/timeline/query_bar/index.tsx#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters), [epic.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/epic.ts#:~:text=esFilters)+ 14 more | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.esQuery" text="esQuery"/> | [expandable_network.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/side_panel/network_details/expandable_network.tsx#:~:text=esQuery), [expandable_network.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/side_panel/network_details/expandable_network.tsx#:~:text=esQuery), [events_viewer.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/events_viewer/events_viewer.tsx#:~:text=esQuery), [events_viewer.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/events_viewer/events_viewer.tsx#:~:text=esQuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/components/events_by_dataset/index.tsx#:~:text=esQuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/overview/components/events_by_dataset/index.tsx#:~:text=esQuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/alerts_kpis/alerts_histogram_panel/index.tsx#:~:text=esQuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/alerts_kpis/alerts_histogram_panel/index.tsx#:~:text=esQuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/alerts_kpis/alerts_histogram_panel/index.tsx#:~:text=esQuery), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/top_n/index.tsx#:~:text=esQuery)+ 30 more | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.Filter" text="Filter"/> | [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter)+ 163 more | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#:~:text=IIndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts#:~:text=IIndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#:~:text=IIndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#:~:text=IIndexPattern), [action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#:~:text=IIndexPattern), [action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/timeline/helpers.tsx#:~:text=IIndexPattern)+ 162 more | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#:~:text=IIndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/types.ts#:~:text=IIndexPattern), [action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#:~:text=IIndexPattern), [action.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/action.ts#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/containers/source/index.tsx#:~:text=IIndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/timeline/helpers.tsx#:~:text=IIndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/components/timeline/helpers.tsx#:~:text=IIndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/url_state/types.ts#:~:text=IIndexPattern)+ 158 more | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IndexPatternField" text="IndexPatternField"/> | [field_name_cell.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/event_details/table/field_name_cell.tsx#:~:text=IndexPatternField), [field_name_cell.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/event_details/table/field_name_cell.tsx#:~:text=IndexPatternField), [field_name_cell.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/event_details/table/field_name_cell.tsx#:~:text=IndexPatternField), [field_name_cell.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/event_details/table/field_name_cell.tsx#:~:text=IndexPatternField) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IndexPattern" text="IndexPattern"/> | [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [helpers.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/helpers.tsx#:~:text=IndexPattern), [entry_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/entry_item.tsx#:~:text=IndexPattern), [entry_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/entry_item.tsx#:~:text=IndexPattern), [entry_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/entry_item.tsx#:~:text=IndexPattern), [list_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/list_item.tsx#:~:text=IndexPattern), [list_item.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/threat_match/list_item.tsx#:~:text=IndexPattern)+ 30 more | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.Filter" text="Filter"/> | [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [store.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/types/timeline/store.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [model.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/model.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/actions.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [selectors.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/store/inputs/selectors.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter), [actions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/timelines/store/timeline/actions.ts#:~:text=Filter)+ 163 more | 8.1 |
|
||||
|
|
@ -983,14 +983,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
|
||||
|
||||
|
||||
## visTypeMetric
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/metric/public/plugin.ts#:~:text=fieldFormats) | - |
|
||||
|
||||
|
||||
|
||||
## visTypePie
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
|
|
@ -1101,7 +1093,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/plugin.ts#:~:text=indexPatterns) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=esFilters), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=esFilters) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.Filter" text="Filter"/> | [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.INDEX_PATTERN_SAVED_OBJECT_TYPE" text="INDEX_PATTERN_SAVED_OBJECT_TYPE"/> | [controls_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/saved_visualization_references/controls_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [controls_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/saved_visualization_references/controls_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [timeseries_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/saved_visualization_references/timeseries_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [timeseries_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/saved_visualization_references/timeseries_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [controls_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/saved_visualization_references/controls_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE)+ 8 more | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.INDEX_PATTERN_SAVED_OBJECT_TYPE" text="INDEX_PATTERN_SAVED_OBJECT_TYPE"/> | [controls_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [controls_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [timeseries_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/timeseries_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [timeseries_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/timeseries_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [visualization_saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/server/migrations/visualization_saved_object_migrations.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE), [controls_references.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_visualization_references/controls_references.ts#:~:text=INDEX_PATTERN_SAVED_OBJECT_TYPE)+ 8 more | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IndexPatternsContract" text="IndexPatternsContract"/> | [_saved_vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#:~:text=IndexPatternsContract), [_saved_vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#:~:text=IndexPatternsContract), [_saved_vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#:~:text=IndexPatternsContract), [_saved_vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#:~:text=IndexPatternsContract) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IndexPattern" text="IndexPattern"/> | [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern)+ 10 more | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.Filter" text="Filter"/> | [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter) | 8.1 |
|
||||
|
|
@ -1109,7 +1101,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibDataPluginApi" section="def-server.IndexPattern" text="IndexPattern"/> | [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/vis_types/types.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [create_vis_embeddable_from_object.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/create_vis_embeddable_from_object.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=IndexPattern) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-server.Filter" text="Filter"/> | [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter), [visualize_embeddable.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/embeddable/visualize_embeddable.ts#:~:text=Filter) | 8.1 |
|
||||
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectLoader" text="SavedObjectLoader"/> | [find_list_items.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/find_list_items.ts#:~:text=SavedObjectLoader), [find_list_items.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/find_list_items.ts#:~:text=SavedObjectLoader), [saved_visualizations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/saved_visualizations.ts#:~:text=SavedObjectLoader), [saved_visualizations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/saved_visualizations.ts#:~:text=SavedObjectLoader), [saved_visualizations.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/saved_visualizations.ts#:~:text=SavedObjectLoader), [services.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/services.ts#:~:text=SavedObjectLoader), [services.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/services.ts#:~:text=SavedObjectLoader) | - |
|
||||
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/types.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/types.ts#:~:text=SavedObject), [_saved_vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#:~:text=SavedObject), [_saved_vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#:~:text=SavedObject), [_saved_vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#:~:text=SavedObject), [_saved_vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#:~:text=SavedObject) | - |
|
||||
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | [_saved_vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#:~:text=SavedObject), [_saved_vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#:~:text=SavedObject), [_saved_vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#:~:text=SavedObject), [_saved_vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#:~:text=SavedObject) | - |
|
||||
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectsStart.SavedObjectClass" text="SavedObjectClass"/> | [_saved_vis.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts#:~:text=SavedObjectClass) | - |
|
||||
|
||||
|
||||
|
|
|
|||
257
api_docs/elastic_apm_generator.json
Normal file
257
api_docs/elastic_apm_generator.json
Normal file
|
|
@ -0,0 +1,257 @@
|
|||
{
|
||||
"id": "@elastic/apm-generator",
|
||||
"client": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"server": {
|
||||
"classes": [],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.getObserverDefaults",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getObserverDefaults",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/defaults/get_observer_defaults.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.getSpanDestinationMetrics",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getSpanDestinationMetrics",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(events: Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>[]) => Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>[]"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/utils/get_span_destination_metrics.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.getSpanDestinationMetrics.$1",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "events",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>[]"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/utils/get_span_destination_metrics.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.getTransactionMetrics",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getTransactionMetrics",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(events: Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>[]) => { \"transaction.duration.histogram\": { values: number[]; counts: number[]; }; _doc_count: number; '@timestamp'?: number | undefined; 'agent.name'?: string | undefined; 'agent.version'?: string | undefined; 'ecs.version'?: string | undefined; 'event.outcome'?: string | undefined; 'event.ingested'?: number | undefined; 'metricset.name'?: string | undefined; 'observer.version'?: string | undefined; 'observer.version_major'?: number | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.destination.service.response_time.sum.us'?: number | undefined; 'span.destination.service.response_time.count'?: number | undefined; }[]"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/utils/get_transaction_metrics.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.getTransactionMetrics.$1",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "events",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>[]"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/utils/get_transaction_metrics.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.service",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "service",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(name: string, environment: string, agentName: string) => ",
|
||||
"Service"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/service.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.service.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/service.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.service.$2",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "environment",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/service.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.service.$3",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "agentName",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/service.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.timerange",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "timerange",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(from: number, to: number) => ",
|
||||
"Timerange"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/timerange.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.timerange.$1",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "from",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/timerange.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.timerange.$2",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "to",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/timerange.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.toElasticsearchOutput",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "toElasticsearchOutput",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(events: Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>[], versionOverride: string | undefined) => { _index: string; _source: {}; }[]"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/output/to_elasticsearch_output.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.toElasticsearchOutput.$1",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "events",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Partial<{ '@timestamp': number; 'agent.name': string; 'agent.version': string; 'ecs.version': string; 'event.outcome': string; 'event.ingested': number; 'metricset.name': string; 'observer.version': string; 'observer.version_major': number; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.environment': string; 'service.node.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; }>[]"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/output/to_elasticsearch_output.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@elastic/apm-generator",
|
||||
"id": "def-server.toElasticsearchOutput.$2",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "versionOverride",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "packages/elastic-apm-generator/src/lib/output/to_elasticsearch_output.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"common": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
}
|
||||
}
|
||||
27
api_docs/elastic_apm_generator.mdx
Normal file
27
api_docs/elastic_apm_generator.mdx
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
id: kibElasticApmGeneratorPluginApi
|
||||
slug: /kibana-dev-docs/api/elastic-apm-generator
|
||||
title: "@elastic/apm-generator"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @elastic/apm-generator plugin
|
||||
date: 2020-11-16
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/apm-generator']
|
||||
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 elasticApmGeneratorObj from './elastic_apm_generator.json';
|
||||
|
||||
Elastic APM trace data generator
|
||||
|
||||
Contact [Owner missing] for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 15 | 0 | 15 | 2 |
|
||||
|
||||
## Server
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={elasticApmGeneratorObj.server.functions}/>
|
||||
|
||||
|
|
@ -753,7 +753,7 @@
|
|||
"label": "logEvent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(properties: DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
|
||||
"(properties: DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/server/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -766,7 +766,7 @@
|
|||
"label": "properties",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/server/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -783,7 +783,7 @@
|
|||
"label": "startTiming",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(event: DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
|
||||
"(event: DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/server/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -796,7 +796,7 @@
|
|||
"label": "event",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/server/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -813,7 +813,7 @@
|
|||
"label": "stopTiming",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(event: DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
|
||||
"(event: DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/server/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -826,7 +826,7 @@
|
|||
"label": "event",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/server/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -886,7 +886,7 @@
|
|||
"label": "data",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]"
|
||||
"(Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -905,7 +905,7 @@
|
|||
"label": "IEvent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/generated/schemas.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -919,7 +919,7 @@
|
|||
"label": "IValidatedEvent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined"
|
||||
"Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/generated/schemas.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -1138,7 +1138,7 @@
|
|||
"label": "getLogger",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(properties: DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => ",
|
||||
"(properties: DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => ",
|
||||
{
|
||||
"pluginId": "eventLog",
|
||||
"scope": "server",
|
||||
|
|
@ -1158,7 +1158,7 @@
|
|||
"label": "properties",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
"DeepPartial<DeepWriteable<Readonly<{ tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; alert?: Readonly<{ rule?: Readonly<{ execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ total_indexing_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ scheduled?: string | undefined; schedule_delay?: number | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; message?: string | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; category?: string[] | undefined; url?: string | undefined; code?: string | undefined; original?: string | undefined; action?: string | undefined; kind?: string | undefined; severity?: number | undefined; outcome?: string | undefined; created?: string | undefined; dataset?: string | undefined; duration?: number | undefined; hash?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/event_log/server/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
|||
837
api_docs/expression_metric_vis.json
Normal file
837
api_docs/expression_metric_vis.json
Normal file
|
|
@ -0,0 +1,837 @@
|
|||
{
|
||||
"id": "expressionMetricVis",
|
||||
"client": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"server": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"common": {
|
||||
"classes": [],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.metricVisFunction",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "metricVisFunction",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
{
|
||||
"pluginId": "expressionMetricVis",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionMetricVisPluginApi",
|
||||
"section": "def-common.MetricVisExpressionFunctionDefinition",
|
||||
"text": "MetricVisExpressionFunctionDefinition"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/expression_functions/metric_vis_function.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.DimensionsVisParam",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "DimensionsVisParam",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.DimensionsVisParam.metrics",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "metrics",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.ExpressionValueBoxed",
|
||||
"text": "ExpressionValueBoxed"
|
||||
},
|
||||
"<\"vis_dimension\", { accessor: number | ",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.DatatableColumn",
|
||||
"text": "DatatableColumn"
|
||||
},
|
||||
"; format: { id?: string | undefined; params: Record<string, any>; }; }>[]"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.DimensionsVisParam.bucket",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "bucket",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.ExpressionValueBoxed",
|
||||
"text": "ExpressionValueBoxed"
|
||||
},
|
||||
"<\"vis_dimension\", { accessor: number | ",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.DatatableColumn",
|
||||
"text": "DatatableColumn"
|
||||
},
|
||||
"; format: { id?: string | undefined; params: Record<string, any>; }; }> | undefined"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "MetricArguments",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.percentageMode",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "percentageMode",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.colorSchema",
|
||||
"type": "Enum",
|
||||
"tags": [],
|
||||
"label": "colorSchema",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "charts",
|
||||
"scope": "common",
|
||||
"docId": "kibChartsPluginApi",
|
||||
"section": "def-common.ColorSchemas",
|
||||
"text": "ColorSchemas"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.colorMode",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "colorMode",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"Background\" | \"Labels\" | \"None\""
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.useRanges",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "useRanges",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.invertColors",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "invertColors",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.showLabels",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "showLabels",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.bgFill",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "bgFill",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.subText",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "subText",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.colorRange",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "colorRange",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.Range",
|
||||
"text": "Range"
|
||||
},
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.font",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "font",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.ExpressionTypeStyle",
|
||||
"text": "ExpressionTypeStyle"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.metric",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "metric",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.ExpressionValueBoxed",
|
||||
"text": "ExpressionValueBoxed"
|
||||
},
|
||||
"<\"vis_dimension\", { accessor: number | ",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.DatatableColumn",
|
||||
"text": "DatatableColumn"
|
||||
},
|
||||
"; format: { id?: string | undefined; params: Record<string, any>; }; }>[]"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.bucket",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "bucket",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ type: \"vis_dimension\"; } & { accessor: number | ",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.DatatableColumn",
|
||||
"text": "DatatableColumn"
|
||||
},
|
||||
"; format: { id?: string | undefined; params: Record<string, any>; }; }"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricOptions",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "MetricOptions",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricOptions.value",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "value",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricOptions.label",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "label",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricOptions.color",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "color",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricOptions.bgColor",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "bgColor",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricOptions.lightText",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "lightText",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricOptions.rowIndex",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "rowIndex",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "MetricVisParam",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam.percentageMode",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "percentageMode",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam.percentageFormatPattern",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "percentageFormatPattern",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam.useRanges",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "useRanges",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam.colorSchema",
|
||||
"type": "Enum",
|
||||
"tags": [],
|
||||
"label": "colorSchema",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "charts",
|
||||
"scope": "common",
|
||||
"docId": "kibChartsPluginApi",
|
||||
"section": "def-common.ColorSchemas",
|
||||
"text": "ColorSchemas"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam.metricColorMode",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "metricColorMode",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"Background\" | \"Labels\" | \"None\""
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam.colorsRange",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "colorsRange",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.Range",
|
||||
"text": "Range"
|
||||
},
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam.labels",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "labels",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "charts",
|
||||
"scope": "common",
|
||||
"docId": "kibChartsPluginApi",
|
||||
"section": "def-common.Labels",
|
||||
"text": "Labels"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam.invertColors",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "invertColors",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam.style",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "style",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "charts",
|
||||
"scope": "common",
|
||||
"docId": "kibChartsPluginApi",
|
||||
"section": "def-common.Style",
|
||||
"text": "Style"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisRenderConfig",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "MetricVisRenderConfig",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisRenderConfig.visType",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "visType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"metric\""
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisRenderConfig.visData",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "visData",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.Datatable",
|
||||
"text": "Datatable"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisRenderConfig.visConfig",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "visConfig",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ metric: ",
|
||||
{
|
||||
"pluginId": "expressionMetricVis",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionMetricVisPluginApi",
|
||||
"section": "def-common.MetricVisParam",
|
||||
"text": "MetricVisParam"
|
||||
},
|
||||
"; dimensions: ",
|
||||
{
|
||||
"pluginId": "expressionMetricVis",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionMetricVisPluginApi",
|
||||
"section": "def-common.DimensionsVisParam",
|
||||
"text": "DimensionsVisParam"
|
||||
},
|
||||
"; }"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.VisParams",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "VisParams",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.VisParams.addTooltip",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "addTooltip",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.VisParams.addLegend",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "addLegend",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.VisParams.dimensions",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "dimensions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "expressionMetricVis",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionMetricVisPluginApi",
|
||||
"section": "def-common.DimensionsVisParam",
|
||||
"text": "DimensionsVisParam"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.VisParams.metric",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "metric",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "expressionMetricVis",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionMetricVisPluginApi",
|
||||
"section": "def-common.MetricVisParam",
|
||||
"text": "MetricVisParam"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.VisParams.type",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "type",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"metric\""
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"enums": [],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.EXPRESSION_METRIC_NAME",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "EXPRESSION_METRIC_NAME",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"metricVis\""
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/constants.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricInput",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "MetricInput",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.Datatable",
|
||||
"text": "Datatable"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisExpressionFunctionDefinition",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "MetricVisExpressionFunctionDefinition",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.ExpressionFunctionDefinition",
|
||||
"text": "ExpressionFunctionDefinition"
|
||||
},
|
||||
"<\"metricVis\", ",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.Datatable",
|
||||
"text": "Datatable"
|
||||
},
|
||||
", ",
|
||||
{
|
||||
"pluginId": "expressionMetricVis",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionMetricVisPluginApi",
|
||||
"section": "def-common.MetricArguments",
|
||||
"text": "MetricArguments"
|
||||
},
|
||||
", ",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.ExpressionValueBoxed",
|
||||
"text": "ExpressionValueBoxed"
|
||||
},
|
||||
"<\"render\", { as: string; value: ",
|
||||
{
|
||||
"pluginId": "expressionMetricVis",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionMetricVisPluginApi",
|
||||
"section": "def-common.MetricVisRenderConfig",
|
||||
"text": "MetricVisRenderConfig"
|
||||
},
|
||||
"; }>, ",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.ExecutionContext",
|
||||
"text": "ExecutionContext"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "inspector",
|
||||
"scope": "common",
|
||||
"docId": "kibInspectorPluginApi",
|
||||
"section": "def-common.Adapters",
|
||||
"text": "Adapters"
|
||||
},
|
||||
", ",
|
||||
{
|
||||
"pluginId": "@kbn/utility-types",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnUtilityTypesPluginApi",
|
||||
"section": "def-server.SerializableRecord",
|
||||
"text": "SerializableRecord"
|
||||
},
|
||||
">>"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.PLUGIN_ID",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "PLUGIN_ID",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"expressionMetricVis\""
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/index.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.PLUGIN_NAME",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "PLUGIN_NAME",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"expressionMetricVis\""
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/index.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": []
|
||||
}
|
||||
}
|
||||
33
api_docs/expression_metric_vis.mdx
Normal file
33
api_docs/expression_metric_vis.mdx
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
id: kibExpressionMetricVisPluginApi
|
||||
slug: /kibana-dev-docs/api/expressionMetricVis
|
||||
title: "expressionMetricVis"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionMetricVis plugin
|
||||
date: 2020-11-16
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
|
||||
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 expressionMetricVisObj from './expression_metric_vis.json';
|
||||
|
||||
Expression MetricVis plugin adds a `metric` renderer and function to the expression plugin. The renderer will display the `metric` chart.
|
||||
|
||||
Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 49 | 0 | 49 | 0 |
|
||||
|
||||
## Common
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={expressionMetricVisObj.common.functions}/>
|
||||
|
||||
### Interfaces
|
||||
<DocDefinitionList data={expressionMetricVisObj.common.interfaces}/>
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={expressionMetricVisObj.common.misc}/>
|
||||
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -18,7 +18,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 1207 | 15 | 1106 | 10 |
|
||||
| 1207 | 15 | 1107 | 10 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -265,6 +265,104 @@
|
|||
}
|
||||
],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "interactiveSetup",
|
||||
"id": "def-common.ERROR_CONFIGURE_FAILURE",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "ERROR_CONFIGURE_FAILURE",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"configure_failure\""
|
||||
],
|
||||
"path": "src/plugins/interactive_setup/common/constants.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "interactiveSetup",
|
||||
"id": "def-common.ERROR_ELASTICSEARCH_CONNECTION_CONFIGURED",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "ERROR_ELASTICSEARCH_CONNECTION_CONFIGURED",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"elasticsearch_connection_configured\""
|
||||
],
|
||||
"path": "src/plugins/interactive_setup/common/constants.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "interactiveSetup",
|
||||
"id": "def-common.ERROR_ENROLL_FAILURE",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "ERROR_ENROLL_FAILURE",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"enroll_failure\""
|
||||
],
|
||||
"path": "src/plugins/interactive_setup/common/constants.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "interactiveSetup",
|
||||
"id": "def-common.ERROR_KIBANA_CONFIG_FAILURE",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "ERROR_KIBANA_CONFIG_FAILURE",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"kibana_config_failure\""
|
||||
],
|
||||
"path": "src/plugins/interactive_setup/common/constants.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "interactiveSetup",
|
||||
"id": "def-common.ERROR_KIBANA_CONFIG_NOT_WRITABLE",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "ERROR_KIBANA_CONFIG_NOT_WRITABLE",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"kibana_config_not_writable\""
|
||||
],
|
||||
"path": "src/plugins/interactive_setup/common/constants.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "interactiveSetup",
|
||||
"id": "def-common.ERROR_OUTSIDE_PREBOOT_STAGE",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "ERROR_OUTSIDE_PREBOOT_STAGE",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"outside_preboot_stage\""
|
||||
],
|
||||
"path": "src/plugins/interactive_setup/common/constants.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "interactiveSetup",
|
||||
"id": "def-common.ERROR_PING_FAILURE",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "ERROR_PING_FAILURE",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"ping_failure\""
|
||||
],
|
||||
"path": "src/plugins/interactive_setup/common/constants.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "interactiveSetup",
|
||||
"id": "def-common.VERIFICATION_CODE_LENGTH",
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Platform Security](https://github.com/orgs/elastic/teams/kibana-securit
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 19 | 0 | 9 | 0 |
|
||||
| 26 | 0 | 16 | 0 |
|
||||
|
||||
## Common
|
||||
|
||||
|
|
|
|||
|
|
@ -250,6 +250,45 @@
|
|||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/config",
|
||||
"id": "def-server.ConfigDeprecationContext",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "ConfigDeprecationContext",
|
||||
"description": [
|
||||
"\nDeprecation context provided to {@link ConfigDeprecation | config deprecations}\n"
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/config",
|
||||
"id": "def-server.ConfigDeprecationContext.version",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "version",
|
||||
"description": [
|
||||
"The current Kibana version, e.g `7.16.1`, `8.0.0`"
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/config",
|
||||
"id": "def-server.ConfigDeprecationContext.branch",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "branch",
|
||||
"description": [
|
||||
"The current Kibana branch, e.g `7.x`, `7.16`, `master`"
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/config",
|
||||
"id": "def-server.ConfigDeprecationFactory",
|
||||
|
|
@ -275,7 +314,13 @@
|
|||
"(deprecatedKey: string, removeBy: string, details?: Partial<",
|
||||
"DeprecatedConfigDetails",
|
||||
"> | undefined) => ",
|
||||
"ConfigDeprecation"
|
||||
{
|
||||
"pluginId": "@kbn/config",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnConfigPluginApi",
|
||||
"section": "def-server.ConfigDeprecation",
|
||||
"text": "ConfigDeprecation"
|
||||
}
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -340,7 +385,13 @@
|
|||
"(deprecatedKey: string, removeBy: string, details?: Partial<",
|
||||
"DeprecatedConfigDetails",
|
||||
"> | undefined) => ",
|
||||
"ConfigDeprecation"
|
||||
{
|
||||
"pluginId": "@kbn/config",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnConfigPluginApi",
|
||||
"section": "def-server.ConfigDeprecation",
|
||||
"text": "ConfigDeprecation"
|
||||
}
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -405,7 +456,13 @@
|
|||
"(oldKey: string, newKey: string, details?: Partial<",
|
||||
"DeprecatedConfigDetails",
|
||||
"> | undefined) => ",
|
||||
"ConfigDeprecation"
|
||||
{
|
||||
"pluginId": "@kbn/config",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnConfigPluginApi",
|
||||
"section": "def-server.ConfigDeprecation",
|
||||
"text": "ConfigDeprecation"
|
||||
}
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -470,7 +527,13 @@
|
|||
"(oldKey: string, newKey: string, details?: Partial<",
|
||||
"DeprecatedConfigDetails",
|
||||
"> | undefined) => ",
|
||||
"ConfigDeprecation"
|
||||
{
|
||||
"pluginId": "@kbn/config",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnConfigPluginApi",
|
||||
"section": "def-server.ConfigDeprecation",
|
||||
"text": "ConfigDeprecation"
|
||||
}
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -535,7 +598,13 @@
|
|||
"(unusedKey: string, details?: Partial<",
|
||||
"DeprecatedConfigDetails",
|
||||
"> | undefined) => ",
|
||||
"ConfigDeprecation"
|
||||
{
|
||||
"pluginId": "@kbn/config",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnConfigPluginApi",
|
||||
"section": "def-server.ConfigDeprecation",
|
||||
"text": "ConfigDeprecation"
|
||||
}
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -586,7 +655,13 @@
|
|||
"(unusedKey: string, details?: Partial<",
|
||||
"DeprecatedConfigDetails",
|
||||
"> | undefined) => ",
|
||||
"ConfigDeprecation"
|
||||
{
|
||||
"pluginId": "@kbn/config",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnConfigPluginApi",
|
||||
"section": "def-server.ConfigDeprecation",
|
||||
"text": "ConfigDeprecation"
|
||||
}
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -773,6 +848,123 @@
|
|||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/config",
|
||||
"id": "def-server.ConfigDeprecation",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "ConfigDeprecation",
|
||||
"description": [
|
||||
"\nConfiguration deprecation returned from {@link ConfigDeprecationProvider} that handles a single deprecation from the configuration.\n"
|
||||
],
|
||||
"signature": [
|
||||
"(config: Readonly<{ [x: string]: any; }>, fromPath: string, addDeprecation: ",
|
||||
{
|
||||
"pluginId": "@kbn/config",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnConfigPluginApi",
|
||||
"section": "def-server.AddConfigDeprecation",
|
||||
"text": "AddConfigDeprecation"
|
||||
},
|
||||
", context: ",
|
||||
{
|
||||
"pluginId": "@kbn/config",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnConfigPluginApi",
|
||||
"section": "def-server.ConfigDeprecationContext",
|
||||
"text": "ConfigDeprecationContext"
|
||||
},
|
||||
") => void | ",
|
||||
{
|
||||
"pluginId": "@kbn/config",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnConfigPluginApi",
|
||||
"section": "def-server.ConfigDeprecationCommand",
|
||||
"text": "ConfigDeprecationCommand"
|
||||
}
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/config",
|
||||
"id": "def-server.ConfigDeprecation.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "config",
|
||||
"description": [
|
||||
"must not be mutated, return {@link ConfigDeprecationCommand} to change config shape."
|
||||
],
|
||||
"signature": [
|
||||
"{ readonly [x: string]: any; }"
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/config",
|
||||
"id": "def-server.ConfigDeprecation.$2",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "fromPath",
|
||||
"description": [],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/config",
|
||||
"id": "def-server.ConfigDeprecation.$3",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "addDeprecation",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(details: ",
|
||||
"DeprecatedConfigDetails",
|
||||
") => void"
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/config",
|
||||
"id": "def-server.ConfigDeprecation.$3.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "details",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"DeprecatedConfigDetails"
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/config",
|
||||
"id": "def-server.ConfigDeprecation.$4",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/config",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnConfigPluginApi",
|
||||
"section": "def-server.ConfigDeprecationContext",
|
||||
"text": "ConfigDeprecationContext"
|
||||
}
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/config",
|
||||
"id": "def-server.ConfigDeprecationProvider",
|
||||
|
|
@ -792,7 +984,13 @@
|
|||
"text": "ConfigDeprecationFactory"
|
||||
},
|
||||
") => ",
|
||||
"ConfigDeprecation",
|
||||
{
|
||||
"pluginId": "@kbn/config",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnConfigPluginApi",
|
||||
"section": "def-server.ConfigDeprecation",
|
||||
"text": "ConfigDeprecation"
|
||||
},
|
||||
"[]"
|
||||
],
|
||||
"path": "packages/kbn-config/src/deprecation/types.ts",
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin.
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 57 | 0 | 42 | 2 |
|
||||
| 66 | 0 | 46 | 1 |
|
||||
|
||||
## Server
|
||||
|
||||
|
|
|
|||
|
|
@ -1725,6 +1725,210 @@
|
|||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.getDataViewFieldSubtypeMulti",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getDataViewFieldSubtypeMulti",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(field: Pick<",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.DataViewFieldBase",
|
||||
"text": "DataViewFieldBase"
|
||||
},
|
||||
", \"subType\">) => ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubTypeMulti",
|
||||
"text": "IFieldSubTypeMulti"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/utils.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.getDataViewFieldSubtypeMulti.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "field",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.DataViewFieldBase",
|
||||
"text": "DataViewFieldBase"
|
||||
},
|
||||
", \"subType\">"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/utils.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.getDataViewFieldSubtypeNested",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getDataViewFieldSubtypeNested",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(field: Pick<",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.DataViewFieldBase",
|
||||
"text": "DataViewFieldBase"
|
||||
},
|
||||
", \"subType\">) => ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubTypeNested",
|
||||
"text": "IFieldSubTypeNested"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/utils.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.getDataViewFieldSubtypeNested.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "field",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.DataViewFieldBase",
|
||||
"text": "DataViewFieldBase"
|
||||
},
|
||||
", \"subType\">"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/utils.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.isDataViewFieldSubtypeMulti",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "isDataViewFieldSubtypeMulti",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(field: Pick<",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.DataViewFieldBase",
|
||||
"text": "DataViewFieldBase"
|
||||
},
|
||||
", \"subType\">) => boolean"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/utils.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.isDataViewFieldSubtypeMulti.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "field",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.DataViewFieldBase",
|
||||
"text": "DataViewFieldBase"
|
||||
},
|
||||
", \"subType\">"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/utils.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.isDataViewFieldSubtypeNested",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "isDataViewFieldSubtypeNested",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(field: Pick<",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.DataViewFieldBase",
|
||||
"text": "DataViewFieldBase"
|
||||
},
|
||||
", \"subType\">) => boolean"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/utils.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.isDataViewFieldSubtypeNested.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "field",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.DataViewFieldBase",
|
||||
"text": "DataViewFieldBase"
|
||||
},
|
||||
", \"subType\">"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/utils.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.isExistsFilter",
|
||||
|
|
@ -2010,60 +2214,6 @@
|
|||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.isMissingFilter",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "isMissingFilter",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(filter: ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
") => filter is ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.MissingFilter",
|
||||
"text": "MissingFilter"
|
||||
}
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/filters/build_filters/missing_filter.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.isMissingFilter.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "filter",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
}
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/filters/build_filters/missing_filter.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [
|
||||
"`true` if a filter is an `MissingFilter`"
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.isPhraseFilter",
|
||||
|
|
@ -3136,18 +3286,14 @@
|
|||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.DataViewFieldBase.subType",
|
||||
"type": "Object",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "subType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubType",
|
||||
"text": "IFieldSubType"
|
||||
},
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/es_query/types.ts",
|
||||
|
|
@ -3279,38 +3425,49 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.IFieldSubType",
|
||||
"id": "def-common.IFieldSubTypeMulti",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "IFieldSubType",
|
||||
"description": [
|
||||
"\nA field's sub type"
|
||||
],
|
||||
"label": "IFieldSubTypeMulti",
|
||||
"description": [],
|
||||
"path": "packages/kbn-es-query/src/es_query/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.IFieldSubType.multi",
|
||||
"id": "def-common.IFieldSubTypeMulti.multi",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "multi",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ parent: string; } | undefined"
|
||||
"{ parent: string; }"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/es_query/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.IFieldSubTypeNested",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "IFieldSubTypeNested",
|
||||
"description": [],
|
||||
"path": "packages/kbn-es-query/src/es_query/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.IFieldSubType.nested",
|
||||
"id": "def-common.IFieldSubTypeNested.nested",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "nested",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ path: string; } | undefined"
|
||||
"{ path: string; }"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/es_query/types.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -3665,7 +3822,7 @@
|
|||
"section": "def-common.FilterMeta",
|
||||
"text": "FilterMeta"
|
||||
},
|
||||
"; exists?: { field: string; } | undefined; }"
|
||||
"; query: { exists?: { field: string; } | undefined; }; }"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/filters/build_filters/exists_filter.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -3697,14 +3854,6 @@
|
|||
"text": "MatchAllFilter"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.MissingFilter",
|
||||
"text": "MissingFilter"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
|
|
@ -3777,6 +3926,24 @@
|
|||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.IFieldSubType",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "IFieldSubType",
|
||||
"description": [
|
||||
"\nA field's sub type"
|
||||
],
|
||||
"signature": [
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/es_query/types.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.IndexPatternBase",
|
||||
|
|
@ -3840,43 +4007,14 @@
|
|||
},
|
||||
" & { meta: ",
|
||||
"MatchAllFilterMeta",
|
||||
"; match_all: ",
|
||||
"; query: { match_all: ",
|
||||
"QueryDslMatchAllQuery",
|
||||
"; }"
|
||||
"; }; }"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/filters/build_filters/match_all_filter.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.MissingFilter",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "MissingFilter",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
" & { meta: ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.FilterMeta",
|
||||
"text": "FilterMeta"
|
||||
},
|
||||
"; missing: { field: string; }; }"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/filters/build_filters/missing_filter.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/es-query",
|
||||
"id": "def-common.PhraseFilter",
|
||||
|
|
@ -3995,7 +4133,7 @@
|
|||
"section": "def-common.RangeFilterMeta",
|
||||
"text": "RangeFilterMeta"
|
||||
},
|
||||
"; range: { [key: string]: ",
|
||||
"; query: { range: { [key: string]: ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
|
|
@ -4003,7 +4141,7 @@
|
|||
"section": "def-common.RangeFilterParams",
|
||||
"text": "RangeFilterParams"
|
||||
},
|
||||
"; }; }"
|
||||
"; }; }; }"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/filters/build_filters/range_filter.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -4086,9 +4224,9 @@
|
|||
"section": "def-common.RangeFilterMeta",
|
||||
"text": "RangeFilterMeta"
|
||||
},
|
||||
"; script: { script: ",
|
||||
"; query: { script: { script: ",
|
||||
"InlineScript",
|
||||
"; }; }"
|
||||
"; }; }; }"
|
||||
],
|
||||
"path": "packages/kbn-es-query/src/filters/build_filters/range_filter.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin.
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 198 | 2 | 146 | 12 |
|
||||
| 205 | 2 | 153 | 14 |
|
||||
|
||||
## Common
|
||||
|
||||
|
|
|
|||
|
|
@ -706,7 +706,7 @@
|
|||
"EcsHttp",
|
||||
" | undefined; log?: Pick<",
|
||||
"EcsLog",
|
||||
", \"origin\" | \"original\" | \"file\" | \"syslog\"> | undefined; network?: ",
|
||||
", \"origin\" | \"file\" | \"syslog\"> | undefined; network?: ",
|
||||
"EcsNetwork",
|
||||
" | undefined; observer?: ",
|
||||
"EcsObserver",
|
||||
|
|
|
|||
|
|
@ -32,8 +32,8 @@
|
|||
"pluginId": "@kbn/monaco",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnMonacoPluginApi",
|
||||
"section": "def-common.LangModule",
|
||||
"text": "LangModule"
|
||||
"section": "def-common.LangModuleType",
|
||||
"text": "LangModuleType"
|
||||
},
|
||||
") => void"
|
||||
],
|
||||
|
|
@ -52,8 +52,8 @@
|
|||
"pluginId": "@kbn/monaco",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnMonacoPluginApi",
|
||||
"section": "def-common.LangModule",
|
||||
"text": "LangModule"
|
||||
"section": "def-common.LangModuleType",
|
||||
"text": "LangModuleType"
|
||||
}
|
||||
],
|
||||
"path": "packages/kbn-monaco/src/helpers.ts",
|
||||
|
|
@ -68,26 +68,26 @@
|
|||
"interfaces": [
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.CompleteLangModule",
|
||||
"id": "def-common.CompleteLangModuleType",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "CompleteLangModule",
|
||||
"label": "CompleteLangModuleType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/monaco",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnMonacoPluginApi",
|
||||
"section": "def-common.CompleteLangModule",
|
||||
"text": "CompleteLangModule"
|
||||
"section": "def-common.CompleteLangModuleType",
|
||||
"text": "CompleteLangModuleType"
|
||||
},
|
||||
" extends ",
|
||||
{
|
||||
"pluginId": "@kbn/monaco",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnMonacoPluginApi",
|
||||
"section": "def-common.LangModule",
|
||||
"text": "LangModule"
|
||||
"section": "def-common.LangModuleType",
|
||||
"text": "LangModuleType"
|
||||
}
|
||||
],
|
||||
"path": "packages/kbn-monaco/src/types.ts",
|
||||
|
|
@ -95,7 +95,7 @@
|
|||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.CompleteLangModule.languageConfiguration",
|
||||
"id": "def-common.CompleteLangModuleType.languageConfiguration",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "languageConfiguration",
|
||||
|
|
@ -109,7 +109,7 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.CompleteLangModule.getSuggestionProvider",
|
||||
"id": "def-common.CompleteLangModuleType.getSuggestionProvider",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "getSuggestionProvider",
|
||||
|
|
@ -122,7 +122,7 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.CompleteLangModule.getSyntaxErrors",
|
||||
"id": "def-common.CompleteLangModuleType.getSyntaxErrors",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "getSyntaxErrors",
|
||||
|
|
@ -138,17 +138,17 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.LangModule",
|
||||
"id": "def-common.LangModuleType",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "LangModule",
|
||||
"label": "LangModuleType",
|
||||
"description": [],
|
||||
"path": "packages/kbn-monaco/src/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.LangModule.ID",
|
||||
"id": "def-common.LangModuleType.ID",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "ID",
|
||||
|
|
@ -158,7 +158,7 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.LangModule.lexerRules",
|
||||
"id": "def-common.LangModuleType.lexerRules",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "lexerRules",
|
||||
|
|
@ -172,7 +172,7 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.LangModule.languageConfiguration",
|
||||
"id": "def-common.LangModuleType.languageConfiguration",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "languageConfiguration",
|
||||
|
|
@ -186,7 +186,7 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.LangModule.getSuggestionProvider",
|
||||
"id": "def-common.LangModuleType.getSuggestionProvider",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "getSuggestionProvider",
|
||||
|
|
@ -199,7 +199,7 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.LangModule.getSyntaxErrors",
|
||||
"id": "def-common.LangModuleType.getSyntaxErrors",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "getSyntaxErrors",
|
||||
|
|
@ -245,10 +245,136 @@
|
|||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.PainlessCompletionItem",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "PainlessCompletionItem",
|
||||
"description": [],
|
||||
"path": "packages/kbn-monaco/src/painless/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.PainlessCompletionItem.label",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "label",
|
||||
"description": [],
|
||||
"path": "packages/kbn-monaco/src/painless/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.PainlessCompletionItem.kind",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "kind",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"type\" | \"keyword\" | \"field\" | \"property\" | \"method\" | \"class\" | \"constructor\""
|
||||
],
|
||||
"path": "packages/kbn-monaco/src/painless/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.PainlessCompletionItem.documentation",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "documentation",
|
||||
"description": [],
|
||||
"path": "packages/kbn-monaco/src/painless/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.PainlessCompletionItem.insertText",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "insertText",
|
||||
"description": [],
|
||||
"path": "packages/kbn-monaco/src/painless/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.PainlessCompletionItem.insertTextAsSnippet",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "insertTextAsSnippet",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "packages/kbn-monaco/src/painless/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.PainlessCompletionResult",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "PainlessCompletionResult",
|
||||
"description": [],
|
||||
"path": "packages/kbn-monaco/src/painless/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.PainlessCompletionResult.isIncomplete",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "isIncomplete",
|
||||
"description": [],
|
||||
"path": "packages/kbn-monaco/src/painless/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.PainlessCompletionResult.suggestions",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "suggestions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/monaco",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnMonacoPluginApi",
|
||||
"section": "def-common.PainlessCompletionItem",
|
||||
"text": "PainlessCompletionItem"
|
||||
},
|
||||
"[]"
|
||||
],
|
||||
"path": "packages/kbn-monaco/src/painless/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"enums": [],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.PainlessCompletionKind",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "PainlessCompletionKind",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"type\" | \"keyword\" | \"field\" | \"property\" | \"method\" | \"class\" | \"constructor\""
|
||||
],
|
||||
"path": "packages/kbn-monaco/src/painless/types.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/monaco",
|
||||
"id": "def-common.PainlessContext",
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin.
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 28 | 0 | 28 | 3 |
|
||||
| 38 | 0 | 38 | 3 |
|
||||
|
||||
## Common
|
||||
|
||||
|
|
|
|||
|
|
@ -314,6 +314,61 @@
|
|||
}
|
||||
],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "@kbn/optimizer",
|
||||
"id": "def-server.logOptimizerProgress",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "logOptimizerProgress",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(log: ",
|
||||
{
|
||||
"pluginId": "@kbn/dev-utils",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnDevUtilsPluginApi",
|
||||
"section": "def-server.ToolingLog",
|
||||
"text": "ToolingLog"
|
||||
},
|
||||
") => ",
|
||||
"MonoTypeOperatorFunction",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "@kbn/optimizer",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnOptimizerPluginApi",
|
||||
"section": "def-server.OptimizerUpdate",
|
||||
"text": "OptimizerUpdate"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"path": "packages/kbn-optimizer/src/log_optimizer_progress.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/optimizer",
|
||||
"id": "def-server.logOptimizerProgress.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "log",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/dev-utils",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnDevUtilsPluginApi",
|
||||
"section": "def-server.ToolingLog",
|
||||
"text": "ToolingLog"
|
||||
}
|
||||
],
|
||||
"path": "packages/kbn-optimizer/src/log_optimizer_progress.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/optimizer",
|
||||
"id": "def-server.logOptimizerState",
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin.
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 42 | 0 | 42 | 9 |
|
||||
| 44 | 0 | 44 | 9 |
|
||||
|
||||
## Server
|
||||
|
||||
|
|
|
|||
|
|
@ -2774,7 +2774,7 @@
|
|||
"label": "bool",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ must?: unknown; must_not?: unknown; should?: unknown[] | undefined; filter?: unknown; minimum_should_match?: number | undefined; }"
|
||||
"QueryDslBoolQuery"
|
||||
],
|
||||
"path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -3265,7 +3265,7 @@
|
|||
"label": "nested",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ path: string; query: unknown; score_mode: string; }"
|
||||
"QueryDslNestedQuery"
|
||||
],
|
||||
"path": "packages/kbn-securitysolution-list-utils/src/build_exception_filter/index.ts",
|
||||
"deprecated": false
|
||||
|
|
|
|||
|
|
@ -165,7 +165,7 @@
|
|||
"label": "Outlet",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
||||
"() => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null"
|
||||
],
|
||||
"path": "packages/kbn-typed-react-router-config/src/outlet.tsx",
|
||||
"deprecated": false,
|
||||
|
|
@ -173,6 +173,61 @@
|
|||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/typed-react-router-config",
|
||||
"id": "def-common.OutletContextProvider",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "OutletContextProvider",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"({\n element,\n children,\n}: { element: React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>; children: React.ReactNode; }) => JSX.Element"
|
||||
],
|
||||
"path": "packages/kbn-typed-react-router-config/src/outlet.tsx",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/typed-react-router-config",
|
||||
"id": "def-common.OutletContextProvider.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "{\n element,\n children,\n}",
|
||||
"description": [],
|
||||
"path": "packages/kbn-typed-react-router-config/src/outlet.tsx",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/typed-react-router-config",
|
||||
"id": "def-common.OutletContextProvider.$1.element",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "element",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
||||
],
|
||||
"path": "packages/kbn-typed-react-router-config/src/outlet.tsx",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/typed-react-router-config",
|
||||
"id": "def-common.OutletContextProvider.$1.children",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "children",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | number | boolean | {} | React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | React.ReactNodeArray | React.ReactPortal | null | undefined"
|
||||
],
|
||||
"path": "packages/kbn-typed-react-router-config/src/outlet.tsx",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/typed-react-router-config",
|
||||
"id": "def-common.route",
|
||||
|
|
@ -236,7 +291,7 @@
|
|||
"section": "def-common.Route",
|
||||
"text": "Route"
|
||||
},
|
||||
"[]>; children: React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>; }) => JSX.Element"
|
||||
"[]>; children: React.ReactNode; }) => JSX.Element"
|
||||
],
|
||||
"path": "packages/kbn-typed-react-router-config/src/use_router.tsx",
|
||||
"deprecated": false,
|
||||
|
|
@ -282,12 +337,12 @@
|
|||
{
|
||||
"parentPluginId": "@kbn/typed-react-router-config",
|
||||
"id": "def-common.RouterContextProvider.$1.children",
|
||||
"type": "Object",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "children",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
||||
"string | number | boolean | {} | React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | React.ReactNodeArray | React.ReactPortal | null | undefined"
|
||||
],
|
||||
"path": "packages/kbn-typed-react-router-config/src/use_router.tsx",
|
||||
"deprecated": false
|
||||
|
|
@ -340,7 +395,7 @@
|
|||
},
|
||||
"[]>; history: ",
|
||||
"History",
|
||||
"<any>; children: React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>; }) => JSX.Element"
|
||||
"<any>; children: React.ReactNode; }) => JSX.Element"
|
||||
],
|
||||
"path": "packages/kbn-typed-react-router-config/src/router_provider.tsx",
|
||||
"deprecated": false,
|
||||
|
|
@ -400,12 +455,12 @@
|
|||
{
|
||||
"parentPluginId": "@kbn/typed-react-router-config",
|
||||
"id": "def-common.RouterProvider.$1.children",
|
||||
"type": "Object",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "children",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
||||
"string | number | boolean | {} | React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | React.ReactNodeArray | React.ReactPortal | null | undefined"
|
||||
],
|
||||
"path": "packages/kbn-typed-react-router-config/src/router_provider.tsx",
|
||||
"deprecated": false
|
||||
|
|
@ -2027,6 +2082,44 @@
|
|||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/typed-react-router-config",
|
||||
"id": "def-common.Router.getRoutesToMatch",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getRoutesToMatch",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(path: string) => ",
|
||||
{
|
||||
"pluginId": "@kbn/typed-react-router-config",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnTypedReactRouterConfigPluginApi",
|
||||
"section": "def-common.FlattenRoutesOf",
|
||||
"text": "FlattenRoutesOf"
|
||||
},
|
||||
"<TRoutes>"
|
||||
],
|
||||
"path": "packages/kbn-typed-react-router-config/src/types/index.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/typed-react-router-config",
|
||||
"id": "def-common.Router.getRoutesToMatch.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "path",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "packages/kbn-typed-react-router-config/src/types/index.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -2034,6 +2127,24 @@
|
|||
],
|
||||
"enums": [],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "@kbn/typed-react-router-config",
|
||||
"id": "def-common.FlattenRoutesOf",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "FlattenRoutesOf",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"ValuesType",
|
||||
"<MapRoutes<TRoutes, []>>, Exclude<keyof ",
|
||||
"ValuesType",
|
||||
"<MapRoutes<TRoutes, []>>, \"parents\">>[]"
|
||||
],
|
||||
"path": "packages/kbn-typed-react-router-config/src/types/index.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/typed-react-router-config",
|
||||
"id": "def-common.Match",
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin.
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 71 | 0 | 71 | 1 |
|
||||
| 78 | 0 | 78 | 1 |
|
||||
|
||||
## Common
|
||||
|
||||
|
|
|
|||
|
|
@ -1486,7 +1486,7 @@
|
|||
"label": "createGetterSetter",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"<T extends object>(name: string) => [",
|
||||
"<T extends object>(name: string, isValueRequired?: boolean) => [",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
|
|
@ -1520,6 +1520,20 @@
|
|||
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "kibanaUtils",
|
||||
"id": "def-public.createGetterSetter.$2",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "isValueRequired",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean"
|
||||
],
|
||||
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
|
|
@ -7113,7 +7127,7 @@
|
|||
"label": "createGetterSetter",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"<T extends object>(name: string) => [",
|
||||
"<T extends object>(name: string, isValueRequired?: boolean) => [",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
|
|
@ -7147,6 +7161,20 @@
|
|||
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "kibanaUtils",
|
||||
"id": "def-server.createGetterSetter.$2",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "isValueRequired",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean"
|
||||
],
|
||||
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
|
|
@ -8686,7 +8714,7 @@
|
|||
"label": "createGetterSetter",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"<T extends object>(name: string) => [",
|
||||
"<T extends object>(name: string, isValueRequired?: boolean) => [",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
|
|
@ -8720,6 +8748,20 @@
|
|||
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "kibanaUtils",
|
||||
"id": "def-common.createGetterSetter.$2",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "isValueRequired",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean"
|
||||
],
|
||||
"path": "src/plugins/kibana_utils/common/create_getter_setter.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 603 | 3 | 410 | 8 |
|
||||
| 606 | 3 | 413 | 8 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -1807,6 +1807,19 @@
|
|||
],
|
||||
"path": "x-pack/plugins/lens/common/expressions/xy_chart/axis_config.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "lens",
|
||||
"id": "def-public.YConfig.textVisibility",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "textVisibility",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/lens/common/expressions/xy_chart/axis_config.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 252 | 0 | 234 | 24 |
|
||||
| 253 | 0 | 235 | 24 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -2962,7 +2962,7 @@
|
|||
"section": "def-public.LayerWizard",
|
||||
"text": "LayerWizard"
|
||||
},
|
||||
") => Promise<void>"
|
||||
") => void"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/api/setup_api.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -3000,7 +3000,7 @@
|
|||
"signature": [
|
||||
"(entry: ",
|
||||
"SourceRegistryEntry",
|
||||
") => Promise<void>"
|
||||
") => void"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/api/setup_api.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
|||
|
|
@ -238,9 +238,11 @@
|
|||
"label": "FilterValueLabel",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"({\n label,\n field,\n value,\n negate,\n indexPattern,\n invertFilter,\n removeFilter,\n allowExclusion = true,\n}: Props) => JSX.Element | null"
|
||||
"(props: ",
|
||||
"FilterValueLabelProps",
|
||||
") => JSX.Element"
|
||||
],
|
||||
"path": "x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/index.tsx",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
|
|
@ -248,12 +250,12 @@
|
|||
"id": "def-public.FilterValueLabel.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "{\n label,\n field,\n value,\n negate,\n indexPattern,\n invertFilter,\n removeFilter,\n allowExclusion = true,\n}",
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Props"
|
||||
"FilterValueLabelProps"
|
||||
],
|
||||
"path": "x-pack/plugins/observability/public/components/shared/filter_value_label/filter_value_label.tsx",
|
||||
"path": "x-pack/plugins/observability/public/components/shared/index.tsx",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
|
|
@ -386,6 +388,48 @@
|
|||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-public.InspectorContextProvider",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "InspectorContextProvider",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"({ children }: { children: React.ReactNode; }) => JSX.Element"
|
||||
],
|
||||
"path": "x-pack/plugins/observability/public/context/inspector/inspector_context.tsx",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-public.InspectorContextProvider.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "{ children }",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/observability/public/context/inspector/inspector_context.tsx",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-public.InspectorContextProvider.$1.children",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "children",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | number | boolean | {} | React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | React.ReactNodeArray | React.ReactPortal | null | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/observability/public/context/inspector/inspector_context.tsx",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-public.LazyAlertsFlyout",
|
||||
|
|
@ -833,6 +877,23 @@
|
|||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-public.useInspectorContext",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "useInspectorContext",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
"InspectorContextValue"
|
||||
],
|
||||
"path": "x-pack/plugins/observability/public/context/inspector/use_inspector_context.tsx",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-public.useTheme",
|
||||
|
|
@ -3660,6 +3721,173 @@
|
|||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-server.getInspectResponse",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getInspectResponse",
|
||||
"description": [
|
||||
"\nCreate a formatted response to be sent in the _inspect key for use in the\ninspector."
|
||||
],
|
||||
"signature": [
|
||||
"({\n esError,\n esRequestParams,\n esRequestStatus,\n esResponse,\n kibanaRequest,\n operationName,\n startTime,\n}: { esError: ",
|
||||
{
|
||||
"pluginId": "observability",
|
||||
"scope": "server",
|
||||
"docId": "kibObservabilityPluginApi",
|
||||
"section": "def-server.WrappedElasticsearchClientError",
|
||||
"text": "WrappedElasticsearchClientError"
|
||||
},
|
||||
" | null; esRequestParams: Record<string, any>; esRequestStatus: ",
|
||||
{
|
||||
"pluginId": "inspector",
|
||||
"scope": "common",
|
||||
"docId": "kibInspectorPluginApi",
|
||||
"section": "def-common.RequestStatus",
|
||||
"text": "RequestStatus"
|
||||
},
|
||||
"; esResponse: any; kibanaRequest: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>; operationName: string; startTime: number; }) => ",
|
||||
{
|
||||
"pluginId": "inspector",
|
||||
"scope": "common",
|
||||
"docId": "kibInspectorPluginApi",
|
||||
"section": "def-common.Request",
|
||||
"text": "Request"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/observability/server/utils/get_inspect_response.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-server.getInspectResponse.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "{\n esError,\n esRequestParams,\n esRequestStatus,\n esResponse,\n kibanaRequest,\n operationName,\n startTime,\n}",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/observability/server/utils/get_inspect_response.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-server.getInspectResponse.$1.esError",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "esError",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "observability",
|
||||
"scope": "server",
|
||||
"docId": "kibObservabilityPluginApi",
|
||||
"section": "def-server.WrappedElasticsearchClientError",
|
||||
"text": "WrappedElasticsearchClientError"
|
||||
},
|
||||
" | null"
|
||||
],
|
||||
"path": "x-pack/plugins/observability/server/utils/get_inspect_response.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-server.getInspectResponse.$1.esRequestParams",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "esRequestParams",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [x: string]: any; }"
|
||||
],
|
||||
"path": "x-pack/plugins/observability/server/utils/get_inspect_response.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-server.getInspectResponse.$1.esRequestStatus",
|
||||
"type": "Enum",
|
||||
"tags": [],
|
||||
"label": "esRequestStatus",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "inspector",
|
||||
"scope": "common",
|
||||
"docId": "kibInspectorPluginApi",
|
||||
"section": "def-common.RequestStatus",
|
||||
"text": "RequestStatus"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/observability/server/utils/get_inspect_response.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-server.getInspectResponse.$1.esResponse",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "esResponse",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"path": "x-pack/plugins/observability/server/utils/get_inspect_response.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-server.getInspectResponse.$1.kibanaRequest",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "kibanaRequest",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>"
|
||||
],
|
||||
"path": "x-pack/plugins/observability/server/utils/get_inspect_response.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-server.getInspectResponse.$1.operationName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "operationName",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/observability/server/utils/get_inspect_response.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-server.getInspectResponse.$1.startTime",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "startTime",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/observability/server/utils/get_inspect_response.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-server.kqlQuery",
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Observability UI](https://github.com/orgs/elastic/teams/observability-u
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 245 | 0 | 245 | 10 |
|
||||
| 258 | 1 | 257 | 12 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -12,13 +12,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
|
||||
| Count | Plugins or Packages with a <br /> public API | Number of teams |
|
||||
|--------------|----------|------------------------|
|
||||
| 201 | 156 | 32 |
|
||||
| 202 | 158 | 32 |
|
||||
|
||||
### Public API health stats
|
||||
|
||||
| API Count | Any Count | Missing comments | Missing exports |
|
||||
|--------------|----------|-----------------|--------|
|
||||
| 24158 | 274 | 19590 | 1579 |
|
||||
| 24409 | 277 | 19821 | 1585 |
|
||||
|
||||
## Plugin Directory
|
||||
|
||||
|
|
@ -27,23 +27,23 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibActionsPluginApi" text="actions"/> | [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-services) | - | 125 | 0 | 125 | 8 |
|
||||
| <DocLink id="kibAdvancedSettingsPluginApi" text="advancedSettings"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 23 | 0 | 22 | 1 |
|
||||
| <DocLink id="kibAlertingPluginApi" text="alerting"/> | [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-services) | - | 249 | 0 | 241 | 17 |
|
||||
| <DocLink id="kibApmPluginApi" text="apm"/> | [APM UI](https://github.com/orgs/elastic/teams/apm-ui) | - | 42 | 0 | 42 | 37 |
|
||||
| <DocLink id="kibApmPluginApi" text="apm"/> | [APM UI](https://github.com/orgs/elastic/teams/apm-ui) | The user interface for Elastic APM | 42 | 0 | 42 | 37 |
|
||||
| <DocLink id="kibApmOssPluginApi" text="apmOss"/> | [APM UI](https://github.com/orgs/elastic/teams/apm-ui) | - | 6 | 0 | 6 | 0 |
|
||||
| <DocLink id="kibBannersPluginApi" text="banners"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 9 | 0 | 9 | 0 |
|
||||
| <DocLink id="kibBfetchPluginApi" text="bfetch"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Considering using bfetch capabilities when fetching large amounts of data. This services supports batching HTTP requests and streaming responses back. | 77 | 1 | 66 | 2 |
|
||||
| <DocLink id="kibCanvasPluginApi" text="canvas"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Canvas application to Kibana | 9 | 0 | 8 | 3 |
|
||||
| <DocLink id="kibCasesPluginApi" text="cases"/> | [Security Solution Threat Hunting](https://github.com/orgs/elastic/teams/security-threat-hunting) | The Case management system in Kibana | 475 | 0 | 431 | 14 |
|
||||
| <DocLink id="kibChartsPluginApi" text="charts"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 223 | 2 | 192 | 3 |
|
||||
| <DocLink id="kibChartsPluginApi" text="charts"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 285 | 4 | 253 | 3 |
|
||||
| <DocLink id="kibCloudPluginApi" text="cloud"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 22 | 0 | 22 | 0 |
|
||||
| <DocLink id="kibConsolePluginApi" text="console"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 9 | 0 | 9 | 1 |
|
||||
| <DocLink id="kibCorePluginApi" text="core"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2293 | 27 | 1020 | 29 |
|
||||
| <DocLink id="kibCorePluginApi" text="core"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2300 | 27 | 1019 | 29 |
|
||||
| crossClusterReplication | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 |
|
||||
| <DocLink id="kibCustomIntegrationsPluginApi" text="customIntegrations"/> | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 85 | 1 | 78 | 1 |
|
||||
| <DocLink id="kibDashboardPluginApi" text="dashboard"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 145 | 1 | 132 | 10 |
|
||||
| <DocLink id="kibDashboardEnhancedPluginApi" text="dashboardEnhanced"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 51 | 0 | 50 | 0 |
|
||||
| <DocLink id="kibDataPluginApi" text="data"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | 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. | 3181 | 43 | 2796 | 48 |
|
||||
| <DocLink id="kibDataPluginApi" text="data"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | 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. | 3192 | 43 | 2807 | 48 |
|
||||
| <DocLink id="kibDataEnhancedPluginApi" text="dataEnhanced"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Enhanced data plugin. (See src/plugins/data.) Enhances the main data plugin with a search session management UI. Includes a reusable search session indicator component to use in other applications. Exposes routes for managing search sessions. Includes a service that monitors, updates, and cleans up search session saved objects. | 16 | 0 | 16 | 2 |
|
||||
| <DocLink id="kibDataViewsPluginApi" text="dataViews"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | 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. | 671 | 6 | 531 | 5 |
|
||||
| <DocLink id="kibDataViewsPluginApi" text="dataViews"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | 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. | 681 | 6 | 541 | 5 |
|
||||
| <DocLink id="kibDataVisualizerPluginApi" text="dataVisualizer"/> | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The Data Visualizer tools help you understand your data, by analyzing the metrics and fields in a log file or an existing Elasticsearch index. | 80 | 5 | 80 | 0 |
|
||||
| <DocLink id="kibDevToolsPluginApi" text="devTools"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 10 | 0 | 8 | 2 |
|
||||
| <DocLink id="kibDiscoverPluginApi" text="discover"/> | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the Discover application and the saved search embeddable. | 82 | 0 | 56 | 6 |
|
||||
|
|
@ -57,6 +57,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibExpressionErrorPluginApi" text="expressionError"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'error' renderer to expressions | 12 | 0 | 12 | 2 |
|
||||
| <DocLink id="kibExpressionImagePluginApi" text="expressionImage"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'image' function and renderer to expressions | 24 | 0 | 24 | 0 |
|
||||
| <DocLink id="kibExpressionMetricPluginApi" text="expressionMetric"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'metric' function and renderer to expressions | 30 | 0 | 25 | 0 |
|
||||
| <DocLink id="kibExpressionMetricVisPluginApi" text="expressionMetricVis"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression MetricVis plugin adds a `metric` renderer and function to the expression plugin. The renderer will display the `metric` chart. | 49 | 0 | 49 | 0 |
|
||||
| <DocLink id="kibExpressionRepeatImagePluginApi" text="expressionRepeatImage"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'repeatImage' function and renderer to expressions | 30 | 0 | 30 | 0 |
|
||||
| <DocLink id="kibExpressionRevealImagePluginApi" text="expressionRevealImage"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'revealImage' function and renderer to expressions | 12 | 0 | 12 | 3 |
|
||||
| <DocLink id="kibExpressionShapePluginApi" text="expressionShape"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'shape' function and renderer to expressions | 143 | 0 | 143 | 0 |
|
||||
|
|
@ -65,7 +66,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibFeaturesPluginApi" text="features"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 216 | 0 | 98 | 2 |
|
||||
| <DocLink id="kibFieldFormatsPluginApi" text="fieldFormats"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Index pattern fields and ambiguous values formatters | 288 | 7 | 250 | 3 |
|
||||
| <DocLink id="kibFileUploadPluginApi" text="fileUpload"/> | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The file upload plugin contains components and services for uploading a file, analyzing its data, and then importing the data into an Elasticsearch index. Supported file types include CSV, TSV, newline-delimited JSON and GeoJSON. | 129 | 4 | 129 | 1 |
|
||||
| <DocLink id="kibFleetPluginApi" text="fleet"/> | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1207 | 15 | 1106 | 10 |
|
||||
| <DocLink id="kibFleetPluginApi" text="fleet"/> | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1207 | 15 | 1107 | 10 |
|
||||
| <DocLink id="kibGlobalSearchPluginApi" text="globalSearch"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 68 | 0 | 14 | 5 |
|
||||
| globalSearchBar | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 |
|
||||
| globalSearchProviders | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 |
|
||||
|
|
@ -81,13 +82,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| ingestPipelines | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 |
|
||||
| inputControlVis | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Input Control visualization to Kibana | 0 | 0 | 0 | 0 |
|
||||
| <DocLink id="kibInspectorPluginApi" text="inspector"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 123 | 6 | 96 | 4 |
|
||||
| <DocLink id="kibInteractiveSetupPluginApi" text="interactiveSetup"/> | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides UI and APIs for the interactive setup mode. | 19 | 0 | 9 | 0 |
|
||||
| <DocLink id="kibInteractiveSetupPluginApi" text="interactiveSetup"/> | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides UI and APIs for the interactive setup mode. | 26 | 0 | 16 | 0 |
|
||||
| <DocLink id="kibKibanaLegacyPluginApi" text="kibanaLegacy"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 48 | 1 | 45 | 0 |
|
||||
| <DocLink id="kibKibanaOverviewPluginApi" text="kibanaOverview"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 6 | 0 | 6 | 0 |
|
||||
| <DocLink id="kibKibanaReactPluginApi" text="kibanaReact"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 297 | 8 | 260 | 5 |
|
||||
| kibanaUsageCollection | [Kibana Telemtry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 0 | 0 | 0 | 0 |
|
||||
| <DocLink id="kibKibanaUtilsPluginApi" text="kibanaUtils"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 603 | 3 | 410 | 8 |
|
||||
| <DocLink id="kibLensPluginApi" text="lens"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 252 | 0 | 234 | 24 |
|
||||
| <DocLink id="kibKibanaUtilsPluginApi" text="kibanaUtils"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 606 | 3 | 413 | 8 |
|
||||
| <DocLink id="kibLensPluginApi" text="lens"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 253 | 0 | 235 | 24 |
|
||||
| <DocLink id="kibLicenseApiGuardPluginApi" text="licenseApiGuard"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 8 | 0 | 8 | 0 |
|
||||
| <DocLink id="kibLicenseManagementPluginApi" text="licenseManagement"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 3 | 0 | 3 | 0 |
|
||||
| <DocLink id="kibLicensingPluginApi" text="licensing"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 117 | 0 | 42 | 8 |
|
||||
|
|
@ -101,7 +102,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibMonitoringPluginApi" text="monitoring"/> | [Stack Monitoring](https://github.com/orgs/elastic/teams/stack-monitoring-ui) | - | 10 | 0 | 10 | 2 |
|
||||
| <DocLink id="kibNavigationPluginApi" text="navigation"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 31 | 0 | 31 | 2 |
|
||||
| <DocLink id="kibNewsfeedPluginApi" text="newsfeed"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 17 | 0 | 17 | 0 |
|
||||
| <DocLink id="kibObservabilityPluginApi" text="observability"/> | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 245 | 0 | 245 | 10 |
|
||||
| <DocLink id="kibObservabilityPluginApi" text="observability"/> | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 258 | 1 | 257 | 12 |
|
||||
| <DocLink id="kibOsqueryPluginApi" text="osquery"/> | [Security asset management](https://github.com/orgs/elastic/teams/security-asset-management) | - | 11 | 0 | 11 | 0 |
|
||||
| painlessLab | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 |
|
||||
| <DocLink id="kibPresentationUtilPluginApi" text="presentationUtil"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 178 | 3 | 151 | 5 |
|
||||
|
|
@ -117,11 +118,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibScreenshotModePluginApi" text="screenshotMode"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 22 | 0 | 17 | 1 |
|
||||
| searchprofiler | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 |
|
||||
| <DocLink id="kibSecurityPluginApi" text="security"/> | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides authentication and authorization features, and exposes functionality to understand the capabilities of the currently authenticated user. | 113 | 0 | 51 | 7 |
|
||||
| <DocLink id="kibSecurityOssPluginApi" text="securityOss"/> | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin exposes a limited set of security functionality to OSS plugins. | 12 | 0 | 9 | 3 |
|
||||
| <DocLink id="kibSecuritySolutionPluginApi" text="securitySolution"/> | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 1353 | 8 | 1299 | 29 |
|
||||
| <DocLink id="kibSharePluginApi" text="share"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds URL Service and sharing capabilities to Kibana | 137 | 1 | 90 | 10 |
|
||||
| <DocLink id="kibSecuritySolutionPluginApi" text="securitySolution"/> | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 1361 | 8 | 1307 | 30 |
|
||||
| <DocLink id="kibSharePluginApi" text="share"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds URL Service and sharing capabilities to Kibana | 143 | 1 | 90 | 10 |
|
||||
| <DocLink id="kibSnapshotRestorePluginApi" text="snapshotRestore"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 23 | 1 | 22 | 1 |
|
||||
| <DocLink id="kibSpacesPluginApi" text="spaces"/> | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides the Spaces feature, which allows saved objects to be organized into meaningful categories. | 205 | 0 | 21 | 2 |
|
||||
| <DocLink id="kibSpacesPluginApi" text="spaces"/> | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides the Spaces feature, which allows saved objects to be organized into meaningful categories. | 208 | 0 | 21 | 1 |
|
||||
| <DocLink id="kibStackAlertsPluginApi" text="stackAlerts"/> | [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-services) | - | 4 | 0 | 4 | 0 |
|
||||
| <DocLink id="kibTaskManagerPluginApi" text="taskManager"/> | [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-services) | - | 70 | 0 | 32 | 7 |
|
||||
| <DocLink id="kibTelemetryPluginApi" text="telemetry"/> | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 41 | 0 | 0 | 0 |
|
||||
|
|
@ -129,7 +129,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibTelemetryCollectionXpackPluginApi" text="telemetryCollectionXpack"/> | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 1 | 0 | 1 | 0 |
|
||||
| <DocLink id="kibTelemetryManagementSectionPluginApi" text="telemetryManagementSection"/> | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 14 | 0 | 13 | 0 |
|
||||
| <DocLink id="kibTimelinesPluginApi" text="timelines"/> | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 968 | 6 | 847 | 25 |
|
||||
| transform | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the transforms features provided by Elastic. Transforms enable you to convert existing Elasticsearch indices into summarized indices, which provide opportunities for new insights and analytics. | 0 | 0 | 0 | 0 |
|
||||
| <DocLink id="kibTransformPluginApi" text="transform"/> | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the transforms features provided by Elastic. Transforms enable you to convert existing Elasticsearch indices into summarized indices, which provide opportunities for new insights and analytics. | 4 | 0 | 4 | 1 |
|
||||
| translations | [Kibana Localization](https://github.com/orgs/elastic/teams/kibana-localization) | - | 0 | 0 | 0 | 0 |
|
||||
| <DocLink id="kibTriggersActionsUiPluginApi" text="triggersActionsUi"/> | [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-services) | - | 239 | 1 | 230 | 18 |
|
||||
| <DocLink id="kibUiActionsPluginApi" text="uiActions"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds UI Actions service to Kibana | 127 | 0 | 88 | 11 |
|
||||
|
|
@ -150,7 +150,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibVisTypeVegaPluginApi" text="visTypeVega"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Registers the vega visualization. Is the elastic version of vega and vega-lite libraries. | 2 | 0 | 2 | 0 |
|
||||
| <DocLink id="kibVisTypeVislibPluginApi" text="visTypeVislib"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the vislib visualizations. These are the classical area/line/bar, pie, gauge/goal and heatmap charts. We want to replace them with elastic-charts. | 26 | 0 | 25 | 1 |
|
||||
| <DocLink id="kibVisTypeXyPluginApi" text="visTypeXy"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the new xy-axis chart using the elastic-charts library, which will eventually replace the vislib xy-axis charts including bar, area, and line. | 57 | 0 | 51 | 5 |
|
||||
| <DocLink id="kibVisualizationsPluginApi" text="visualizations"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 275 | 13 | 257 | 15 |
|
||||
| <DocLink id="kibVisualizationsPluginApi" text="visualizations"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 304 | 13 | 286 | 16 |
|
||||
| <DocLink id="kibVisualizePluginApi" text="visualize"/> | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the visualize application which includes the listing page and the app frame, which will load the visualization's editor. | 24 | 0 | 23 | 1 |
|
||||
| watcher | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 |
|
||||
| xpackLegacy | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 |
|
||||
|
|
@ -159,6 +159,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
|
||||
| Package name | Maintaining team | Description | API Cnt | Any Cnt | Missing<br />comments | Missing<br />exports |
|
||||
|--------------|----------------|-----------|--------------|----------|---------------|--------|
|
||||
| <DocLink id="kibElasticApmGeneratorPluginApi" text="@elastic/apm-generator"/> | [Owner missing] | Elastic APM trace data generator | 15 | 0 | 15 | 2 |
|
||||
| <DocLink id="kibElasticDatemathPluginApi" text="@elastic/datemath"/> | [Owner missing] | elasticsearch datemath parser, used in kibana | 44 | 0 | 43 | 0 |
|
||||
| <DocLink id="kibKbnAcePluginApi" text="@kbn/ace"/> | [Owner missing] | - | 11 | 5 | 11 | 0 |
|
||||
| <DocLink id="kibKbnAlertsPluginApi" text="@kbn/alerts"/> | [Owner missing] | Alerts components and hooks | 9 | 1 | 9 | 0 |
|
||||
|
|
@ -166,20 +167,20 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibKbnApmConfigLoaderPluginApi" text="@kbn/apm-config-loader"/> | [Owner missing] | - | 14 | 0 | 14 | 0 |
|
||||
| <DocLink id="kibKbnApmUtilsPluginApi" text="@kbn/apm-utils"/> | [Owner missing] | - | 11 | 0 | 11 | 0 |
|
||||
| <DocLink id="kibKbnCliDevModePluginApi" text="@kbn/cli-dev-mode"/> | [Owner missing] | - | 2 | 0 | 2 | 0 |
|
||||
| <DocLink id="kibKbnConfigPluginApi" text="@kbn/config"/> | [Owner missing] | - | 57 | 0 | 42 | 2 |
|
||||
| <DocLink id="kibKbnConfigPluginApi" text="@kbn/config"/> | [Owner missing] | - | 66 | 0 | 46 | 1 |
|
||||
| <DocLink id="kibKbnConfigSchemaPluginApi" text="@kbn/config-schema"/> | [Owner missing] | - | 109 | 3 | 107 | 18 |
|
||||
| <DocLink id="kibKbnCryptoPluginApi" text="@kbn/crypto"/> | [Owner missing] | - | 13 | 0 | 7 | 0 |
|
||||
| <DocLink id="kibKbnDevUtilsPluginApi" text="@kbn/dev-utils"/> | [Owner missing] | - | 258 | 7 | 231 | 4 |
|
||||
| <DocLink id="kibKbnDocsUtilsPluginApi" text="@kbn/docs-utils"/> | [Owner missing] | - | 1 | 0 | 1 | 0 |
|
||||
| <DocLink id="kibKbnEsArchiverPluginApi" text="@kbn/es-archiver"/> | [Owner missing] | - | 25 | 0 | 12 | 1 |
|
||||
| <DocLink id="kibKbnEsQueryPluginApi" text="@kbn/es-query"/> | [Owner missing] | - | 198 | 2 | 146 | 12 |
|
||||
| <DocLink id="kibKbnEsQueryPluginApi" text="@kbn/es-query"/> | [Owner missing] | - | 205 | 2 | 153 | 14 |
|
||||
| <DocLink id="kibKbnFieldTypesPluginApi" text="@kbn/field-types"/> | [Owner missing] | - | 20 | 0 | 16 | 0 |
|
||||
| <DocLink id="kibKbnI18nPluginApi" text="@kbn/i18n"/> | [Owner missing] | - | 2 | 0 | 2 | 2 |
|
||||
| <DocLink id="kibKbnIoTsUtilsPluginApi" text="@kbn/io-ts-utils"/> | [Owner missing] | - | 18 | 0 | 18 | 2 |
|
||||
| <DocLink id="kibKbnLoggingPluginApi" text="@kbn/logging"/> | [Owner missing] | - | 30 | 0 | 5 | 37 |
|
||||
| <DocLink id="kibKbnMapboxGlPluginApi" text="@kbn/mapbox-gl"/> | [Owner missing] | - | 467 | 9 | 378 | 0 |
|
||||
| <DocLink id="kibKbnMonacoPluginApi" text="@kbn/monaco"/> | [Owner missing] | - | 28 | 0 | 28 | 3 |
|
||||
| <DocLink id="kibKbnOptimizerPluginApi" text="@kbn/optimizer"/> | [Owner missing] | - | 42 | 0 | 42 | 9 |
|
||||
| <DocLink id="kibKbnMonacoPluginApi" text="@kbn/monaco"/> | [Owner missing] | - | 38 | 0 | 38 | 3 |
|
||||
| <DocLink id="kibKbnOptimizerPluginApi" text="@kbn/optimizer"/> | [Owner missing] | - | 44 | 0 | 44 | 9 |
|
||||
| <DocLink id="kibKbnPluginGeneratorPluginApi" text="@kbn/plugin-generator"/> | [Owner missing] | - | 1 | 0 | 1 | 0 |
|
||||
| <DocLink id="kibKbnPluginHelpersPluginApi" text="@kbn/plugin-helpers"/> | [Owner missing] | Just some helpers for kibana plugin devs. | 1 | 0 | 1 | 0 |
|
||||
| <DocLink id="kibKbnPmPluginApi" text="@kbn/pm"/> | [Owner missing] | - | 63 | 0 | 49 | 5 |
|
||||
|
|
@ -203,7 +204,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibKbnStorybookPluginApi" text="@kbn/storybook"/> | [Owner missing] | - | 18 | 1 | 18 | 0 |
|
||||
| <DocLink id="kibKbnTelemetryToolsPluginApi" text="@kbn/telemetry-tools"/> | [Owner missing] | - | 2 | 0 | 2 | 0 |
|
||||
| <DocLink id="kibKbnTestPluginApi" text="@kbn/test"/> | [Owner missing] | - | 200 | 5 | 177 | 9 |
|
||||
| <DocLink id="kibKbnTypedReactRouterConfigPluginApi" text="@kbn/typed-react-router-config"/> | [Owner missing] | - | 71 | 0 | 71 | 1 |
|
||||
| <DocLink id="kibKbnTypedReactRouterConfigPluginApi" text="@kbn/typed-react-router-config"/> | [Owner missing] | - | 78 | 0 | 78 | 1 |
|
||||
| <DocLink id="kibKbnUtilityTypesPluginApi" text="@kbn/utility-types"/> | [Owner missing] | - | 29 | 1 | 10 | 1 |
|
||||
| <DocLink id="kibKbnUtilsPluginApi" text="@kbn/utils"/> | [Owner missing] | - | 31 | 1 | 21 | 0 |
|
||||
|
||||
|
|
|
|||
|
|
@ -2118,14 +2118,6 @@
|
|||
"plugin": "discover",
|
||||
"path": "src/plugins/discover/public/application/apps/main/discover_main_route.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "visualizations",
|
||||
"path": "src/plugins/visualizations/public/types.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "visualizations",
|
||||
"path": "src/plugins/visualizations/public/types.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "visualizations",
|
||||
"path": "src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts"
|
||||
|
|
|
|||
|
|
@ -412,7 +412,9 @@
|
|||
"label": "config",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{} & { enabled: boolean; signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; alertIgnoreFields: string[]; enableExperimental: string[]; endpointResultListDefaultFirstPageIndex: number; endpointResultListDefaultPageSize: number; packagerTaskInterval: string; prebuiltRulesFromFileSystem: boolean; prebuiltRulesFromSavedObjects: boolean; }>"
|
||||
"Readonly<{} & { enabled: boolean; signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; alertIgnoreFields: string[]; enableExperimental: string[]; ruleExecutionLog: Readonly<{} & { underlyingClient: ",
|
||||
"UnderlyingLogClient",
|
||||
"; }>; endpointResultListDefaultFirstPageIndex: number; endpointResultListDefaultPageSize: number; packagerTaskInterval: string; prebuiltRulesFromFileSystem: boolean; prebuiltRulesFromSavedObjects: boolean; }>"
|
||||
],
|
||||
"path": "x-pack/plugins/security_solution/server/client/client.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -845,7 +847,9 @@
|
|||
"label": "ConfigType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly enabled: boolean; readonly signalsIndex: string; readonly maxRuleImportExportSize: number; readonly maxRuleImportPayloadBytes: number; readonly maxTimelineImportExportSize: number; readonly maxTimelineImportPayloadBytes: number; readonly alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; readonly alertIgnoreFields: string[]; readonly enableExperimental: string[]; readonly endpointResultListDefaultFirstPageIndex: number; readonly endpointResultListDefaultPageSize: number; readonly packagerTaskInterval: string; readonly prebuiltRulesFromFileSystem: boolean; readonly prebuiltRulesFromSavedObjects: boolean; }"
|
||||
"{ readonly enabled: boolean; readonly signalsIndex: string; readonly maxRuleImportExportSize: number; readonly maxRuleImportPayloadBytes: number; readonly maxTimelineImportExportSize: number; readonly maxTimelineImportPayloadBytes: number; readonly alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; readonly alertIgnoreFields: string[]; readonly enableExperimental: string[]; readonly ruleExecutionLog: Readonly<{} & { underlyingClient: ",
|
||||
"UnderlyingLogClient",
|
||||
"; }>; readonly endpointResultListDefaultFirstPageIndex: number; readonly endpointResultListDefaultPageSize: number; readonly packagerTaskInterval: string; readonly prebuiltRulesFromFileSystem: boolean; readonly prebuiltRulesFromSavedObjects: boolean; }"
|
||||
],
|
||||
"path": "x-pack/plugins/security_solution/server/config.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -2437,12 +2441,15 @@
|
|||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.BrowserField.subType",
|
||||
"type": "Object",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "subType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [key: string]: unknown; nested?: { path: string; } | undefined; } | undefined"
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -2942,13 +2949,9 @@
|
|||
"text": "ColumnHeaderType"
|
||||
},
|
||||
"; description?: string | undefined; example?: string | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubType",
|
||||
"text": "IFieldSubType"
|
||||
},
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined; type?: string | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
|
||||
|
|
@ -7725,18 +7728,194 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.HostsRiskyHostsStrategyResponse",
|
||||
"id": "def-common.HostsRiskScore",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "HostsRiskyHostsStrategyResponse",
|
||||
"label": "HostsRiskScore",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.HostsRiskScore.host",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "host",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ name: string; }"
|
||||
],
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.HostsRiskScore.risk_score",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "risk_score",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.HostsRiskScore.risk",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "risk",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.HostsRiskScoreRequestOptions",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "HostsRiskScoreRequestOptions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "securitySolution",
|
||||
"scope": "common",
|
||||
"docId": "kibSecuritySolutionPluginApi",
|
||||
"section": "def-common.HostsRiskyHostsStrategyResponse",
|
||||
"text": "HostsRiskyHostsStrategyResponse"
|
||||
"section": "def-common.HostsRiskScoreRequestOptions",
|
||||
"text": "HostsRiskScoreRequestOptions"
|
||||
},
|
||||
" extends ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.IEsSearchRequest",
|
||||
"text": "IEsSearchRequest"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.HostsRiskScoreRequestOptions.defaultIndex",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "defaultIndex",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string[]"
|
||||
],
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.HostsRiskScoreRequestOptions.factoryQueryType",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "factoryQueryType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "securitySolution",
|
||||
"scope": "common",
|
||||
"docId": "kibSecuritySolutionPluginApi",
|
||||
"section": "def-common.HostsQueries",
|
||||
"text": "HostsQueries"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "securitySolution",
|
||||
"scope": "common",
|
||||
"docId": "kibSecuritySolutionPluginApi",
|
||||
"section": "def-common.HostsKpiQueries",
|
||||
"text": "HostsKpiQueries"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "securitySolution",
|
||||
"scope": "common",
|
||||
"docId": "kibSecuritySolutionPluginApi",
|
||||
"section": "def-common.UebaQueries",
|
||||
"text": "UebaQueries"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "securitySolution",
|
||||
"scope": "common",
|
||||
"docId": "kibSecuritySolutionPluginApi",
|
||||
"section": "def-common.NetworkQueries",
|
||||
"text": "NetworkQueries"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "securitySolution",
|
||||
"scope": "common",
|
||||
"docId": "kibSecuritySolutionPluginApi",
|
||||
"section": "def-common.NetworkKpiQueries",
|
||||
"text": "NetworkKpiQueries"
|
||||
},
|
||||
" | ",
|
||||
"CtiQueries",
|
||||
" | \"matrixHistogram\" | \"matrixHistogramEntities\" | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.HostsRiskScoreRequestOptions.hostName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "hostName",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.HostsRiskScoreRequestOptions.timerange",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "timerange",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "timelines",
|
||||
"scope": "common",
|
||||
"docId": "kibTimelinesPluginApi",
|
||||
"section": "def-common.TimerangeInput",
|
||||
"text": "TimerangeInput"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.HostsRiskScoreStrategyResponse",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "HostsRiskScoreStrategyResponse",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "securitySolution",
|
||||
"scope": "common",
|
||||
"docId": "kibSecuritySolutionPluginApi",
|
||||
"section": "def-common.HostsRiskScoreStrategyResponse",
|
||||
"text": "HostsRiskScoreStrategyResponse"
|
||||
},
|
||||
" extends ",
|
||||
{
|
||||
|
|
@ -7748,12 +7927,12 @@
|
|||
},
|
||||
"<any>"
|
||||
],
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risky_hosts/index.ts",
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.HostsRiskyHostsStrategyResponse.inspect",
|
||||
"id": "def-common.HostsRiskScoreStrategyResponse.inspect",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "inspect",
|
||||
|
|
@ -7768,7 +7947,7 @@
|
|||
},
|
||||
" | null | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risky_hosts/index.ts",
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risk_score/index.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
|
|
@ -8937,18 +9116,14 @@
|
|||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.IndexField.subType",
|
||||
"type": "Object",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "subType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubType",
|
||||
"text": "IFieldSubType"
|
||||
},
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/index_fields/index.ts",
|
||||
|
|
@ -19263,13 +19438,9 @@
|
|||
"text": "ColumnHeaderType"
|
||||
},
|
||||
"; description?: string | undefined; example?: string | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubType",
|
||||
"text": "IFieldSubType"
|
||||
},
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined; type?: string | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
|
||||
|
|
@ -19832,26 +20003,6 @@
|
|||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.HostsRiskyHostsRequestOptions",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "HostsRiskyHostsRequestOptions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "securitySolution",
|
||||
"scope": "common",
|
||||
"docId": "kibSecuritySolutionPluginApi",
|
||||
"section": "def-common.RequestBasicOptions",
|
||||
"text": "RequestBasicOptions"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/security_solution/common/search_strategy/security_solution/hosts/risky_hosts/index.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "securitySolution",
|
||||
"id": "def-common.HostTacticsSortField",
|
||||
|
|
@ -21393,13 +21544,13 @@
|
|||
"section": "def-common.HostsQueries",
|
||||
"text": "HostsQueries"
|
||||
},
|
||||
".riskyHosts ? ",
|
||||
".hostsRiskScore ? ",
|
||||
{
|
||||
"pluginId": "securitySolution",
|
||||
"scope": "common",
|
||||
"docId": "kibSecuritySolutionPluginApi",
|
||||
"section": "def-common.RequestBasicOptions",
|
||||
"text": "RequestBasicOptions"
|
||||
"section": "def-common.HostsRiskScoreRequestOptions",
|
||||
"text": "HostsRiskScoreRequestOptions"
|
||||
},
|
||||
" : T extends ",
|
||||
{
|
||||
|
|
@ -21883,13 +22034,13 @@
|
|||
"section": "def-common.HostsQueries",
|
||||
"text": "HostsQueries"
|
||||
},
|
||||
".riskyHosts ? ",
|
||||
".hostsRiskScore ? ",
|
||||
{
|
||||
"pluginId": "securitySolution",
|
||||
"scope": "common",
|
||||
"docId": "kibSecuritySolutionPluginApi",
|
||||
"section": "def-common.HostsRiskyHostsStrategyResponse",
|
||||
"text": "HostsRiskyHostsStrategyResponse"
|
||||
"section": "def-common.HostsRiskScoreStrategyResponse",
|
||||
"text": "HostsRiskScoreStrategyResponse"
|
||||
},
|
||||
" : T extends ",
|
||||
{
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Security solution](https://github.com/orgs/elastic/teams/security-solut
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 1353 | 8 | 1299 | 29 |
|
||||
| 1361 | 8 | 1307 | 30 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -1912,7 +1912,15 @@
|
|||
"section": "def-server.SerializableRecord",
|
||||
"text": "SerializableRecord"
|
||||
},
|
||||
">): void; }"
|
||||
">): void; setAnonymousAccessServiceProvider: (provider: () => ",
|
||||
{
|
||||
"pluginId": "share",
|
||||
"scope": "common",
|
||||
"docId": "kibSharePluginApi",
|
||||
"section": "def-common.AnonymousAccessServiceContract",
|
||||
"text": "AnonymousAccessServiceContract"
|
||||
},
|
||||
") => void; }"
|
||||
],
|
||||
"path": "src/plugins/share/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -2224,6 +2232,107 @@
|
|||
}
|
||||
],
|
||||
"interfaces": [
|
||||
{
|
||||
"parentPluginId": "share",
|
||||
"id": "def-common.AnonymousAccessServiceContract",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "AnonymousAccessServiceContract",
|
||||
"description": [
|
||||
"\nThe contract that is used to check anonymous access for the purposes of sharing public links. The implementation is intended to be\nprovided by the security plugin."
|
||||
],
|
||||
"path": "src/plugins/share/common/anonymous_access/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "share",
|
||||
"id": "def-common.AnonymousAccessServiceContract.getState",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getState",
|
||||
"description": [
|
||||
"\nThis function returns the current state of anonymous access."
|
||||
],
|
||||
"signature": [
|
||||
"() => Promise<",
|
||||
{
|
||||
"pluginId": "share",
|
||||
"scope": "common",
|
||||
"docId": "kibSharePluginApi",
|
||||
"section": "def-common.AnonymousAccessState",
|
||||
"text": "AnonymousAccessState"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"path": "src/plugins/share/common/anonymous_access/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "share",
|
||||
"id": "def-common.AnonymousAccessServiceContract.getCapabilities",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getCapabilities",
|
||||
"description": [
|
||||
"\nThis function returns the capabilities of the anonymous access user."
|
||||
],
|
||||
"signature": [
|
||||
"() => Promise<",
|
||||
"Capabilities",
|
||||
">"
|
||||
],
|
||||
"path": "src/plugins/share/common/anonymous_access/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "share",
|
||||
"id": "def-common.AnonymousAccessState",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "AnonymousAccessState",
|
||||
"description": [
|
||||
"\nThe state of anonymous access."
|
||||
],
|
||||
"path": "src/plugins/share/common/anonymous_access/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "share",
|
||||
"id": "def-common.AnonymousAccessState.isEnabled",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "isEnabled",
|
||||
"description": [
|
||||
"\nWhether anonymous access is enabled or not."
|
||||
],
|
||||
"path": "src/plugins/share/common/anonymous_access/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "share",
|
||||
"id": "def-common.AnonymousAccessState.accessURLParameters",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "accessURLParameters",
|
||||
"description": [
|
||||
"\nIf anonymous access is enabled, this reflects what URL parameters need to be added to a Kibana link to make it publicly accessible.\nNote that if anonymous access is the only authentication method, this will be null."
|
||||
],
|
||||
"signature": [
|
||||
"Record<string, string> | null"
|
||||
],
|
||||
"path": "src/plugins/share/common/anonymous_access/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "share",
|
||||
"id": "def-common.LocatorDefinition",
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 137 | 1 | 90 | 10 |
|
||||
| 143 | 1 | 90 | 10 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -295,6 +295,45 @@
|
|||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "spaces",
|
||||
"id": "def-public.EmbeddableLegacyUrlConflictProps",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "EmbeddableLegacyUrlConflictProps",
|
||||
"description": [
|
||||
"\nProperties for the EmbeddableLegacyUrlConflict component."
|
||||
],
|
||||
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "spaces",
|
||||
"id": "def-public.EmbeddableLegacyUrlConflictProps.targetType",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "targetType",
|
||||
"description": [
|
||||
"\nThe target type of the legacy URL alias."
|
||||
],
|
||||
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "spaces",
|
||||
"id": "def-public.EmbeddableLegacyUrlConflictProps.sourceId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "sourceId",
|
||||
"description": [
|
||||
"\nThe source ID of the legacy URL alias."
|
||||
],
|
||||
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "spaces",
|
||||
"id": "def-public.GetSpaceResult",
|
||||
|
|
@ -359,7 +398,7 @@
|
|||
"description": [
|
||||
"\nProperties for the LegacyUrlConflict component."
|
||||
],
|
||||
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
||||
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
|
|
@ -374,7 +413,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
||||
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -386,7 +425,7 @@
|
|||
"description": [
|
||||
"\nThe ID of the object that is currently shown on the page."
|
||||
],
|
||||
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
||||
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -398,7 +437,7 @@
|
|||
"description": [
|
||||
"\nThe ID of the other object that the legacy URL alias points to."
|
||||
],
|
||||
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
||||
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -408,9 +447,9 @@
|
|||
"tags": [],
|
||||
"label": "otherObjectPath",
|
||||
"description": [
|
||||
"\nThe path to use for the new URL, optionally including `search` and/or `hash` URL components."
|
||||
"\n The path within your application to use for the new URL, optionally including `search` and/or `hash` URL components. Do not include\n `/app/my-app` or the current base path."
|
||||
],
|
||||
"path": "x-pack/plugins/spaces/public/share_saved_objects_to_space/types.ts",
|
||||
"path": "x-pack/plugins/spaces/public/legacy_urls/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
|
|
@ -1303,6 +1342,45 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "spaces",
|
||||
"id": "def-public.SpacesApiUiComponent.getEmbeddableLegacyUrlConflict",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getEmbeddableLegacyUrlConflict",
|
||||
"description": [
|
||||
"\nDisplays a callout that needs to be used if an embeddable component call to `SavedObjectsClient.resolve()` results in an `\"conflict\"`\noutcome, which indicates that the user has loaded an embeddable which is associated directly with one object (A), *and* with a legacy\nURL that points to a different object (B)."
|
||||
],
|
||||
"signature": [
|
||||
"(props: ",
|
||||
{
|
||||
"pluginId": "spaces",
|
||||
"scope": "public",
|
||||
"docId": "kibSpacesPluginApi",
|
||||
"section": "def-public.EmbeddableLegacyUrlConflictProps",
|
||||
"text": "EmbeddableLegacyUrlConflictProps"
|
||||
},
|
||||
") => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
||||
],
|
||||
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "spaces",
|
||||
"id": "def-public.SpacesApiUiComponent.getEmbeddableLegacyUrlConflict.$1",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "spaces",
|
||||
"id": "def-public.SpacesApiUiComponent.getLegacyUrlConflict",
|
||||
|
|
@ -1380,39 +1458,6 @@
|
|||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "spaces",
|
||||
"id": "def-public.SpacesApiUiComponent.getSavedObjectConflictMessage",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getSavedObjectConflictMessage",
|
||||
"description": [
|
||||
"\nDisplays a saved object conflict message that directs user to disable legacy URL alias"
|
||||
],
|
||||
"signature": [
|
||||
"(props: ",
|
||||
"SavedObjectConflictMessageProps",
|
||||
") => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
|
||||
],
|
||||
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "spaces",
|
||||
"id": "def-public.SpacesApiUiComponent.getSavedObjectConflictMessage.$1",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"path": "x-pack/plugins/spaces/public/ui_api/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Platform Security](https://github.com/orgs/elastic/teams/kibana-securit
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 205 | 0 | 21 | 2 |
|
||||
| 208 | 0 | 21 | 1 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -1657,13 +1657,9 @@
|
|||
"text": "ColumnHeaderType"
|
||||
},
|
||||
"; description?: string | undefined; example?: string | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubType",
|
||||
"text": "IFieldSubType"
|
||||
},
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined; type?: string | undefined; })[]; id: string; title: string; filters?: ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
|
|
@ -1709,13 +1705,9 @@
|
|||
"text": "ColumnHeaderType"
|
||||
},
|
||||
"; description?: string | undefined; example?: string | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubType",
|
||||
"text": "IFieldSubType"
|
||||
},
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined; type?: string | undefined; })[]; savedObjectId: string | null; unit?: ((n: number) => React.ReactNode) | undefined; dataProviders: ",
|
||||
{
|
||||
"pluginId": "timelines",
|
||||
|
|
@ -1732,15 +1724,15 @@
|
|||
"section": "def-common.RowRendererId",
|
||||
"text": "RowRendererId"
|
||||
},
|
||||
"[]; expandedDetail: ",
|
||||
"[]; expandedDetail: Partial<Record<string, ",
|
||||
{
|
||||
"pluginId": "timelines",
|
||||
"scope": "common",
|
||||
"docId": "kibTimelinesPluginApi",
|
||||
"section": "def-common.TimelineExpandedDetail",
|
||||
"text": "TimelineExpandedDetail"
|
||||
"section": "def-common.TimelineExpandedDetailType",
|
||||
"text": "TimelineExpandedDetailType"
|
||||
},
|
||||
"; footerText?: React.ReactNode; graphEventId?: string | undefined; kqlQuery: { filterQuery: ",
|
||||
">>; footerText?: React.ReactNode; graphEventId?: string | undefined; kqlQuery: { filterQuery: ",
|
||||
{
|
||||
"pluginId": "timelines",
|
||||
"scope": "common",
|
||||
|
|
@ -5582,12 +5574,15 @@
|
|||
{
|
||||
"parentPluginId": "timelines",
|
||||
"id": "def-common.BrowserField.subType",
|
||||
"type": "Object",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "subType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [key: string]: unknown; nested?: { path: string; } | undefined; } | undefined"
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -6153,13 +6148,9 @@
|
|||
"text": "ColumnHeaderType"
|
||||
},
|
||||
"; description?: string | undefined; example?: string | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubType",
|
||||
"text": "IFieldSubType"
|
||||
},
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined; type?: string | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
|
||||
|
|
@ -8418,18 +8409,14 @@
|
|||
{
|
||||
"parentPluginId": "timelines",
|
||||
"id": "def-common.IndexField.subType",
|
||||
"type": "Object",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "subType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubType",
|
||||
"text": "IFieldSubType"
|
||||
},
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
|
||||
|
|
@ -11273,14 +11260,15 @@
|
|||
"label": "expandedDetail",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Partial<Record<string, ",
|
||||
{
|
||||
"pluginId": "timelines",
|
||||
"scope": "common",
|
||||
"docId": "kibTimelinesPluginApi",
|
||||
"section": "def-common.TimelineExpandedDetail",
|
||||
"text": "TimelineExpandedDetail"
|
||||
"section": "def-common.TimelineExpandedDetailType",
|
||||
"text": "TimelineExpandedDetailType"
|
||||
},
|
||||
" | undefined"
|
||||
">> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -12716,13 +12704,9 @@
|
|||
"text": "ColumnHeaderType"
|
||||
},
|
||||
"; description?: string | undefined; example?: string | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.IFieldSubType",
|
||||
"text": "IFieldSubType"
|
||||
},
|
||||
"IFieldSubTypeMultiOptional",
|
||||
" | ",
|
||||
"IFieldSubTypeNestedOptional",
|
||||
" | undefined; type?: string | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
|
||||
|
|
@ -14383,17 +14367,9 @@
|
|||
"label": "TimelineExpandedDetail",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ query?: Record<any, never> | { panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
|
||||
"{ [x: string]: { panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
|
||||
"Ecs",
|
||||
" | undefined; } | undefined; } | { panelView?: \"hostDetail\" | undefined; params?: { hostName: string; } | undefined; } | { panelView?: \"networkDetail\" | undefined; params?: { ip: string; flowTarget: FlowTarget; } | undefined; } | undefined; graph?: Record<any, never> | { panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
|
||||
"Ecs",
|
||||
" | undefined; } | undefined; } | { panelView?: \"hostDetail\" | undefined; params?: { hostName: string; } | undefined; } | { panelView?: \"networkDetail\" | undefined; params?: { ip: string; flowTarget: FlowTarget; } | undefined; } | undefined; notes?: Record<any, never> | { panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
|
||||
"Ecs",
|
||||
" | undefined; } | undefined; } | { panelView?: \"hostDetail\" | undefined; params?: { hostName: string; } | undefined; } | { panelView?: \"networkDetail\" | undefined; params?: { ip: string; flowTarget: FlowTarget; } | undefined; } | undefined; pinned?: Record<any, never> | { panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
|
||||
"Ecs",
|
||||
" | undefined; } | undefined; } | { panelView?: \"hostDetail\" | undefined; params?: { hostName: string; } | undefined; } | { panelView?: \"networkDetail\" | undefined; params?: { ip: string; flowTarget: FlowTarget; } | undefined; } | undefined; eql?: Record<any, never> | { panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
|
||||
"Ecs",
|
||||
" | undefined; } | undefined; } | { panelView?: \"hostDetail\" | undefined; params?: { hostName: string; } | undefined; } | { panelView?: \"networkDetail\" | undefined; params?: { ip: string; flowTarget: FlowTarget; } | undefined; } | undefined; }"
|
||||
" | undefined; } | undefined; } | Partial<Record<any, never>> | { panelView?: \"hostDetail\" | undefined; params?: { hostName: string; } | undefined; } | { panelView?: \"networkDetail\" | undefined; params?: { ip: string; flowTarget: FlowTarget; } | undefined; } | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -14407,9 +14383,9 @@
|
|||
"label": "TimelineExpandedDetailType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<any, never> | { panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
|
||||
"{ panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
|
||||
"Ecs",
|
||||
" | undefined; } | undefined; } | { panelView?: \"hostDetail\" | undefined; params?: { hostName: string; } | undefined; } | { panelView?: \"networkDetail\" | undefined; params?: { ip: string; flowTarget: FlowTarget; } | undefined; }"
|
||||
" | undefined; } | undefined; } | Partial<Record<any, never>> | { panelView?: \"hostDetail\" | undefined; params?: { hostName: string; } | undefined; } | { panelView?: \"networkDetail\" | undefined; params?: { ip: string; flowTarget: FlowTarget; } | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -14423,9 +14399,9 @@
|
|||
"label": "TimelineExpandedEventType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<any, never> | { panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
|
||||
"{ panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
|
||||
"Ecs",
|
||||
" | undefined; } | undefined; }"
|
||||
" | undefined; } | undefined; } | Partial<Record<any, never>>"
|
||||
],
|
||||
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -14439,7 +14415,7 @@
|
|||
"label": "TimelineExpandedHostType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<any, never> | { panelView?: \"hostDetail\" | undefined; params?: { hostName: string; } | undefined; }"
|
||||
"Partial<Record<any, never>> | { panelView?: \"hostDetail\" | undefined; params?: { hostName: string; } | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -14453,7 +14429,7 @@
|
|||
"label": "TimelineExpandedNetworkType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Record<any, never> | { panelView?: \"networkDetail\" | undefined; params?: { ip: string; flowTarget: FlowTarget; } | undefined; }"
|
||||
"Partial<Record<any, never>> | { panelView?: \"networkDetail\" | undefined; params?: { ip: string; flowTarget: FlowTarget; } | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -14894,7 +14870,9 @@
|
|||
"label": "ToggleDetailPanel",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(Record<any, never> & { tabType?: ",
|
||||
"({ panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
|
||||
"Ecs",
|
||||
" | undefined; } | undefined; } & { tabType?: ",
|
||||
{
|
||||
"pluginId": "timelines",
|
||||
"scope": "common",
|
||||
|
|
@ -14902,9 +14880,7 @@
|
|||
"section": "def-common.TimelineTabs",
|
||||
"text": "TimelineTabs"
|
||||
},
|
||||
" | undefined; timelineId: string; }) | ({ panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
|
||||
"Ecs",
|
||||
" | undefined; } | undefined; } & { tabType?: ",
|
||||
" | undefined; timelineId: string; }) | (Partial<Record<any, never>> & { tabType?: ",
|
||||
{
|
||||
"pluginId": "timelines",
|
||||
"scope": "common",
|
||||
|
|
|
|||
101
api_docs/transform.json
Normal file
101
api_docs/transform.json
Normal file
|
|
@ -0,0 +1,101 @@
|
|||
{
|
||||
"id": "transform",
|
||||
"client": {
|
||||
"classes": [],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "transform",
|
||||
"id": "def-public.getTransformHealthRuleType",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getTransformHealthRuleType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
{
|
||||
"pluginId": "triggersActionsUi",
|
||||
"scope": "public",
|
||||
"docId": "kibTriggersActionsUiPluginApi",
|
||||
"section": "def-public.AlertTypeModel",
|
||||
"text": "AlertTypeModel"
|
||||
},
|
||||
"<",
|
||||
"TransformHealthRuleParams",
|
||||
">"
|
||||
],
|
||||
"path": "x-pack/plugins/transform/public/alerting/transform_health_rule_type/register_transform_health_rule.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"server": {
|
||||
"classes": [],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "transform",
|
||||
"id": "def-server.registerTransformHealthRuleType",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "registerTransformHealthRuleType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(params: RegisterParams) => void"
|
||||
],
|
||||
"path": "x-pack/plugins/transform/server/lib/alerting/transform_health_rule_type/register_transform_health_rule_type.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "transform",
|
||||
"id": "def-server.registerTransformHealthRuleType.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"RegisterParams"
|
||||
],
|
||||
"path": "x-pack/plugins/transform/server/lib/alerting/transform_health_rule_type/register_transform_health_rule_type.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"common": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": [
|
||||
{
|
||||
"parentPluginId": "transform",
|
||||
"id": "def-common.TRANSFORM_RULE_TYPE",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "TRANSFORM_RULE_TYPE",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly TRANSFORM_HEALTH: \"transform_health\"; }"
|
||||
],
|
||||
"path": "x-pack/plugins/transform/common/constants.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
37
api_docs/transform.mdx
Normal file
37
api_docs/transform.mdx
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
id: kibTransformPluginApi
|
||||
slug: /kibana-dev-docs/api/transform
|
||||
title: "transform"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the transform plugin
|
||||
date: 2020-11-16
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'transform']
|
||||
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 transformObj from './transform.json';
|
||||
|
||||
This plugin provides access to the transforms features provided by Elastic. Transforms enable you to convert existing Elasticsearch indices into summarized indices, which provide opportunities for new insights and analytics.
|
||||
|
||||
Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 4 | 0 | 4 | 1 |
|
||||
|
||||
## Client
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={transformObj.client.functions}/>
|
||||
|
||||
## Server
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={transformObj.server.functions}/>
|
||||
|
||||
## Common
|
||||
|
||||
### Objects
|
||||
<DocDefinitionList data={transformObj.common.objects}/>
|
||||
|
||||
|
|
@ -943,9 +943,9 @@
|
|||
"<T extends \"colorSchema\" | \"invertColors\">(paramName: T, value: ",
|
||||
{
|
||||
"pluginId": "charts",
|
||||
"scope": "public",
|
||||
"scope": "common",
|
||||
"docId": "kibChartsPluginApi",
|
||||
"section": "def-public.ColorSchemaParams",
|
||||
"section": "def-common.ColorSchemaParams",
|
||||
"text": "ColorSchemaParams"
|
||||
},
|
||||
"[T]) => void"
|
||||
|
|
@ -977,9 +977,9 @@
|
|||
"signature": [
|
||||
{
|
||||
"pluginId": "charts",
|
||||
"scope": "public",
|
||||
"scope": "common",
|
||||
"docId": "kibChartsPluginApi",
|
||||
"section": "def-public.ColorSchemaParams",
|
||||
"section": "def-common.ColorSchemaParams",
|
||||
"text": "ColorSchemaParams"
|
||||
},
|
||||
"[T]"
|
||||
|
|
|
|||
|
|
@ -107,9 +107,9 @@
|
|||
"signature": [
|
||||
{
|
||||
"pluginId": "charts",
|
||||
"scope": "public",
|
||||
"scope": "common",
|
||||
"docId": "kibChartsPluginApi",
|
||||
"section": "def-public.Labels",
|
||||
"section": "def-common.Labels",
|
||||
"text": "Labels"
|
||||
}
|
||||
],
|
||||
|
|
|
|||
|
|
@ -141,9 +141,9 @@
|
|||
"signature": [
|
||||
{
|
||||
"pluginId": "charts",
|
||||
"scope": "public",
|
||||
"scope": "common",
|
||||
"docId": "kibChartsPluginApi",
|
||||
"section": "def-public.Labels",
|
||||
"section": "def-common.Labels",
|
||||
"text": "Labels"
|
||||
}
|
||||
],
|
||||
|
|
@ -231,9 +231,9 @@
|
|||
"Partial<",
|
||||
{
|
||||
"pluginId": "charts",
|
||||
"scope": "public",
|
||||
"scope": "common",
|
||||
"docId": "kibChartsPluginApi",
|
||||
"section": "def-public.Style",
|
||||
"section": "def-common.Style",
|
||||
"text": "Style"
|
||||
},
|
||||
"> | undefined"
|
||||
|
|
|
|||
|
|
@ -1140,6 +1140,37 @@
|
|||
}
|
||||
],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.getFullPath",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getFullPath",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(id: string) => string"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.getFullPath.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.getVisSchemas",
|
||||
|
|
@ -1360,6 +1391,37 @@
|
|||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.urlFor",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "urlFor",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(id: string) => string"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.urlFor.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisualizationContainer",
|
||||
|
|
@ -1494,6 +1556,98 @@
|
|||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.GetVisOptions",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "GetVisOptions",
|
||||
"description": [],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.GetVisOptions.id",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.GetVisOptions.searchSource",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "searchSource",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.GetVisOptions.migrationVersion",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "migrationVersion",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SavedObjectsMigrationVersion",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.GetVisOptions.savedSearchId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "savedSearchId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.GetVisOptions.type",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "type",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.GetVisOptions.indexPattern",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "indexPattern",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.HistogramParams",
|
||||
|
|
@ -1640,6 +1794,19 @@
|
|||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.ISavedVis.sharingSavedObjectProps",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "sharingSavedObjectProps",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ outcome?: \"conflict\" | \"exactMatch\" | \"aliasMatch\" | undefined; aliasTargetId?: string | undefined; errorJSON?: string | undefined; } | undefined"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -2531,14 +2698,6 @@
|
|||
"text": "VisSavedObject"
|
||||
},
|
||||
" extends ",
|
||||
{
|
||||
"pluginId": "savedObjects",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObject",
|
||||
"text": "SavedObject"
|
||||
},
|
||||
",",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
|
|
@ -2549,7 +2708,119 @@
|
|||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisSavedObject.lastSavedTitle",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "lastSavedTitle",
|
||||
"description": [],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisSavedObject.getEsType",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getEsType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => string"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisSavedObject.getDisplayName",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getDisplayName",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(() => string) | undefined"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisSavedObject.displayName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "displayName",
|
||||
"description": [],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisSavedObject.migrationVersion",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "migrationVersion",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SavedObjectsMigrationVersion",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisSavedObject.searchSource",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "searchSource",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataSearchPluginApi",
|
||||
"section": "def-common.SearchSource",
|
||||
"text": "SearchSource"
|
||||
},
|
||||
", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisSavedObject.version",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "version",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisSavedObject.tags",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "tags",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string[] | undefined"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
@ -4788,8 +5059,8 @@
|
|||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.ISavedVis",
|
||||
"text": "ISavedVis"
|
||||
"section": "def-public.VisSavedObject",
|
||||
"text": "VisSavedObject"
|
||||
},
|
||||
") => ",
|
||||
{
|
||||
|
|
@ -4825,11 +5096,11 @@
|
|||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.ISavedVis",
|
||||
"text": "ISavedVis"
|
||||
"section": "def-public.VisSavedObject",
|
||||
"text": "VisSavedObject"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts",
|
||||
"path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
|
|
@ -4896,7 +5167,7 @@
|
|||
},
|
||||
">"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/saved_visualizations/_saved_vis.ts",
|
||||
"path": "src/plugins/visualizations/public/utils/saved_visualize_utils.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
|
|
@ -4932,6 +5203,193 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisualizationsStart.getSavedVisualization",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getSavedVisualization",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(opts?: string | ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.GetVisOptions",
|
||||
"text": "GetVisOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisSavedObject",
|
||||
"text": "VisSavedObject"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisualizationsStart.getSavedVisualization.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "opts",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.GetVisOptions",
|
||||
"text": "GetVisOptions"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisualizationsStart.saveVisualization",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "saveVisualization",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(savedVis: ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisSavedObject",
|
||||
"text": "VisSavedObject"
|
||||
},
|
||||
", saveOptions: ",
|
||||
"SaveVisOptions",
|
||||
") => Promise<string>"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisualizationsStart.saveVisualization.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "savedVis",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "public",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-public.VisSavedObject",
|
||||
"text": "VisSavedObject"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisualizationsStart.saveVisualization.$2",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "saveOptions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SaveVisOptions"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisualizationsStart.findListItems",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "findListItems",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(searchTerm: string, listingLimit: number, references?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptionsReference",
|
||||
"text": "SavedObjectsFindOptionsReference"
|
||||
},
|
||||
"[] | undefined) => Promise<{ hits: Record<string, unknown>[]; total: number; }>"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisualizationsStart.findListItems.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "searchTerm",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisualizationsStart.findListItems.$2",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "listingLimit",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisualizationsStart.findListItems.$3",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "references",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptionsReference",
|
||||
"text": "SavedObjectsFindOptionsReference"
|
||||
},
|
||||
"[] | undefined"
|
||||
],
|
||||
"path": "src/plugins/visualizations/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "visualizations",
|
||||
"id": "def-public.VisualizationsStart.__LEGACY",
|
||||
|
|
@ -4964,17 +5422,7 @@
|
|||
"section": "def-public.VisualizeInput",
|
||||
"text": "VisualizeInput"
|
||||
},
|
||||
"> & { id: string; }, savedVisualizationsLoader?: (",
|
||||
{
|
||||
"pluginId": "savedObjects",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectLoader",
|
||||
"text": "SavedObjectLoader"
|
||||
},
|
||||
" & { findListItems: (search: string, sizeOrOptions?: number | ",
|
||||
"FindListItemsOptions",
|
||||
" | undefined) => any; }) | undefined, attributeService?: ",
|
||||
"> & { id: string; }, attributeService?: ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 275 | 13 | 257 | 15 |
|
||||
| 304 | 13 | 286 | 16 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -24,7 +24,6 @@ The constructor for this class is marked as internal. Third-party code should no
|
|||
| [DEFAULT](./kibana-plugin-core-server.cspconfig.default.md) | <code>static</code> | <code>CspConfig</code> | |
|
||||
| [disableEmbedding](./kibana-plugin-core-server.cspconfig.disableembedding.md) | | <code>boolean</code> | |
|
||||
| [header](./kibana-plugin-core-server.cspconfig.header.md) | | <code>string</code> | |
|
||||
| [rules](./kibana-plugin-core-server.cspconfig.rules.md) | | <code>string[]</code> | |
|
||||
| [strict](./kibana-plugin-core-server.cspconfig.strict.md) | | <code>boolean</code> | |
|
||||
| [warnLegacyBrowsers](./kibana-plugin-core-server.cspconfig.warnlegacybrowsers.md) | | <code>boolean</code> | |
|
||||
|
||||
|
|
|
|||
|
|
@ -1,11 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [CspConfig](./kibana-plugin-core-server.cspconfig.md) > [rules](./kibana-plugin-core-server.cspconfig.rules.md)
|
||||
|
||||
## CspConfig.rules property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly rules: string[];
|
||||
```
|
||||
|
|
@ -16,6 +16,7 @@ correctiveActions: {
|
|||
body?: {
|
||||
[key: string]: any;
|
||||
};
|
||||
omitContextFromBody?: boolean;
|
||||
};
|
||||
manualSteps: string[];
|
||||
};
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ export interface DeprecationsDetails
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [correctiveActions](./kibana-plugin-core-server.deprecationsdetails.correctiveactions.md) | <code>{</code><br/><code> api?: {</code><br/><code> path: string;</code><br/><code> method: 'POST' | 'PUT';</code><br/><code> body?: {</code><br/><code> [key: string]: any;</code><br/><code> };</code><br/><code> };</code><br/><code> manualSteps: string[];</code><br/><code> }</code> | corrective action needed to fix this deprecation. |
|
||||
| [correctiveActions](./kibana-plugin-core-server.deprecationsdetails.correctiveactions.md) | <code>{</code><br/><code> api?: {</code><br/><code> path: string;</code><br/><code> method: 'POST' | 'PUT';</code><br/><code> body?: {</code><br/><code> [key: string]: any;</code><br/><code> };</code><br/><code> omitContextFromBody?: boolean;</code><br/><code> };</code><br/><code> manualSteps: string[];</code><br/><code> }</code> | corrective action needed to fix this deprecation. |
|
||||
| [deprecationType](./kibana-plugin-core-server.deprecationsdetails.deprecationtype.md) | <code>'config' | 'feature'</code> | (optional) Used to identify between different deprecation types. Example use case: in Upgrade Assistant, we may want to allow the user to sort by deprecation type or show each type in a separate tab.<!-- -->Feel free to add new types if necessary. Predefined types are necessary to reduce having similar definitions with different keywords across kibana deprecations. |
|
||||
| [documentationUrl](./kibana-plugin-core-server.deprecationsdetails.documentationurl.md) | <code>string</code> | (optional) link to the documentation for more details on the deprecation. |
|
||||
| [level](./kibana-plugin-core-server.deprecationsdetails.level.md) | <code>'warning' | 'critical' | 'fetch_error'</code> | levels: - warning: will not break deployment upon upgrade - critical: needs to be addressed before upgrade. - fetch\_error: Deprecations service failed to grab the deprecation details for the domain. |
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
## ICspConfig.disableEmbedding property
|
||||
|
||||
Whether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled \*and\* no custom rules have been defined, a restrictive 'frame-ancestors' rule will be added to the default CSP rules.
|
||||
Whether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
|
|
|
|||
|
|
@ -16,9 +16,8 @@ export interface ICspConfig
|
|||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [disableEmbedding](./kibana-plugin-core-server.icspconfig.disableembedding.md) | <code>boolean</code> | Whether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled \*and\* no custom rules have been defined, a restrictive 'frame-ancestors' rule will be added to the default CSP rules. |
|
||||
| [disableEmbedding](./kibana-plugin-core-server.icspconfig.disableembedding.md) | <code>boolean</code> | Whether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules. |
|
||||
| [header](./kibana-plugin-core-server.icspconfig.header.md) | <code>string</code> | The CSP rules in a formatted directives string for use in a <code>Content-Security-Policy</code> header. |
|
||||
| [rules](./kibana-plugin-core-server.icspconfig.rules.md) | <code>string[]</code> | The CSP rules used for Kibana. |
|
||||
| [strict](./kibana-plugin-core-server.icspconfig.strict.md) | <code>boolean</code> | Specify whether browsers that do not support CSP should be able to use Kibana. Use <code>true</code> to block and <code>false</code> to allow. |
|
||||
| [warnLegacyBrowsers](./kibana-plugin-core-server.icspconfig.warnlegacybrowsers.md) | <code>boolean</code> | Specify whether users with legacy browsers should be warned about their lack of Kibana security compliance. |
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICspConfig](./kibana-plugin-core-server.icspconfig.md) > [rules](./kibana-plugin-core-server.icspconfig.rules.md)
|
||||
|
||||
## ICspConfig.rules property
|
||||
|
||||
The CSP rules used for Kibana.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
readonly rules: string[];
|
||||
```
|
||||
|
|
@ -48,6 +48,12 @@ for example, `logstash-*`.
|
|||
|
||||
*Impact:* To allow Kibana to function for these legacy browsers, set `csp.strict: false`. Since this is about enforcing a security protocol, we *strongly discourage* disabling `csp.strict` unless it is critical that you support Internet Explorer 11.
|
||||
|
||||
[float]
|
||||
==== Configuring content security policy rules is no longer supported
|
||||
*Details:* Configuring `csp.rules` is removed in favor of per-directive specific configuration. Configuring the default `csp.script_src`, `csp.workers_src` and `csp.style_src` values is not required.
|
||||
|
||||
*Impact:* Configure per-directive sources instead. See https://github.com/elastic/kibana/pull/102059 for more details.
|
||||
|
||||
[float]
|
||||
==== Default logging timezone is now the system's timezone
|
||||
*Details:* In prior releases the timezone used in logs defaulted to UTC. We now use the host machine's timezone by default.
|
||||
|
|
|
|||
|
|
@ -40,57 +40,71 @@ Changing these settings may disable features of the APM App.
|
|||
|
||||
[cols="2*<"]
|
||||
|===
|
||||
| `xpack.apm.enabled`
|
||||
| `xpack.apm.enabled` {ess-icon}
|
||||
| deprecated:[7.16.0,"In 8.0 and later, this setting will no longer be supported."]
|
||||
Set to `false` to disable the APM app. Defaults to `true`.
|
||||
|
||||
| `xpack.apm.maxServiceEnvironments`
|
||||
| `xpack.apm.maxServiceEnvironments` {ess-icon}
|
||||
| Maximum number of unique service environments recognized by the UI. Defaults to `100`.
|
||||
|
||||
| `xpack.apm.serviceMapFingerprintBucketSize`
|
||||
| `xpack.apm.serviceMapFingerprintBucketSize` {ess-icon}
|
||||
| Maximum number of unique transaction combinations sampled for generating service map focused on a specific service. Defaults to `100`.
|
||||
|
||||
| `xpack.apm.serviceMapFingerprintGlobalBucketSize`
|
||||
| `xpack.apm.serviceMapFingerprintGlobalBucketSize` {ess-icon}
|
||||
| Maximum number of unique transaction combinations sampled for generating the global service map. Defaults to `100`.
|
||||
|
||||
| `xpack.apm.serviceMapEnabled` {ess-icon}
|
||||
| Set to `false` to disable service maps. Defaults to `true`.
|
||||
|
||||
| `xpack.apm.serviceMapTraceIdBucketSize` {ess-icon}
|
||||
| Maximum number of trace IDs sampled for generating service map focused on a specific service. Defaults to `65`.
|
||||
|
||||
| `xpack.apm.serviceMapTraceIdGlobalBucketSize` {ess-icon}
|
||||
| Maximum number of trace IDs sampled for generating the global service map. Defaults to `6`.
|
||||
|
||||
| `xpack.apm.serviceMapMaxTracesPerRequest` {ess-icon}
|
||||
| Maximum number of traces per request for generating the global service map. Defaults to `50`.
|
||||
|
||||
| `xpack.apm.ui.enabled` {ess-icon}
|
||||
| Set to `false` to hide the APM app from the main menu. Defaults to `true`.
|
||||
|
||||
| `xpack.apm.ui.transactionGroupBucketSize`
|
||||
| `xpack.apm.ui.transactionGroupBucketSize` {ess-icon}
|
||||
| Number of top transaction groups displayed in the APM app. Defaults to `1000`.
|
||||
|
||||
| `xpack.apm.ui.maxTraceItems` {ess-icon}
|
||||
| Maximum number of child items displayed when viewing trace details. Defaults to `1000`.
|
||||
|
||||
| `xpack.observability.annotations.index`
|
||||
| `xpack.observability.annotations.index` {ess-icon}
|
||||
| Index name where Observability annotations are stored. Defaults to `observability-annotations`.
|
||||
|
||||
| `xpack.apm.searchAggregatedTransactions`
|
||||
| `xpack.apm.searchAggregatedTransactions` {ess-icon}
|
||||
| experimental[] Enables Transaction histogram metrics. Defaults to `never` and aggregated transactions are not used. When set to `auto`, the UI will use metric indices over transaction indices for transactions if aggregated transactions are found. When set to `always`, additional configuration in APM Server is required.
|
||||
See {apm-server-ref-v}/transaction-metrics.html[Configure transaction metrics] for more information.
|
||||
|
||||
| `apm_oss.indexPattern` {ess-icon}
|
||||
| The index pattern used for integrations with Machine Learning and Query Bar.
|
||||
It must match all apm indices. Defaults to `apm-*`.
|
||||
| `xpack.apm.metricsInterval` {ess-icon}
|
||||
| Sets a `fixed_interval` for date histograms in metrics aggregations. Defaults to `30`.
|
||||
|
||||
| `apm_oss.errorIndices` {ess-icon}
|
||||
| `xpack.apm.agent.migrations.enabled` {ess-icon}
|
||||
| Set to `false` to disable cloud APM migrations. Defaults to `true`.
|
||||
|
||||
| `xpack.apm.errorIndices` {ess-icon}
|
||||
| Matcher for all {apm-server-ref}/error-indices.html[error indices]. Defaults to `apm-*`.
|
||||
|
||||
| `apm_oss.onboardingIndices`
|
||||
| `xpack.apm.onboardingIndices` {ess-icon}
|
||||
| Matcher for all onboarding indices. Defaults to `apm-*`.
|
||||
|
||||
| `apm_oss.spanIndices` {ess-icon}
|
||||
| `xpack.apm.spanIndices` {ess-icon}
|
||||
| Matcher for all {apm-server-ref}/span-indices.html[span indices]. Defaults to `apm-*`.
|
||||
|
||||
| `apm_oss.transactionIndices` {ess-icon}
|
||||
| `xpack.apm.transactionIndices` {ess-icon}
|
||||
| Matcher for all {apm-server-ref}/transaction-indices.html[transaction indices]. Defaults to `apm-*`.
|
||||
|
||||
| `apm_oss.metricsIndices`
|
||||
| `xpack.apm.metricsIndices` {ess-icon}
|
||||
| Matcher for all {apm-server-ref}/metricset-indices.html[metrics indices]. Defaults to `apm-*`.
|
||||
|
||||
| `apm_oss.sourcemapIndices`
|
||||
| `xpack.apm.sourcemapIndices` {ess-icon}
|
||||
| Matcher for all {apm-server-ref}/sourcemap-indices.html[source map indices]. Defaults to `apm-*`.
|
||||
|
||||
|===
|
||||
|
||||
// end::general-apm-settings[]
|
||||
// end::general-apm-settings[]
|
||||
|
|
@ -218,7 +218,7 @@ There is a very limited set of cases when you'd want to change these settings. F
|
|||
| Determines if HTTP authentication schemes used by the enabled authentication providers should be automatically supported during HTTP authentication. By default, this setting is set to `true`.
|
||||
|
||||
| `xpack.security.authc.http.schemes[]`
|
||||
| List of HTTP authentication schemes that {kib} HTTP authentication should support. By default, this setting is set to `['apikey']` to support HTTP authentication with <<api-keys, `ApiKey`>> scheme.
|
||||
| List of HTTP authentication schemes that {kib} HTTP authentication should support. By default, this setting is set to `['apikey', 'bearer']` to support HTTP authentication with the <<api-keys, `ApiKey`>> and <<http-authentication, `Bearer`>> schemes.
|
||||
|
||||
|===
|
||||
|
||||
|
|
|
|||
|
|
@ -26,13 +26,6 @@ Toggling this causes the server to regenerate assets on the next startup,
|
|||
which may cause a delay before pages start being served.
|
||||
Set to `false` to disable Console. *Default: `true`*
|
||||
|
||||
| `csp.rules:`
|
||||
| deprecated:[7.14.0,"In 8.0 and later, this setting will no longer be supported."]
|
||||
A https://w3c.github.io/webappsec-csp/[Content Security Policy] template
|
||||
that disables certain unnecessary and potentially insecure capabilities in
|
||||
the browser. It is strongly recommended that you keep the default CSP rules
|
||||
that ship with {kib}.
|
||||
|
||||
| `csp.script_src:`
|
||||
| Add sources for the https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/script-src[Content Security Policy `script-src` directive].
|
||||
|
||||
|
|
@ -502,8 +495,7 @@ To disable, set to `null`. *Default:* `null`
|
|||
| Controls whether the https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy[`Content-Security-Policy`] and
|
||||
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options[`X-Frame-Options`] headers are configured to disable embedding
|
||||
{kib} in other webpages using iframes. When set to `true`, secure headers are used to disable embedding, which adds the `frame-ancestors:
|
||||
'self'` directive to the `Content-Security-Policy` response header (if you are using the default CSP rules), and adds the `X-Frame-Options:
|
||||
SAMEORIGIN` response header. *Default:* `false`
|
||||
'self'` directive to the `Content-Security-Policy` response header and adds the `X-Frame-Options: SAMEORIGIN` response header. *Default:* `false`
|
||||
|
||||
| `server.customResponseHeaders:` {ess-icon}
|
||||
| Header names and values to
|
||||
|
|
|
|||
|
|
@ -437,14 +437,14 @@ This type of authentication is usually useful for machine-to-machine interaction
|
|||
|
||||
By default {kib} supports <<api-keys, `ApiKey`>> authentication scheme _and_ any scheme supported by the currently enabled authentication provider. For example, `Basic` authentication scheme is automatically supported when basic authentication provider is enabled, or `Bearer` scheme when any of the token based authentication providers is enabled (Token, SAML, OpenID Connect, PKI or Kerberos). But it's also possible to add support for any other authentication scheme in the `kibana.yml` configuration file, as follows:
|
||||
|
||||
NOTE: Don't forget to explicitly specify default `apikey` scheme when you just want to add a new one to the list.
|
||||
NOTE: Don't forget to explicitly specify the default `apikey` and `bearer` schemes when you just want to add a new one to the list.
|
||||
|
||||
[source,yaml]
|
||||
--------------------------------------------------------------------------------
|
||||
xpack.security.authc.http.schemes: [apikey, basic, something-custom]
|
||||
xpack.security.authc.http.schemes: [apikey, bearer, basic, something-custom]
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
With this configuration, you can send requests to {kib} with the `Authorization` header using `ApiKey`, `Basic` or `Something-Custom` HTTP schemes (case insensitive). Under the hood, {kib} relays this header to {es}, then {es} authenticates the request using the credentials in the header.
|
||||
With this configuration, you can send requests to {kib} with the `Authorization` header using `ApiKey`, `Bearer`, `Basic` or `Something-Custom` HTTP schemes (case insensitive). Under the hood, {kib} relays this header to {es}, then {es} authenticates the request using the credentials in the header.
|
||||
|
||||
[float]
|
||||
[[embedded-content-authentication]]
|
||||
|
|
|
|||
|
|
@ -22,24 +22,43 @@ import { parseConfig, Config } from './ci_stats_config';
|
|||
const BASE_URL = 'https://ci-stats.kibana.dev';
|
||||
|
||||
export interface CiStatsMetric {
|
||||
/** Top-level categorization for the metric, e.g. "page load bundle size" */
|
||||
group: string;
|
||||
/** Specific sub-set of the "group", e.g. "dashboard" */
|
||||
id: string;
|
||||
/** integer value recorded as the value of this metric */
|
||||
value: number;
|
||||
/** optional limit which will generate an error on PRs when the metric exceeds the limit */
|
||||
limit?: number;
|
||||
/**
|
||||
* path, relative to the repo, where the config file contianing limits
|
||||
* is kept. Linked from PR comments instructing contributors how to fix
|
||||
* their PRs.
|
||||
*/
|
||||
limitConfigPath?: string;
|
||||
/** Arbitrary key-value pairs which can be used for additional filtering/reporting */
|
||||
meta?: CiStatsMetadata;
|
||||
}
|
||||
|
||||
export interface CiStatsTimingMetadata {
|
||||
export interface CiStatsMetadata {
|
||||
/**
|
||||
* Arbitrary key-value pairs which can be attached to CiStatsTiming and CiStatsMetric
|
||||
* objects stored in the ci-stats service
|
||||
*/
|
||||
[key: string]: string | string[] | number | boolean | undefined;
|
||||
}
|
||||
export interface CiStatsTiming {
|
||||
/** Top-level categorization for the timing, e.g. "scripts/foo", process type, etc. */
|
||||
group: string;
|
||||
/** Specific timing (witin the "group" being tracked) e.g. "total" */
|
||||
id: string;
|
||||
/** time in milliseconds which should be recorded */
|
||||
ms: number;
|
||||
meta?: CiStatsTimingMetadata;
|
||||
/** hash of key-value pairs which will be stored with the timing for additional filtering and reporting */
|
||||
meta?: CiStatsMetadata;
|
||||
}
|
||||
|
||||
export interface ReqOptions {
|
||||
interface ReqOptions {
|
||||
auth: boolean;
|
||||
path: string;
|
||||
body: any;
|
||||
|
|
@ -54,17 +73,34 @@ export interface TimingsOptions {
|
|||
/** value of data/uuid, automatically loaded if not specified */
|
||||
kibanaUuid?: string | null;
|
||||
}
|
||||
|
||||
export interface MetricsOptions {
|
||||
/** Default metadata to add to each metric */
|
||||
defaultMeta?: CiStatsMetadata;
|
||||
}
|
||||
export class CiStatsReporter {
|
||||
/**
|
||||
* Create a CiStatsReporter by inspecting the ENV for the necessary config
|
||||
*/
|
||||
static fromEnv(log: ToolingLog) {
|
||||
return new CiStatsReporter(parseConfig(log), log);
|
||||
}
|
||||
|
||||
constructor(private config: Config | undefined, private log: ToolingLog) {}
|
||||
|
||||
/**
|
||||
* Determine if CI_STATS is explicitly disabled by the environment. To determine
|
||||
* if the CiStatsReporter has enough information in the environment to send metrics
|
||||
* for builds use #hasBuildConfig().
|
||||
*/
|
||||
isEnabled() {
|
||||
return process.env.CI_STATS_DISABLED !== 'true';
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines if the CiStatsReporter is disabled by the environment, or properly
|
||||
* configured and able to send stats
|
||||
*/
|
||||
hasBuildConfig() {
|
||||
return this.isEnabled() && !!this.config?.apiToken && !!this.config?.buildId;
|
||||
}
|
||||
|
|
@ -103,7 +139,7 @@ export class CiStatsReporter {
|
|||
const memUsage = process.memoryUsage();
|
||||
const isElasticCommitter = email && email.endsWith('@elastic.co') ? true : false;
|
||||
|
||||
const defaultMetadata = {
|
||||
const defaultMeta = {
|
||||
kibanaUuid,
|
||||
isElasticCommitter,
|
||||
committerHash: email
|
||||
|
|
@ -127,7 +163,7 @@ export class CiStatsReporter {
|
|||
totalMem: Os.totalmem(),
|
||||
};
|
||||
|
||||
this.log.debug('CIStatsReporter committerHash: %s', defaultMetadata.committerHash);
|
||||
this.log.debug('CIStatsReporter committerHash: %s', defaultMeta.committerHash);
|
||||
|
||||
return await this.req({
|
||||
auth: !!buildId,
|
||||
|
|
@ -135,8 +171,8 @@ export class CiStatsReporter {
|
|||
body: {
|
||||
buildId,
|
||||
upstreamBranch,
|
||||
defaultMeta,
|
||||
timings,
|
||||
defaultMetadata,
|
||||
},
|
||||
bodyDesc: timings.length === 1 ? `${timings.length} timing` : `${timings.length} timings`,
|
||||
});
|
||||
|
|
@ -146,7 +182,7 @@ export class CiStatsReporter {
|
|||
* Report metrics data to the ci-stats service. If running outside of CI this method
|
||||
* does nothing as metrics can only be reported when associated with a specific CI build.
|
||||
*/
|
||||
async metrics(metrics: CiStatsMetric[]) {
|
||||
async metrics(metrics: CiStatsMetric[], options?: MetricsOptions) {
|
||||
if (!this.hasBuildConfig()) {
|
||||
return;
|
||||
}
|
||||
|
|
@ -162,6 +198,7 @@ export class CiStatsReporter {
|
|||
path: '/v1/metrics',
|
||||
body: {
|
||||
buildId,
|
||||
defaultMeta: options?.defaultMeta,
|
||||
metrics,
|
||||
},
|
||||
bodyDesc: `metrics: ${metrics
|
||||
|
|
|
|||
|
|
@ -12,6 +12,10 @@ import { toArray, takeUntil } from 'rxjs/operators';
|
|||
import { ToolingLog } from './tooling_log';
|
||||
import { Writer } from './writer';
|
||||
import { ToolingLogTextWriter } from './tooling_log_text_writer';
|
||||
import { ToolingLogCollectingWriter } from './tooling_log_collecting_writer';
|
||||
import { createStripAnsiSerializer } from '../serializers/strip_ansi_serializer';
|
||||
|
||||
expect.addSnapshotSerializer(createStripAnsiSerializer());
|
||||
|
||||
it('creates zero writers without a config', () => {
|
||||
const log = new ToolingLog();
|
||||
|
|
@ -67,6 +71,30 @@ describe('#indent()', () => {
|
|||
|
||||
expect(write.mock.calls).toMatchSnapshot();
|
||||
});
|
||||
|
||||
it('resets the indentation after block executes and promise resolves', async () => {
|
||||
const log = new ToolingLog();
|
||||
const writer = new ToolingLogCollectingWriter();
|
||||
log.setWriters([writer]);
|
||||
|
||||
log.info('base');
|
||||
await log.indent(2, async () => {
|
||||
log.indent(2);
|
||||
log.info('hello');
|
||||
log.indent(2);
|
||||
log.info('world');
|
||||
});
|
||||
log.info('back to base');
|
||||
|
||||
expect(writer.messages).toMatchInlineSnapshot(`
|
||||
Array [
|
||||
" info base",
|
||||
" │ info hello",
|
||||
" │ info world",
|
||||
" info back to base",
|
||||
]
|
||||
`);
|
||||
});
|
||||
});
|
||||
|
||||
(['verbose', 'debug', 'info', 'success', 'warning', 'error', 'write'] as const).forEach(
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ import { Writer } from './writer';
|
|||
import { Message, MessageTypes } from './message';
|
||||
|
||||
export class ToolingLog {
|
||||
private identWidth = 0;
|
||||
private indentWidth = 0;
|
||||
private writers: Writer[];
|
||||
private readonly written$: Rx.Subject<Message>;
|
||||
|
||||
|
|
@ -22,9 +22,36 @@ export class ToolingLog {
|
|||
this.written$ = new Rx.Subject();
|
||||
}
|
||||
|
||||
public indent(delta = 0) {
|
||||
this.identWidth = Math.max(this.identWidth + delta, 0);
|
||||
return this.identWidth;
|
||||
/**
|
||||
* Get the current indentation level of the ToolingLog
|
||||
*/
|
||||
public getIndent() {
|
||||
return this.indentWidth;
|
||||
}
|
||||
|
||||
/**
|
||||
* Indent the output of the ToolingLog by some character (4 is a good choice usually).
|
||||
*
|
||||
* If provided, the `block` function will be executed and once it's promise is resolved
|
||||
* or rejected the indentation will be reset to its original state.
|
||||
*
|
||||
* @param delta the number of spaces to increase/decrease the indentation
|
||||
* @param block a function to run and reset any indentation changes after
|
||||
*/
|
||||
public indent<T>(delta = 0, block?: () => Promise<T>) {
|
||||
const originalWidth = this.indentWidth;
|
||||
this.indentWidth = Math.max(this.indentWidth + delta, 0);
|
||||
if (!block) {
|
||||
return;
|
||||
}
|
||||
|
||||
return (async () => {
|
||||
try {
|
||||
return await block();
|
||||
} finally {
|
||||
this.indentWidth = originalWidth;
|
||||
}
|
||||
})();
|
||||
}
|
||||
|
||||
public verbose(...args: any[]) {
|
||||
|
|
@ -70,7 +97,7 @@ export class ToolingLog {
|
|||
private sendToWriters(type: MessageTypes, args: any[]) {
|
||||
const msg = {
|
||||
type,
|
||||
indent: this.identWidth,
|
||||
indent: this.indentWidth,
|
||||
args,
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -1,76 +0,0 @@
|
|||
{
|
||||
"id": "pluginA.foo",
|
||||
"client": {
|
||||
"classes": [],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "pluginA",
|
||||
"id": "def-public.doTheFooFnThing",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "doTheFooFnThing",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => void"
|
||||
],
|
||||
"path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/foo/index.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "pluginA",
|
||||
"id": "def-public.FooType",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "FooType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => \"foo\""
|
||||
],
|
||||
"path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/public/foo/index.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": []
|
||||
},
|
||||
"server": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"common": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "pluginA",
|
||||
"id": "def-common.commonFoo",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "commonFoo",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"COMMON VAR!\""
|
||||
],
|
||||
"path": "packages/kbn-docs-utils/src/api_docs/tests/__fixtures__/src/plugin_a/common/foo/index.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": []
|
||||
}
|
||||
}
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
---
|
||||
id: kibPluginAFooPluginApi
|
||||
slug: /kibana-dev-docs/pluginA.fooPluginApi
|
||||
title: pluginA.foo
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the pluginA.foo plugin
|
||||
date: 2020-11-16
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'pluginA.foo']
|
||||
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 pluginA.fooObj from './plugin_a.foo.json';
|
||||
|
||||
|
||||
|
||||
Contact Kibana Core for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3 | 0 | 0 | 0 |
|
||||
|
||||
## Client
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={pluginA.fooObj.client.functions}/>
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={pluginA.fooObj.client.misc}/>
|
||||
|
||||
## Common
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={pluginA.fooObj.common.misc}/>
|
||||
|
||||
65
packages/kbn-pm/dist/index.js
vendored
65
packages/kbn-pm/dist/index.js
vendored
|
|
@ -626,16 +626,46 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
|
|||
*/
|
||||
class ToolingLog {
|
||||
constructor(writerConfig) {
|
||||
(0, _defineProperty2.default)(this, "identWidth", 0);
|
||||
(0, _defineProperty2.default)(this, "indentWidth", 0);
|
||||
(0, _defineProperty2.default)(this, "writers", void 0);
|
||||
(0, _defineProperty2.default)(this, "written$", void 0);
|
||||
this.writers = writerConfig ? [new _tooling_log_text_writer.ToolingLogTextWriter(writerConfig)] : [];
|
||||
this.written$ = new Rx.Subject();
|
||||
}
|
||||
/**
|
||||
* Get the current indentation level of the ToolingLog
|
||||
*/
|
||||
|
||||
indent(delta = 0) {
|
||||
this.identWidth = Math.max(this.identWidth + delta, 0);
|
||||
return this.identWidth;
|
||||
|
||||
getIndent() {
|
||||
return this.indentWidth;
|
||||
}
|
||||
/**
|
||||
* Indent the output of the ToolingLog by some character (4 is a good choice usually).
|
||||
*
|
||||
* If provided, the `block` function will be executed and once it's promise is resolved
|
||||
* or rejected the indentation will be reset to its original state.
|
||||
*
|
||||
* @param delta the number of spaces to increase/decrease the indentation
|
||||
* @param block a function to run and reset any indentation changes after
|
||||
*/
|
||||
|
||||
|
||||
indent(delta = 0, block) {
|
||||
const originalWidth = this.indentWidth;
|
||||
this.indentWidth = Math.max(this.indentWidth + delta, 0);
|
||||
|
||||
if (!block) {
|
||||
return;
|
||||
}
|
||||
|
||||
return (async () => {
|
||||
try {
|
||||
return await block();
|
||||
} finally {
|
||||
this.indentWidth = originalWidth;
|
||||
}
|
||||
})();
|
||||
}
|
||||
|
||||
verbose(...args) {
|
||||
|
|
@ -681,7 +711,7 @@ class ToolingLog {
|
|||
sendToWriters(type, args) {
|
||||
const msg = {
|
||||
type,
|
||||
indent: this.identWidth,
|
||||
indent: this.indentWidth,
|
||||
args
|
||||
};
|
||||
let written = false;
|
||||
|
|
@ -8980,6 +9010,9 @@ var _ci_stats_config = __webpack_require__(218);
|
|||
const BASE_URL = 'https://ci-stats.kibana.dev';
|
||||
|
||||
class CiStatsReporter {
|
||||
/**
|
||||
* Create a CiStatsReporter by inspecting the ENV for the necessary config
|
||||
*/
|
||||
static fromEnv(log) {
|
||||
return new CiStatsReporter((0, _ci_stats_config.parseConfig)(log), log);
|
||||
}
|
||||
|
|
@ -8988,10 +9021,21 @@ class CiStatsReporter {
|
|||
this.config = config;
|
||||
this.log = log;
|
||||
}
|
||||
/**
|
||||
* Determine if CI_STATS is explicitly disabled by the environment. To determine
|
||||
* if the CiStatsReporter has enough information in the environment to send metrics
|
||||
* for builds use #hasBuildConfig().
|
||||
*/
|
||||
|
||||
|
||||
isEnabled() {
|
||||
return process.env.CI_STATS_DISABLED !== 'true';
|
||||
}
|
||||
/**
|
||||
* Determines if the CiStatsReporter is disabled by the environment, or properly
|
||||
* configured and able to send stats
|
||||
*/
|
||||
|
||||
|
||||
hasBuildConfig() {
|
||||
var _this$config, _this$config2;
|
||||
|
|
@ -9039,7 +9083,7 @@ class CiStatsReporter {
|
|||
|
||||
const memUsage = process.memoryUsage();
|
||||
const isElasticCommitter = email && email.endsWith('@elastic.co') ? true : false;
|
||||
const defaultMetadata = {
|
||||
const defaultMeta = {
|
||||
kibanaUuid,
|
||||
isElasticCommitter,
|
||||
committerHash: email ? _crypto.default.createHash('sha256').update(email).digest('hex').substring(0, 20) : undefined,
|
||||
|
|
@ -9060,15 +9104,15 @@ class CiStatsReporter {
|
|||
osRelease: _os.default.release(),
|
||||
totalMem: _os.default.totalmem()
|
||||
};
|
||||
this.log.debug('CIStatsReporter committerHash: %s', defaultMetadata.committerHash);
|
||||
this.log.debug('CIStatsReporter committerHash: %s', defaultMeta.committerHash);
|
||||
return await this.req({
|
||||
auth: !!buildId,
|
||||
path: '/v1/timings',
|
||||
body: {
|
||||
buildId,
|
||||
upstreamBranch,
|
||||
timings,
|
||||
defaultMetadata
|
||||
defaultMeta,
|
||||
timings
|
||||
},
|
||||
bodyDesc: timings.length === 1 ? `${timings.length} timing` : `${timings.length} timings`
|
||||
});
|
||||
|
|
@ -9079,7 +9123,7 @@ class CiStatsReporter {
|
|||
*/
|
||||
|
||||
|
||||
async metrics(metrics) {
|
||||
async metrics(metrics, options) {
|
||||
var _this$config4;
|
||||
|
||||
if (!this.hasBuildConfig()) {
|
||||
|
|
@ -9097,6 +9141,7 @@ class CiStatsReporter {
|
|||
path: '/v1/metrics',
|
||||
body: {
|
||||
buildId,
|
||||
defaultMeta: options === null || options === void 0 ? void 0 : options.defaultMeta,
|
||||
metrics
|
||||
},
|
||||
bodyDesc: `metrics: ${metrics.map(({
|
||||
|
|
|
|||
|
|
@ -36,7 +36,11 @@ export function runStorybookCli({ configDir, name }: { configDir: string; name:
|
|||
async ({ flags, log }) => {
|
||||
log.debug('Global config:\n', constants);
|
||||
|
||||
const staticDir = [UiSharedDepsNpm.distDir, UiSharedDepsSrc.distDir];
|
||||
const staticDir = [
|
||||
UiSharedDepsNpm.distDir,
|
||||
UiSharedDepsSrc.distDir,
|
||||
'src/plugins/kibana_react/public/assets:plugins/kibanaReact/assets',
|
||||
];
|
||||
const config: Record<string, any> = {
|
||||
configDir,
|
||||
mode: flags.site ? 'static' : 'dev',
|
||||
|
|
|
|||
|
|
@ -79,7 +79,7 @@ export function runFtrCli() {
|
|||
err: err.message,
|
||||
...flags,
|
||||
});
|
||||
log.indent(-log.indent());
|
||||
log.indent(-log.getIndent());
|
||||
log.error(err);
|
||||
process.exitCode = 1;
|
||||
} else {
|
||||
|
|
|
|||
|
|
@ -78,12 +78,9 @@ export async function runTests(options: RunTestsParams) {
|
|||
log.write('--- asserting that all tests belong to a ciGroup');
|
||||
for (const configPath of options.configs) {
|
||||
log.info('loading', configPath);
|
||||
log.indent(4);
|
||||
try {
|
||||
await log.indent(4, async () => {
|
||||
await assertNoneExcluded({ configPath, options: { ...options, log } });
|
||||
} finally {
|
||||
log.indent(-4);
|
||||
}
|
||||
});
|
||||
continue;
|
||||
}
|
||||
|
||||
|
|
@ -94,42 +91,41 @@ export async function runTests(options: RunTestsParams) {
|
|||
const configPathsWithTests: string[] = [];
|
||||
for (const configPath of options.configs) {
|
||||
log.info('testing', configPath);
|
||||
log.indent(4);
|
||||
try {
|
||||
await log.indent(4, async () => {
|
||||
if (await hasTests({ configPath, options: { ...options, log } })) {
|
||||
configPathsWithTests.push(configPath);
|
||||
}
|
||||
} finally {
|
||||
log.indent(-4);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
for (const configPath of configPathsWithTests) {
|
||||
log.write(`--- Running ${relative(REPO_ROOT, configPath)}`);
|
||||
await log.indent(0, async () => {
|
||||
log.write(`--- Running ${relative(REPO_ROOT, configPath)}`);
|
||||
|
||||
await withProcRunner(log, async (procs) => {
|
||||
const config = await readConfigFile(log, configPath);
|
||||
await withProcRunner(log, async (procs) => {
|
||||
const config = await readConfigFile(log, configPath);
|
||||
|
||||
let es;
|
||||
try {
|
||||
es = await runElasticsearch({ config, options: { ...options, log } });
|
||||
await runKibanaServer({ procs, config, options });
|
||||
await runFtr({ configPath, options: { ...options, log } });
|
||||
} finally {
|
||||
let es;
|
||||
try {
|
||||
const delay = config.get('kbnTestServer.delayShutdown');
|
||||
if (typeof delay === 'number') {
|
||||
log.info('Delaying shutdown of Kibana for', delay, 'ms');
|
||||
await new Promise((r) => setTimeout(r, delay));
|
||||
}
|
||||
|
||||
await procs.stop('kibana');
|
||||
es = await runElasticsearch({ config, options: { ...options, log } });
|
||||
await runKibanaServer({ procs, config, options });
|
||||
await runFtr({ configPath, options: { ...options, log } });
|
||||
} finally {
|
||||
if (es) {
|
||||
await es.cleanup();
|
||||
try {
|
||||
const delay = config.get('kbnTestServer.delayShutdown');
|
||||
if (typeof delay === 'number') {
|
||||
log.info('Delaying shutdown of Kibana for', delay, 'ms');
|
||||
await new Promise((r) => setTimeout(r, delay));
|
||||
}
|
||||
|
||||
await procs.stop('kibana');
|
||||
} finally {
|
||||
if (es) {
|
||||
await es.cleanup();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -75,6 +75,16 @@
|
|||
labels: ['Team:Operations', 'release_note:skip'],
|
||||
enabled: true,
|
||||
},
|
||||
{
|
||||
groupName: 'polyfills',
|
||||
packageNames: ['core-js'],
|
||||
matchPackagePatterns: ["polyfill"],
|
||||
excludePackageNames: ['@loaders.gl/polyfills'],
|
||||
reviewers: ['team:kibana-operations'],
|
||||
matchBaseBranches: ['master'],
|
||||
labels: ['Team:Operations', 'release_note:skip'],
|
||||
enabled: true,
|
||||
},
|
||||
{
|
||||
groupName: 'vega related modules',
|
||||
packageNames: ['vega', 'vega-lite', 'vega-schema-url-parser', 'vega-tooltip'],
|
||||
|
|
|
|||
|
|
@ -197,5 +197,38 @@ describe('DeprecationsClient', () => {
|
|||
|
||||
expect(result).toEqual({ status: 'fail', reason: mockResponse });
|
||||
});
|
||||
|
||||
it('omit deprecationDetails in the request of the body', async () => {
|
||||
const deprecationsClient = new DeprecationsClient({ http });
|
||||
const mockDeprecationDetails: DomainDeprecationDetails = {
|
||||
title: 'some-title',
|
||||
domainId: 'testPluginId-1',
|
||||
message: 'some-message',
|
||||
level: 'warning',
|
||||
correctiveActions: {
|
||||
api: {
|
||||
path: 'some-path',
|
||||
method: 'POST',
|
||||
body: {
|
||||
extra_param: 123,
|
||||
},
|
||||
omitContextFromBody: true,
|
||||
},
|
||||
manualSteps: ['manual-step'],
|
||||
},
|
||||
};
|
||||
const result = await deprecationsClient.resolveDeprecation(mockDeprecationDetails);
|
||||
|
||||
expect(http.fetch).toBeCalledTimes(1);
|
||||
expect(http.fetch).toBeCalledWith({
|
||||
path: 'some-path',
|
||||
method: 'POST',
|
||||
asSystemRequest: true,
|
||||
body: JSON.stringify({
|
||||
extra_param: 123,
|
||||
}),
|
||||
});
|
||||
expect(result).toEqual({ status: 'ok' });
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ export class DeprecationsClient {
|
|||
};
|
||||
}
|
||||
|
||||
const { body, method, path } = correctiveActions.api;
|
||||
const { body, method, path, omitContextFromBody = false } = correctiveActions.api;
|
||||
try {
|
||||
await this.http.fetch<void>({
|
||||
path,
|
||||
|
|
@ -67,7 +67,7 @@ export class DeprecationsClient {
|
|||
asSystemRequest: true,
|
||||
body: JSON.stringify({
|
||||
...body,
|
||||
deprecationDetails: { domainId },
|
||||
...(omitContextFromBody ? {} : { deprecationDetails: { domainId } }),
|
||||
}),
|
||||
});
|
||||
return { status: 'ok' };
|
||||
|
|
|
|||
|
|
@ -83,100 +83,4 @@ describe('core deprecations', () => {
|
|||
expect(messages).toHaveLength(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('cspRulesDeprecation', () => {
|
||||
describe('with nonce source', () => {
|
||||
it('logs a warning', () => {
|
||||
const settings = {
|
||||
csp: {
|
||||
rules: [`script-src 'self' 'nonce-{nonce}'`],
|
||||
},
|
||||
};
|
||||
const { messages } = applyCoreDeprecations(settings);
|
||||
expect(messages).toMatchInlineSnapshot(`
|
||||
Array [
|
||||
"csp.rules no longer supports the {nonce} syntax. Replacing with 'self' in script-src",
|
||||
]
|
||||
`);
|
||||
});
|
||||
|
||||
it('replaces a nonce', () => {
|
||||
expect(
|
||||
applyCoreDeprecations({ csp: { rules: [`script-src 'nonce-{nonce}'`] } }).migrated.csp
|
||||
.rules
|
||||
).toEqual([`script-src 'self'`]);
|
||||
expect(
|
||||
applyCoreDeprecations({ csp: { rules: [`script-src 'unsafe-eval' 'nonce-{nonce}'`] } })
|
||||
.migrated.csp.rules
|
||||
).toEqual([`script-src 'unsafe-eval' 'self'`]);
|
||||
});
|
||||
|
||||
it('removes a quoted nonce', () => {
|
||||
expect(
|
||||
applyCoreDeprecations({ csp: { rules: [`script-src 'self' 'nonce-{nonce}'`] } }).migrated
|
||||
.csp.rules
|
||||
).toEqual([`script-src 'self'`]);
|
||||
expect(
|
||||
applyCoreDeprecations({ csp: { rules: [`script-src 'nonce-{nonce}' 'self'`] } }).migrated
|
||||
.csp.rules
|
||||
).toEqual([`script-src 'self'`]);
|
||||
});
|
||||
|
||||
it('removes a non-quoted nonce', () => {
|
||||
expect(
|
||||
applyCoreDeprecations({ csp: { rules: [`script-src 'self' nonce-{nonce}`] } }).migrated
|
||||
.csp.rules
|
||||
).toEqual([`script-src 'self'`]);
|
||||
expect(
|
||||
applyCoreDeprecations({ csp: { rules: [`script-src nonce-{nonce} 'self'`] } }).migrated
|
||||
.csp.rules
|
||||
).toEqual([`script-src 'self'`]);
|
||||
});
|
||||
|
||||
it('removes a strange nonce', () => {
|
||||
expect(
|
||||
applyCoreDeprecations({ csp: { rules: [`script-src 'self' blah-{nonce}-wow`] } }).migrated
|
||||
.csp.rules
|
||||
).toEqual([`script-src 'self'`]);
|
||||
});
|
||||
|
||||
it('removes multiple nonces', () => {
|
||||
expect(
|
||||
applyCoreDeprecations({
|
||||
csp: {
|
||||
rules: [
|
||||
`script-src 'nonce-{nonce}' 'self' blah-{nonce}-wow`,
|
||||
`style-src 'nonce-{nonce}' 'self'`,
|
||||
],
|
||||
},
|
||||
}).migrated.csp.rules
|
||||
).toEqual([`script-src 'self'`, `style-src 'self'`]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('without self source', () => {
|
||||
it('logs a warning', () => {
|
||||
const { messages } = applyCoreDeprecations({
|
||||
csp: { rules: [`script-src 'unsafe-eval'`] },
|
||||
});
|
||||
expect(messages).toMatchInlineSnapshot(`
|
||||
Array [
|
||||
"csp.rules must contain the 'self' source. Automatically adding to script-src.",
|
||||
]
|
||||
`);
|
||||
});
|
||||
|
||||
it('adds self', () => {
|
||||
expect(
|
||||
applyCoreDeprecations({ csp: { rules: [`script-src 'unsafe-eval'`] } }).migrated.csp.rules
|
||||
).toEqual([`script-src 'unsafe-eval' 'self'`]);
|
||||
});
|
||||
});
|
||||
|
||||
it('does not add self to other policies', () => {
|
||||
expect(
|
||||
applyCoreDeprecations({ csp: { rules: [`worker-src blob:`] } }).migrated.csp.rules
|
||||
).toEqual([`worker-src blob:`]);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
|
|||
|
|
@ -45,64 +45,7 @@ const rewriteCorsSettings: ConfigDeprecation = (settings, fromPath, addDeprecati
|
|||
}
|
||||
};
|
||||
|
||||
const cspRulesDeprecation: ConfigDeprecation = (settings, fromPath, addDeprecation) => {
|
||||
const NONCE_STRING = `{nonce}`;
|
||||
// Policies that should include the 'self' source
|
||||
const SELF_POLICIES = Object.freeze(['script-src', 'style-src']);
|
||||
const SELF_STRING = `'self'`;
|
||||
|
||||
const rules: string[] = settings.csp?.rules;
|
||||
if (rules) {
|
||||
const parsed = new Map(
|
||||
rules.map((ruleStr) => {
|
||||
const parts = ruleStr.split(/\s+/);
|
||||
return [parts[0], parts.slice(1)];
|
||||
})
|
||||
);
|
||||
|
||||
return {
|
||||
set: [
|
||||
{
|
||||
path: 'csp.rules',
|
||||
value: [...parsed].map(([policy, sourceList]) => {
|
||||
if (sourceList.find((source) => source.includes(NONCE_STRING))) {
|
||||
addDeprecation({
|
||||
message: `csp.rules no longer supports the {nonce} syntax. Replacing with 'self' in ${policy}`,
|
||||
correctiveActions: {
|
||||
manualSteps: [`Replace {nonce} syntax with 'self' in ${policy}`],
|
||||
},
|
||||
});
|
||||
sourceList = sourceList.filter((source) => !source.includes(NONCE_STRING));
|
||||
|
||||
// Add 'self' if not present
|
||||
if (!sourceList.find((source) => source.includes(SELF_STRING))) {
|
||||
sourceList.push(SELF_STRING);
|
||||
}
|
||||
}
|
||||
|
||||
if (
|
||||
SELF_POLICIES.includes(policy) &&
|
||||
!sourceList.find((source) => source.includes(SELF_STRING))
|
||||
) {
|
||||
addDeprecation({
|
||||
message: `csp.rules must contain the 'self' source. Automatically adding to ${policy}.`,
|
||||
correctiveActions: {
|
||||
manualSteps: [`Add 'self' source to ${policy}.`],
|
||||
},
|
||||
});
|
||||
sourceList.push(SELF_STRING);
|
||||
}
|
||||
|
||||
return `${policy} ${sourceList.join(' ')}`.trim();
|
||||
}),
|
||||
},
|
||||
],
|
||||
};
|
||||
}
|
||||
};
|
||||
|
||||
export const coreDeprecationProvider: ConfigDeprecationProvider = ({ rename, unusedFromRoot }) => [
|
||||
export const coreDeprecationProvider: ConfigDeprecationProvider = () => [
|
||||
rewriteCorsSettings,
|
||||
rewriteBasePathDeprecation,
|
||||
cspRulesDeprecation,
|
||||
];
|
||||
|
|
|
|||
|
|
@ -80,21 +80,6 @@ describe('config.validate()', () => {
|
|||
).not.toThrow();
|
||||
});
|
||||
|
||||
it(`throws if 'rules' is also specified`, () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
rules: [
|
||||
`script-src 'unsafe-eval' 'self'`,
|
||||
`worker-src 'unsafe-eval' 'self'`,
|
||||
`style-src 'unsafe-eval' 'self'`,
|
||||
],
|
||||
script_src: [`'self'`],
|
||||
})
|
||||
).toThrowErrorMatchingInlineSnapshot(
|
||||
`"\\"csp.rules\\" cannot be used when specifying per-directive additions such as \\"script_src\\", \\"worker_src\\" or \\"style_src\\""`
|
||||
);
|
||||
});
|
||||
|
||||
it('throws if using an `nonce-*` value', () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -104,6 +89,7 @@ describe('config.validate()', () => {
|
|||
`"[script_src]: using \\"nonce-*\\" is considered insecure and is not allowed"`
|
||||
);
|
||||
});
|
||||
|
||||
it("throws if using `none` or `'none'`", () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -124,21 +110,6 @@ describe('config.validate()', () => {
|
|||
});
|
||||
|
||||
describe(`"worker_src"`, () => {
|
||||
it(`throws if 'rules' is also specified`, () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
rules: [
|
||||
`script-src 'unsafe-eval' 'self'`,
|
||||
`worker-src 'unsafe-eval' 'self'`,
|
||||
`style-src 'unsafe-eval' 'self'`,
|
||||
],
|
||||
worker_src: [`'self'`],
|
||||
})
|
||||
).toThrowErrorMatchingInlineSnapshot(
|
||||
`"\\"csp.rules\\" cannot be used when specifying per-directive additions such as \\"script_src\\", \\"worker_src\\" or \\"style_src\\""`
|
||||
);
|
||||
});
|
||||
|
||||
it('throws if using an `nonce-*` value', () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -148,6 +119,7 @@ describe('config.validate()', () => {
|
|||
`"[worker_src]: using \\"nonce-*\\" is considered insecure and is not allowed"`
|
||||
);
|
||||
});
|
||||
|
||||
it("throws if using `none` or `'none'`", () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -168,21 +140,6 @@ describe('config.validate()', () => {
|
|||
});
|
||||
|
||||
describe(`"style_src"`, () => {
|
||||
it(`throws if 'rules' is also specified`, () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
rules: [
|
||||
`script-src 'unsafe-eval' 'self'`,
|
||||
`worker-src 'unsafe-eval' 'self'`,
|
||||
`style-src 'unsafe-eval' 'self'`,
|
||||
],
|
||||
style_src: [`'self'`],
|
||||
})
|
||||
).toThrowErrorMatchingInlineSnapshot(
|
||||
`"\\"csp.rules\\" cannot be used when specifying per-directive additions such as \\"script_src\\", \\"worker_src\\" or \\"style_src\\""`
|
||||
);
|
||||
});
|
||||
|
||||
it('throws if using an `nonce-*` value', () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -192,6 +149,7 @@ describe('config.validate()', () => {
|
|||
`"[style_src]: using \\"nonce-*\\" is considered insecure and is not allowed"`
|
||||
);
|
||||
});
|
||||
|
||||
it("throws if using `none` or `'none'`", () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -212,21 +170,6 @@ describe('config.validate()', () => {
|
|||
});
|
||||
|
||||
describe(`"connect_src"`, () => {
|
||||
it(`throws if 'rules' is also specified`, () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
rules: [
|
||||
`script-src 'unsafe-eval' 'self'`,
|
||||
`worker-src 'unsafe-eval' 'self'`,
|
||||
`style-src 'unsafe-eval' 'self'`,
|
||||
],
|
||||
connect_src: [`'self'`],
|
||||
})
|
||||
).toThrowErrorMatchingInlineSnapshot(
|
||||
`"\\"csp.rules\\" cannot be used when specifying per-directive additions such as \\"script_src\\", \\"worker_src\\" or \\"style_src\\""`
|
||||
);
|
||||
});
|
||||
|
||||
it('throws if using an `nonce-*` value', () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -236,6 +179,7 @@ describe('config.validate()', () => {
|
|||
`"[connect_src]: using \\"nonce-*\\" is considered insecure and is not allowed"`
|
||||
);
|
||||
});
|
||||
|
||||
it("throws if using `none` or `'none'`", () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -256,21 +200,6 @@ describe('config.validate()', () => {
|
|||
});
|
||||
|
||||
describe(`"default_src"`, () => {
|
||||
it(`throws if 'rules' is also specified`, () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
rules: [
|
||||
`script-src 'unsafe-eval' 'self'`,
|
||||
`worker-src 'unsafe-eval' 'self'`,
|
||||
`style-src 'unsafe-eval' 'self'`,
|
||||
],
|
||||
default_src: [`'self'`],
|
||||
})
|
||||
).toThrowErrorMatchingInlineSnapshot(
|
||||
`"\\"csp.rules\\" cannot be used when specifying per-directive additions such as \\"script_src\\", \\"worker_src\\" or \\"style_src\\""`
|
||||
);
|
||||
});
|
||||
|
||||
it('throws if using an `nonce-*` value', () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -280,6 +209,7 @@ describe('config.validate()', () => {
|
|||
`"[default_src]: using \\"nonce-*\\" is considered insecure and is not allowed"`
|
||||
);
|
||||
});
|
||||
|
||||
it("throws if using `none` or `'none'`", () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -300,21 +230,6 @@ describe('config.validate()', () => {
|
|||
});
|
||||
|
||||
describe(`"font_src"`, () => {
|
||||
it(`throws if 'rules' is also specified`, () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
rules: [
|
||||
`script-src 'unsafe-eval' 'self'`,
|
||||
`worker-src 'unsafe-eval' 'self'`,
|
||||
`style-src 'unsafe-eval' 'self'`,
|
||||
],
|
||||
font_src: [`'self'`],
|
||||
})
|
||||
).toThrowErrorMatchingInlineSnapshot(
|
||||
`"\\"csp.rules\\" cannot be used when specifying per-directive additions such as \\"script_src\\", \\"worker_src\\" or \\"style_src\\""`
|
||||
);
|
||||
});
|
||||
|
||||
it('throws if using an `nonce-*` value', () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -324,6 +239,7 @@ describe('config.validate()', () => {
|
|||
`"[font_src]: using \\"nonce-*\\" is considered insecure and is not allowed"`
|
||||
);
|
||||
});
|
||||
|
||||
it("throws if using `none` or `'none'`", () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -344,21 +260,6 @@ describe('config.validate()', () => {
|
|||
});
|
||||
|
||||
describe(`"frame_src"`, () => {
|
||||
it(`throws if 'rules' is also specified`, () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
rules: [
|
||||
`script-src 'unsafe-eval' 'self'`,
|
||||
`worker-src 'unsafe-eval' 'self'`,
|
||||
`style-src 'unsafe-eval' 'self'`,
|
||||
],
|
||||
frame_src: [`'self'`],
|
||||
})
|
||||
).toThrowErrorMatchingInlineSnapshot(
|
||||
`"\\"csp.rules\\" cannot be used when specifying per-directive additions such as \\"script_src\\", \\"worker_src\\" or \\"style_src\\""`
|
||||
);
|
||||
});
|
||||
|
||||
it('throws if using an `nonce-*` value', () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -368,6 +269,7 @@ describe('config.validate()', () => {
|
|||
`"[frame_src]: using \\"nonce-*\\" is considered insecure and is not allowed"`
|
||||
);
|
||||
});
|
||||
|
||||
it("throws if using `none` or `'none'`", () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -388,21 +290,6 @@ describe('config.validate()', () => {
|
|||
});
|
||||
|
||||
describe(`"img_src"`, () => {
|
||||
it(`throws if 'rules' is also specified`, () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
rules: [
|
||||
`script-src 'unsafe-eval' 'self'`,
|
||||
`worker-src 'unsafe-eval' 'self'`,
|
||||
`style-src 'unsafe-eval' 'self'`,
|
||||
],
|
||||
img_src: [`'self'`],
|
||||
})
|
||||
).toThrowErrorMatchingInlineSnapshot(
|
||||
`"\\"csp.rules\\" cannot be used when specifying per-directive additions such as \\"script_src\\", \\"worker_src\\" or \\"style_src\\""`
|
||||
);
|
||||
});
|
||||
|
||||
it('throws if using an `nonce-*` value', () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -412,6 +299,7 @@ describe('config.validate()', () => {
|
|||
`"[img_src]: using \\"nonce-*\\" is considered insecure and is not allowed"`
|
||||
);
|
||||
});
|
||||
|
||||
it("throws if using `none` or `'none'`", () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -432,21 +320,6 @@ describe('config.validate()', () => {
|
|||
});
|
||||
|
||||
describe(`"frame_ancestors"`, () => {
|
||||
it(`throws if 'rules' is also specified`, () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
rules: [
|
||||
`script-src 'unsafe-eval' 'self'`,
|
||||
`worker-src 'unsafe-eval' 'self'`,
|
||||
`style-src 'unsafe-eval' 'self'`,
|
||||
],
|
||||
frame_ancestors: [`'self'`],
|
||||
})
|
||||
).toThrowErrorMatchingInlineSnapshot(
|
||||
`"\\"csp.rules\\" cannot be used when specifying per-directive additions such as \\"script_src\\", \\"worker_src\\" or \\"style_src\\""`
|
||||
);
|
||||
});
|
||||
|
||||
it('throws if using an `nonce-*` value', () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
@ -456,6 +329,7 @@ describe('config.validate()', () => {
|
|||
`"[frame_ancestors]: using \\"nonce-*\\" is considered insecure and is not allowed"`
|
||||
);
|
||||
});
|
||||
|
||||
it("throws if using `none` or `'none'`", () => {
|
||||
expect(() =>
|
||||
config.schema.validate({
|
||||
|
|
|
|||
|
|
@ -39,7 +39,6 @@ const getDirectiveValueValidator = ({ allowNone, allowNonce }: DirectiveValidati
|
|||
|
||||
const configSchema = schema.object(
|
||||
{
|
||||
rules: schema.maybe(schema.arrayOf(schema.string())),
|
||||
script_src: schema.arrayOf(schema.string(), {
|
||||
defaultValue: [],
|
||||
validate: getDirectiveValidator({ allowNone: false, allowNonce: false }),
|
||||
|
|
@ -89,9 +88,6 @@ const configSchema = schema.object(
|
|||
},
|
||||
{
|
||||
validate: (cspConfig) => {
|
||||
if (cspConfig.rules && hasDirectiveSpecified(cspConfig)) {
|
||||
return `"csp.rules" cannot be used when specifying per-directive additions such as "script_src", "worker_src" or "style_src"`;
|
||||
}
|
||||
const hasUnsafeInlineScriptSrc =
|
||||
cspConfig.script_src.includes(`unsafe-inline`) ||
|
||||
cspConfig.script_src.includes(`'unsafe-inline'`);
|
||||
|
|
@ -106,22 +102,6 @@ const configSchema = schema.object(
|
|||
}
|
||||
);
|
||||
|
||||
const hasDirectiveSpecified = (rawConfig: CspConfigType): boolean => {
|
||||
return Boolean(
|
||||
rawConfig.script_src.length ||
|
||||
rawConfig.worker_src.length ||
|
||||
rawConfig.style_src.length ||
|
||||
rawConfig.connect_src.length ||
|
||||
rawConfig.default_src.length ||
|
||||
rawConfig.font_src.length ||
|
||||
rawConfig.frame_src.length ||
|
||||
rawConfig.img_src.length ||
|
||||
rawConfig.frame_ancestors.length ||
|
||||
rawConfig.report_uri.length ||
|
||||
rawConfig.report_to.length
|
||||
);
|
||||
};
|
||||
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
|
|
@ -132,25 +112,4 @@ export const config: ServiceConfigDescriptor<CspConfigType> = {
|
|||
// ? https://github.com/elastic/kibana/pull/52251
|
||||
path: 'csp',
|
||||
schema: configSchema,
|
||||
deprecations: () => [
|
||||
(rawConfig, fromPath, addDeprecation) => {
|
||||
const cspConfig = rawConfig[fromPath];
|
||||
if (cspConfig?.rules) {
|
||||
addDeprecation({
|
||||
message:
|
||||
'`csp.rules` is deprecated in favor of directive specific configuration. Please use `csp.connect_src`, ' +
|
||||
'`csp.default_src`, `csp.font_src`, `csp.frame_ancestors`, `csp.frame_src`, `csp.img_src`, ' +
|
||||
'`csp.report_uri`, `csp.report_to`, `csp.script_src`, `csp.style_src`, and `csp.worker_src` instead.',
|
||||
correctiveActions: {
|
||||
manualSteps: [
|
||||
`Remove "csp.rules" from the Kibana config file."`,
|
||||
`Add directive specific configurations to the config file using "csp.connect_src", "csp.default_src", "csp.font_src", ` +
|
||||
`"csp.frame_ancestors", "csp.frame_src", "csp.img_src", "csp.report_uri", "csp.report_to", "csp.script_src", ` +
|
||||
`"csp.style_src", and "csp.worker_src".`,
|
||||
],
|
||||
},
|
||||
});
|
||||
}
|
||||
},
|
||||
],
|
||||
};
|
||||
|
|
|
|||
|
|
@ -34,11 +34,6 @@ describe('CspConfig', () => {
|
|||
CspConfig {
|
||||
"disableEmbedding": false,
|
||||
"header": "script-src 'unsafe-eval' 'self'; worker-src blob: 'self'; style-src 'unsafe-inline' 'self'",
|
||||
"rules": Array [
|
||||
"script-src 'unsafe-eval' 'self'",
|
||||
"worker-src blob: 'self'",
|
||||
"style-src 'unsafe-inline' 'self'",
|
||||
],
|
||||
"strict": true,
|
||||
"warnLegacyBrowsers": true,
|
||||
}
|
||||
|
|
@ -50,13 +45,6 @@ describe('CspConfig', () => {
|
|||
});
|
||||
|
||||
describe('partial config', () => {
|
||||
test('allows "rules" to be set and changes header', () => {
|
||||
const rules = [`foo 'self'`, `bar 'self'`];
|
||||
const config = new CspConfig({ ...defaultConfig, rules });
|
||||
expect(config.rules).toEqual(rules);
|
||||
expect(config.header).toMatchInlineSnapshot(`"foo 'self'; bar 'self'"`);
|
||||
});
|
||||
|
||||
test('allows "strict" to be set', () => {
|
||||
const config = new CspConfig({ ...defaultConfig, strict: false });
|
||||
expect(config.strict).toEqual(false);
|
||||
|
|
@ -70,67 +58,57 @@ describe('CspConfig', () => {
|
|||
expect(config.warnLegacyBrowsers).not.toEqual(CspConfig.DEFAULT.warnLegacyBrowsers);
|
||||
});
|
||||
|
||||
test('allows "worker_src" to be set and changes header', () => {
|
||||
test('allows "worker_src" to be set and changes header from defaults', () => {
|
||||
const config = new CspConfig({
|
||||
...defaultConfig,
|
||||
rules: [],
|
||||
worker_src: ['foo', 'bar'],
|
||||
});
|
||||
expect(config.rules).toEqual([`worker-src foo bar`]);
|
||||
expect(config.header).toEqual(`worker-src foo bar`);
|
||||
expect(config.header).toEqual(
|
||||
`script-src 'unsafe-eval' 'self'; worker-src blob: 'self' foo bar; style-src 'unsafe-inline' 'self'`
|
||||
);
|
||||
});
|
||||
|
||||
test('allows "style_src" to be set and changes header', () => {
|
||||
const config = new CspConfig({
|
||||
...defaultConfig,
|
||||
rules: [],
|
||||
style_src: ['foo', 'bar'],
|
||||
});
|
||||
expect(config.rules).toEqual([`style-src foo bar`]);
|
||||
expect(config.header).toEqual(`style-src foo bar`);
|
||||
|
||||
expect(config.header).toEqual(
|
||||
`script-src 'unsafe-eval' 'self'; worker-src blob: 'self'; style-src 'unsafe-inline' 'self' foo bar`
|
||||
);
|
||||
});
|
||||
|
||||
test('allows "script_src" to be set and changes header', () => {
|
||||
const config = new CspConfig({
|
||||
...defaultConfig,
|
||||
rules: [],
|
||||
script_src: ['foo', 'bar'],
|
||||
});
|
||||
expect(config.rules).toEqual([`script-src foo bar`]);
|
||||
expect(config.header).toEqual(`script-src foo bar`);
|
||||
|
||||
expect(config.header).toEqual(
|
||||
`script-src 'unsafe-eval' 'self' foo bar; worker-src blob: 'self'; style-src 'unsafe-inline' 'self'`
|
||||
);
|
||||
});
|
||||
|
||||
test('allows all directives to be set and changes header', () => {
|
||||
const config = new CspConfig({
|
||||
...defaultConfig,
|
||||
rules: [],
|
||||
script_src: ['script', 'foo'],
|
||||
worker_src: ['worker', 'bar'],
|
||||
style_src: ['style', 'dolly'],
|
||||
});
|
||||
expect(config.rules).toEqual([
|
||||
`script-src script foo`,
|
||||
`worker-src worker bar`,
|
||||
`style-src style dolly`,
|
||||
]);
|
||||
expect(config.header).toEqual(
|
||||
`script-src script foo; worker-src worker bar; style-src style dolly`
|
||||
`script-src 'unsafe-eval' 'self' script foo; worker-src blob: 'self' worker bar; style-src 'unsafe-inline' 'self' style dolly`
|
||||
);
|
||||
});
|
||||
|
||||
test('applies defaults when `rules` is undefined', () => {
|
||||
test('appends config directives to defaults', () => {
|
||||
const config = new CspConfig({
|
||||
...defaultConfig,
|
||||
rules: undefined,
|
||||
script_src: ['script'],
|
||||
worker_src: ['worker'],
|
||||
style_src: ['style'],
|
||||
});
|
||||
expect(config.rules).toEqual([
|
||||
`script-src 'unsafe-eval' 'self' script`,
|
||||
`worker-src blob: 'self' worker`,
|
||||
`style-src 'unsafe-inline' 'self' style`,
|
||||
]);
|
||||
expect(config.header).toEqual(
|
||||
`script-src 'unsafe-eval' 'self' script; worker-src blob: 'self' worker; style-src 'unsafe-inline' 'self' style`
|
||||
);
|
||||
|
|
@ -139,25 +117,15 @@ describe('CspConfig', () => {
|
|||
describe('allows "disableEmbedding" to be set', () => {
|
||||
const disableEmbedding = true;
|
||||
|
||||
test('and changes rules/header if custom rules are not defined', () => {
|
||||
test('and changes rules and header', () => {
|
||||
const config = new CspConfig({ ...defaultConfig, disableEmbedding });
|
||||
expect(config.disableEmbedding).toEqual(disableEmbedding);
|
||||
expect(config.disableEmbedding).not.toEqual(CspConfig.DEFAULT.disableEmbedding);
|
||||
expect(config.rules).toEqual(expect.arrayContaining([`frame-ancestors 'self'`]));
|
||||
expect(config.header).toMatchInlineSnapshot(
|
||||
`"script-src 'unsafe-eval' 'self'; worker-src blob: 'self'; style-src 'unsafe-inline' 'self'; frame-ancestors 'self'"`
|
||||
);
|
||||
});
|
||||
|
||||
test('and does not change rules/header if custom rules are defined', () => {
|
||||
const rules = [`foo 'self'`, `bar 'self'`];
|
||||
const config = new CspConfig({ ...defaultConfig, disableEmbedding, rules });
|
||||
expect(config.disableEmbedding).toEqual(disableEmbedding);
|
||||
expect(config.disableEmbedding).not.toEqual(CspConfig.DEFAULT.disableEmbedding);
|
||||
expect(config.rules).toEqual(rules);
|
||||
expect(config.header).toMatchInlineSnapshot(`"foo 'self'; bar 'self'"`);
|
||||
});
|
||||
|
||||
test('and overrides `frame-ancestors` if set', () => {
|
||||
const config = new CspConfig({
|
||||
...defaultConfig,
|
||||
|
|
|
|||
|
|
@ -16,11 +16,6 @@ const DEFAULT_CONFIG = Object.freeze(config.schema.validate({}));
|
|||
* @public
|
||||
*/
|
||||
export interface ICspConfig {
|
||||
/**
|
||||
* The CSP rules used for Kibana.
|
||||
*/
|
||||
readonly rules: string[];
|
||||
|
||||
/**
|
||||
* Specify whether browsers that do not support CSP should be
|
||||
* able to use Kibana. Use `true` to block and `false` to allow.
|
||||
|
|
@ -34,8 +29,7 @@ export interface ICspConfig {
|
|||
readonly warnLegacyBrowsers: boolean;
|
||||
|
||||
/**
|
||||
* Whether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled *and* no custom rules have been
|
||||
* defined, a restrictive 'frame-ancestors' rule will be added to the default CSP rules.
|
||||
* Whether or not embedding (using iframes) should be allowed by the CSP. If embedding is disabled, a restrictive 'frame-ancestors' rule will be added to the default CSP rules.
|
||||
*/
|
||||
readonly disableEmbedding: boolean;
|
||||
|
||||
|
|
@ -54,7 +48,6 @@ export class CspConfig implements ICspConfig {
|
|||
static readonly DEFAULT = new CspConfig(DEFAULT_CONFIG);
|
||||
|
||||
readonly #directives: CspDirectives;
|
||||
public readonly rules: string[];
|
||||
public readonly strict: boolean;
|
||||
public readonly warnLegacyBrowsers: boolean;
|
||||
public readonly disableEmbedding: boolean;
|
||||
|
|
@ -66,14 +59,11 @@ export class CspConfig implements ICspConfig {
|
|||
*/
|
||||
constructor(rawCspConfig: CspConfigType) {
|
||||
this.#directives = CspDirectives.fromConfig(rawCspConfig);
|
||||
if (!rawCspConfig.rules?.length && rawCspConfig.disableEmbedding) {
|
||||
if (rawCspConfig.disableEmbedding) {
|
||||
this.#directives.clearDirectiveValues('frame-ancestors');
|
||||
this.#directives.addDirectiveValue('frame-ancestors', `'self'`);
|
||||
}
|
||||
|
||||
this.rules = this.#directives.getRules();
|
||||
this.header = this.#directives.getCspHeader();
|
||||
|
||||
this.strict = rawCspConfig.strict;
|
||||
this.warnLegacyBrowsers = rawCspConfig.warnLegacyBrowsers;
|
||||
this.disableEmbedding = rawCspConfig.disableEmbedding;
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue