[api-docs] Daily api_docs build (#144203)

This commit is contained in:
Kibana Machine 2022-10-29 00:46:56 -04:00 committed by GitHub
parent 21fb0334e3
commit e82e0a150f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
718 changed files with 59155 additions and 18193 deletions

View file

@ -18,7 +18,13 @@
"text": "Plugin" "text": "Plugin"
}, },
" implements ", " implements ",
"Plugin", {
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.Plugin",
"text": "Plugin"
},
"<", "<",
{ {
"pluginId": "actions", "pluginId": "actions",
@ -55,7 +61,13 @@
"label": "ctx", "label": "ctx",
"description": [], "description": [],
"signature": [ "signature": [
"PluginInitializerContext", {
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<", "<",
"Config", "Config",
">" ">"
@ -527,7 +539,13 @@
"label": "logger", "label": "logger",
"description": [], "description": [],
"signature": [ "signature": [
"Logger" {
"pluginId": "@kbn/logging",
"scope": "server",
"docId": "kibKbnLoggingPluginApi",
"section": "def-server.Logger",
"text": "Logger"
}
], ],
"path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts",
"deprecated": false, "deprecated": false,
@ -880,7 +898,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(source: ", "(source: ",
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => ", "<unknown, unknown, unknown, any>) => ",
"HttpRequestExecutionSource" "HttpRequestExecutionSource"
], ],
@ -896,7 +920,13 @@
"label": "source", "label": "source",
"description": [], "description": [],
"signature": [ "signature": [
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>" "<unknown, unknown, unknown, any>"
], ],
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
@ -917,7 +947,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(source: Omit<", "(source: Omit<",
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
", \"name\">) => ", ", \"name\">) => ",
"SavedObjectExecutionSource" "SavedObjectExecutionSource"
], ],
@ -934,7 +970,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"Omit<", "Omit<",
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
", \"name\">" ", \"name\">"
], ],
"path": "x-pack/plugins/actions/server/lib/action_execution_source.ts", "path": "x-pack/plugins/actions/server/lib/action_execution_source.ts",
@ -1493,7 +1535,13 @@
"label": "logger", "label": "logger",
"description": [], "description": [],
"signature": [ "signature": [
"Logger" {
"pluginId": "@kbn/logging",
"scope": "server",
"docId": "kibKbnLoggingPluginApi",
"section": "def-server.Logger",
"text": "Logger"
}
], ],
"path": "x-pack/plugins/actions/server/types.ts", "path": "x-pack/plugins/actions/server/types.ts",
"deprecated": false, "deprecated": false,
@ -1773,7 +1821,13 @@
"label": "logger", "label": "logger",
"description": [], "description": [],
"signature": [ "signature": [
"Logger" {
"pluginId": "@kbn/logging",
"scope": "server",
"docId": "kibKbnLoggingPluginApi",
"section": "def-server.Logger",
"text": "Logger"
}
], ],
"path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts",
"deprecated": false, "deprecated": false,
@ -2294,9 +2348,21 @@
"description": [], "description": [],
"signature": [ "signature": [
"(request: ", "(request: ",
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => Promise<", "<unknown, unknown, unknown, any>) => Promise<",
"PublicMethodsOf", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.PublicMethodsOf",
"text": "PublicMethodsOf"
},
"<", "<",
{ {
"pluginId": "actions", "pluginId": "actions",
@ -2319,7 +2385,13 @@
"label": "request", "label": "request",
"description": [], "description": [],
"signature": [ "signature": [
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>" "<unknown, unknown, unknown, any>"
], ],
"path": "x-pack/plugins/actions/server/plugin.ts", "path": "x-pack/plugins/actions/server/plugin.ts",
@ -2339,9 +2411,21 @@
"description": [], "description": [],
"signature": [ "signature": [
"(request: ", "(request: ",
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => ", "<unknown, unknown, unknown, any>) => ",
"PublicMethodsOf", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.PublicMethodsOf",
"text": "PublicMethodsOf"
},
"<", "<",
{ {
"pluginId": "actions", "pluginId": "actions",
@ -2364,7 +2448,13 @@
"label": "request", "label": "request",
"description": [], "description": [],
"signature": [ "signature": [
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>" "<unknown, unknown, unknown, any>"
], ],
"path": "x-pack/plugins/actions/server/plugin.ts", "path": "x-pack/plugins/actions/server/plugin.ts",
@ -3644,10 +3734,13 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.AlertingConnectorFeature.name", "id": "def-common.AlertingConnectorFeature.name",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "name", "label": "name",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3655,10 +3748,13 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.AlertingConnectorFeature.compatibility", "id": "def-common.AlertingConnectorFeature.compatibility",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "compatibility", "label": "compatibility",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3691,10 +3787,13 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.CasesConnectorFeature.name", "id": "def-common.CasesConnectorFeature.name",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "name", "label": "name",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3702,10 +3801,13 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.CasesConnectorFeature.compatibility", "id": "def-common.CasesConnectorFeature.compatibility",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "compatibility", "label": "compatibility",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3753,10 +3855,13 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.SecuritySolutionFeature.name", "id": "def-common.SecuritySolutionFeature.name",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "name", "label": "name",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3764,10 +3869,13 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.SecuritySolutionFeature.compatibility", "id": "def-common.SecuritySolutionFeature.compatibility",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "compatibility", "label": "compatibility",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3800,10 +3908,13 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.UptimeConnectorFeature.name", "id": "def-common.UptimeConnectorFeature.name",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "name", "label": "name",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3811,10 +3922,13 @@
{ {
"parentPluginId": "actions", "parentPluginId": "actions",
"id": "def-common.UptimeConnectorFeature.compatibility", "id": "def-common.UptimeConnectorFeature.compatibility",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "compatibility", "label": "compatibility",
"description": [], "description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/actions/common/connector_feature_config.ts", "path": "x-pack/plugins/actions/common/connector_feature_config.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions
title: "actions" title: "actions"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the actions plugin description: API docs for the actions plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
--- ---
import actionsObj from './actions.devdocs.json'; import actionsObj from './actions.devdocs.json';
@ -21,7 +21,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 225 | 0 | 220 | 24 | | 225 | 8 | 220 | 24 |
## Client ## Client

View file

@ -304,11 +304,29 @@
"description": [], "description": [],
"signature": [ "signature": [
"({\n def,\n name,\n value,\n isCustom,\n isOverridden,\n}: { def: ", "({\n def,\n name,\n value,\n isCustom,\n isOverridden,\n}: { def: ",
"PublicUiSettingsParams", {
"pluginId": "@kbn/core-ui-settings-common",
"scope": "common",
"docId": "kibKbnCoreUiSettingsCommonPluginApi",
"section": "def-common.PublicUiSettingsParams",
"text": "PublicUiSettingsParams"
},
" & ", " & ",
"UserProvidedValues", {
"pluginId": "@kbn/core-ui-settings-common",
"scope": "common",
"docId": "kibKbnCoreUiSettingsCommonPluginApi",
"section": "def-common.UserProvidedValues",
"text": "UserProvidedValues"
},
"<any>; name: string; value: ", "<any>; name: string; value: ",
"SavedObjectAttribute", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttribute",
"text": "SavedObjectAttribute"
},
"; isCustom: boolean; isOverridden: boolean; }) => ", "; isCustom: boolean; isOverridden: boolean; }) => ",
"FieldSetting" "FieldSetting"
], ],
@ -335,9 +353,21 @@
"label": "def", "label": "def",
"description": [], "description": [],
"signature": [ "signature": [
"PublicUiSettingsParams", {
"pluginId": "@kbn/core-ui-settings-common",
"scope": "common",
"docId": "kibKbnCoreUiSettingsCommonPluginApi",
"section": "def-common.PublicUiSettingsParams",
"text": "PublicUiSettingsParams"
},
" & ", " & ",
"UserProvidedValues", {
"pluginId": "@kbn/core-ui-settings-common",
"scope": "common",
"docId": "kibKbnCoreUiSettingsCommonPluginApi",
"section": "def-common.UserProvidedValues",
"text": "UserProvidedValues"
},
"<any>" "<any>"
], ],
"path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts",
@ -363,9 +393,21 @@
"label": "value", "label": "value",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectAttributeSingle", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributeSingle",
"text": "SavedObjectAttributeSingle"
},
" | ", " | ",
"SavedObjectAttributeSingle", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributeSingle",
"text": "SavedObjectAttributeSingle"
},
"[]" "[]"
], ],
"path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts", "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings
title: "advancedSettings" title: "advancedSettings"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the advancedSettings plugin description: API docs for the advancedSettings plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
--- ---
import advancedSettingsObj from './advanced_settings.devdocs.json'; import advancedSettingsObj from './advanced_settings.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops
title: "aiops" title: "aiops"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the aiops plugin description: API docs for the aiops plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
--- ---
import aiopsObj from './aiops.devdocs.json'; import aiopsObj from './aiops.devdocs.json';

View file

@ -25,7 +25,13 @@
"text": "SanitizedRule" "text": "SanitizedRule"
}, },
"<never>) => string | ", "<never>) => string | ",
"JsonObject" {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
}
], ],
"path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts", "path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts",
"deprecated": false, "deprecated": false,
@ -551,9 +557,21 @@
", filterOpts: ", ", filterOpts: ",
"AlertingAuthorizationFilterOpts", "AlertingAuthorizationFilterOpts",
") => Promise<{ filter?: ", ") => Promise<{ filter?: ",
"JsonObject", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
},
" | ", " | ",
"KueryNode", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
" | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; }>" " | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; }>"
], ],
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
@ -634,9 +652,21 @@
"text": "WriteOperations" "text": "WriteOperations"
}, },
") => Promise<{ filter?: ", ") => Promise<{ filter?: ",
"JsonObject", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
},
" | ", " | ",
"KueryNode", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
" | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; }>" " | undefined; ensureRuleTypeIsAuthorized: (ruleTypeId: string, consumer: string, auth: string) => void; }>"
], ],
"path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts", "path": "x-pack/plugins/alerting/server/authorization/alerting_authorization.ts",
@ -1200,7 +1230,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"string | ", "string | ",
"KueryNode", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
" | undefined" " | undefined"
], ],
"path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts",
@ -1584,7 +1620,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(request: ", "(request: ",
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => ", "<unknown, unknown, unknown, any>) => ",
"RulesClientApi" "RulesClientApi"
], ],
@ -1600,7 +1642,13 @@
"label": "request", "label": "request",
"description": [], "description": [],
"signature": [ "signature": [
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>" "<unknown, unknown, unknown, any>"
], ],
"path": "x-pack/plugins/alerting/server/plugin.ts", "path": "x-pack/plugins/alerting/server/plugin.ts",
@ -1620,9 +1668,21 @@
"description": [], "description": [],
"signature": [ "signature": [
"(request: ", "(request: ",
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => ", "<unknown, unknown, unknown, any>) => ",
"PublicMethodsOf", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.PublicMethodsOf",
"text": "PublicMethodsOf"
},
"<", "<",
{ {
"pluginId": "alerting", "pluginId": "alerting",
@ -1645,7 +1705,13 @@
"label": "request", "label": "request",
"description": [], "description": [],
"signature": [ "signature": [
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>" "<unknown, unknown, unknown, any>"
], ],
"path": "x-pack/plugins/alerting/server/plugin.ts", "path": "x-pack/plugins/alerting/server/plugin.ts",
@ -1748,7 +1814,13 @@
"label": "logger", "label": "logger",
"description": [], "description": [],
"signature": [ "signature": [
"Logger" {
"pluginId": "@kbn/logging",
"scope": "server",
"docId": "kibKbnLoggingPluginApi",
"section": "def-server.Logger",
"text": "Logger"
}
], ],
"path": "x-pack/plugins/alerting/server/types.ts", "path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false, "deprecated": false,
@ -1969,7 +2041,13 @@
"label": "savedObjectsClient", "label": "savedObjectsClient",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectsClientContract" {
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
}
], ],
"path": "x-pack/plugins/alerting/server/types.ts", "path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false, "deprecated": false,
@ -1983,7 +2061,13 @@
"label": "uiSettingsClient", "label": "uiSettingsClient",
"description": [], "description": [],
"signature": [ "signature": [
"IUiSettingsClient" {
"pluginId": "@kbn/core-ui-settings-server",
"scope": "server",
"docId": "kibKbnCoreUiSettingsServerPluginApi",
"section": "def-server.IUiSettingsClient",
"text": "IUiSettingsClient"
}
], ],
"path": "x-pack/plugins/alerting/server/types.ts", "path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false, "deprecated": false,
@ -1997,7 +2081,13 @@
"label": "scopedClusterClient", "label": "scopedClusterClient",
"description": [], "description": [],
"signature": [ "signature": [
"IScopedClusterClient" {
"pluginId": "@kbn/core-elasticsearch-server",
"scope": "server",
"docId": "kibKbnCoreElasticsearchServerPluginApi",
"section": "def-server.IScopedClusterClient",
"text": "IScopedClusterClient"
}
], ],
"path": "x-pack/plugins/alerting/server/types.ts", "path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false, "deprecated": false,
@ -2083,7 +2173,13 @@
"label": "references", "label": "references",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]" "[]"
], ],
"path": "x-pack/plugins/alerting/server/types.ts", "path": "x-pack/plugins/alerting/server/types.ts",
@ -2356,7 +2452,13 @@
"text": "RuleParamsAndRefs" "text": "RuleParamsAndRefs"
}, },
"<ExtractedParams>; injectReferences: (params: ExtractedParams, references: ", "<ExtractedParams>; injectReferences: (params: ExtractedParams, references: ",
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]) => Params; } | undefined" "[]) => Params; } | undefined"
], ],
"path": "x-pack/plugins/alerting/server/types.ts", "path": "x-pack/plugins/alerting/server/types.ts",
@ -2697,7 +2799,13 @@
"label": "RuleActionParams", "label": "RuleActionParams",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectAttributes" {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
}
], ],
"path": "x-pack/plugins/alerting/common/rule.ts", "path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false, "deprecated": false,
@ -2904,7 +3012,7 @@
"MuteOptions", "MuteOptions",
") => Promise<void>; unmuteInstance: ({ alertId, alertInstanceId }: ", ") => Promise<void>; unmuteInstance: ({ alertId, alertInstanceId }: ",
"MuteOptions", "MuteOptions",
") => Promise<void>; runSoon: ({ id }: { id: string; }) => Promise<string | undefined>; listAlertTypes: () => Promise<Set<", ") => Promise<void>; runSoon: ({ id }: { id: string; }) => Promise<any>; listAlertTypes: () => Promise<Set<",
"RegistryAlertTypeWithAuth", "RegistryAlertTypeWithAuth",
">>; getSpaceId: () => string | undefined; }" ">>; getSpaceId: () => string | undefined; }"
], ],
@ -4234,7 +4342,13 @@
"text": "IntervalSchedule" "text": "IntervalSchedule"
}, },
" extends ", " extends ",
"SavedObjectAttributes" {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
}
], ],
"path": "x-pack/plugins/alerting/common/rule.ts", "path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false, "deprecated": false,
@ -4991,7 +5105,13 @@
"label": "params", "label": "params",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectAttributes" {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
}
], ],
"path": "x-pack/plugins/alerting/common/rule.ts", "path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false, "deprecated": false,
@ -5200,7 +5320,13 @@
"text": "RuleMonitoring" "text": "RuleMonitoring"
}, },
" extends ", " extends ",
"SavedObjectAttributes" {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
}
], ],
"path": "x-pack/plugins/alerting/common/rule.ts", "path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false, "deprecated": false,
@ -5247,7 +5373,13 @@
"text": "RuleMonitoringHistory" "text": "RuleMonitoringHistory"
}, },
" extends ", " extends ",
"SavedObjectAttributes" {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
}
], ],
"path": "x-pack/plugins/alerting/common/rule.ts", "path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false, "deprecated": false,
@ -5394,7 +5526,13 @@
"label": "state", "label": "state",
"description": [], "description": [],
"signature": [ "signature": [
"JsonObject" {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
}
], ],
"path": "x-pack/plugins/alerting/common/rule_navigation.ts", "path": "x-pack/plugins/alerting/common/rule_navigation.ts",
"deprecated": false, "deprecated": false,
@ -5933,7 +6071,13 @@
"label": "MappedParams", "label": "MappedParams",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectAttributes", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
},
" & ", " & ",
{ {
"pluginId": "alerting", "pluginId": "alerting",
@ -6024,7 +6168,13 @@
"text": "SanitizedRule" "text": "SanitizedRule"
}, },
"<Params> & Omit<", "<Params> & Omit<",
"SavedObjectsResolveResponse", {
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<unknown>, \"saved_object\">" "<unknown>, \"saved_object\">"
], ],
"path": "x-pack/plugins/alerting/common/rule.ts", "path": "x-pack/plugins/alerting/common/rule.ts",
@ -6040,9 +6190,21 @@
"label": "RuleActionParam", "label": "RuleActionParam",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectAttributeSingle", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributeSingle",
"text": "SavedObjectAttributeSingle"
},
" | ", " | ",
"SavedObjectAttributeSingle", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributeSingle",
"text": "SavedObjectAttributeSingle"
},
"[]" "[]"
], ],
"path": "x-pack/plugins/alerting/common/rule.ts", "path": "x-pack/plugins/alerting/common/rule.ts",
@ -6058,7 +6220,13 @@
"label": "RuleActionParams", "label": "RuleActionParams",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectAttributes" {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
}
], ],
"path": "x-pack/plugins/alerting/common/rule.ts", "path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting
title: "alerting" title: "alerting"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the alerting plugin description: API docs for the alerting plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
--- ---
import alertingObj from './alerting.devdocs.json'; import alertingObj from './alerting.devdocs.json';

File diff suppressed because it is too large Load diff

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm
title: "apm" title: "apm"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the apm plugin description: API docs for the apm plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
--- ---
import apmObj from './apm.devdocs.json'; import apmObj from './apm.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/banners
title: "banners" title: "banners"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the banners plugin description: API docs for the banners plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
--- ---
import bannersObj from './banners.devdocs.json'; import bannersObj from './banners.devdocs.json';

View file

@ -288,7 +288,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"<BatchItemData extends object, BatchItemResult extends object>(path: string, handler: (request: ", "<BatchItemData extends object, BatchItemResult extends object>(path: string, handler: (request: ",
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => ", "<unknown, unknown, unknown, any>) => ",
{ {
"pluginId": "bfetch", "pluginId": "bfetch",
@ -327,7 +333,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(request: ", "(request: ",
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => ", "<unknown, unknown, unknown, any>) => ",
{ {
"pluginId": "bfetch", "pluginId": "bfetch",
@ -355,9 +367,21 @@
"description": [], "description": [],
"signature": [ "signature": [
"<Payload, Response>(path: string, params: (request: ", "<Payload, Response>(path: string, params: (request: ",
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>, context: ", "<unknown, unknown, unknown, any>, context: ",
"RequestHandlerContext", {
"pluginId": "@kbn/core-http-request-handler-context-server",
"scope": "server",
"docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
") => ", ") => ",
{ {
"pluginId": "bfetch", "pluginId": "bfetch",
@ -367,11 +391,29 @@
"text": "StreamingResponseHandler" "text": "StreamingResponseHandler"
}, },
"<Payload, Response>, method?: \"GET\" | \"POST\" | \"PUT\" | \"DELETE\" | undefined, pluginRouter?: ", "<Payload, Response>, method?: \"GET\" | \"POST\" | \"PUT\" | \"DELETE\" | undefined, pluginRouter?: ",
"IRouter", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.IRouter",
"text": "IRouter"
},
"<", "<",
"RequestHandlerContext", {
"pluginId": "@kbn/core-http-request-handler-context-server",
"scope": "server",
"docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
"> | undefined, options?: ", "> | undefined, options?: ",
"RouteConfigOptions", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.RouteConfigOptions",
"text": "RouteConfigOptions"
},
"<\"get\" | \"post\" | \"put\" | \"delete\"> | undefined) => void" "<\"get\" | \"post\" | \"put\" | \"delete\"> | undefined) => void"
], ],
"path": "src/plugins/bfetch/server/plugin.ts", "path": "src/plugins/bfetch/server/plugin.ts",
@ -402,9 +444,21 @@
"description": [], "description": [],
"signature": [ "signature": [
"(request: ", "(request: ",
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>, context: ", "<unknown, unknown, unknown, any>, context: ",
"RequestHandlerContext", {
"pluginId": "@kbn/core-http-request-handler-context-server",
"scope": "server",
"docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
") => ", ") => ",
{ {
"pluginId": "bfetch", "pluginId": "bfetch",
@ -443,9 +497,21 @@
"label": "pluginRouter", "label": "pluginRouter",
"description": [], "description": [],
"signature": [ "signature": [
"IRouter", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.IRouter",
"text": "IRouter"
},
"<", "<",
"RequestHandlerContext", {
"pluginId": "@kbn/core-http-request-handler-context-server",
"scope": "server",
"docId": "kibKbnCoreHttpRequestHandlerContextServerPluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
"> | undefined" "> | undefined"
], ],
"path": "src/plugins/bfetch/server/plugin.ts", "path": "src/plugins/bfetch/server/plugin.ts",
@ -461,7 +527,13 @@
"label": "options", "label": "options",
"description": [], "description": [],
"signature": [ "signature": [
"RouteConfigOptions", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.RouteConfigOptions",
"text": "RouteConfigOptions"
},
"<\"get\" | \"post\" | \"put\" | \"delete\"> | undefined" "<\"get\" | \"post\" | \"put\" | \"delete\"> | undefined"
], ],
"path": "src/plugins/bfetch/server/plugin.ts", "path": "src/plugins/bfetch/server/plugin.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/bfetch
title: "bfetch" title: "bfetch"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the bfetch plugin description: API docs for the bfetch plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
--- ---
import bfetchObj from './bfetch.devdocs.json'; import bfetchObj from './bfetch.devdocs.json';

View file

@ -24,7 +24,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"{ services: ", "{ services: ",
"CoreStart", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
" & ", " & ",
"CanvasStartDeps", "CanvasStartDeps",
" & { canvas: ", " & { canvas: ",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/canvas
title: "canvas" title: "canvas"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the canvas plugin description: API docs for the canvas plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
--- ---
import canvasObj from './canvas.devdocs.json'; import canvasObj from './canvas.devdocs.json';

View file

@ -18,7 +18,13 @@
"text": "CasesUiPlugin" "text": "CasesUiPlugin"
}, },
" implements ", " implements ",
"Plugin", {
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.Plugin",
"text": "Plugin"
},
"<void, ", "<void, ",
{ {
"pluginId": "cases", "pluginId": "cases",
@ -59,7 +65,13 @@
"label": "initializerContext", "label": "initializerContext",
"description": [], "description": [],
"signature": [ "signature": [
"PluginInitializerContext", {
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<object>" "<object>"
], ],
"path": "x-pack/plugins/cases/public/plugin.ts", "path": "x-pack/plugins/cases/public/plugin.ts",
@ -79,7 +91,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(core: ", "(core: ",
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>, plugins: ", "<object, unknown>, plugins: ",
"CasesPluginSetup", "CasesPluginSetup",
") => ", ") => ",
@ -103,7 +121,13 @@
"label": "core", "label": "core",
"description": [], "description": [],
"signature": [ "signature": [
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>" "<object, unknown>"
], ],
"path": "x-pack/plugins/cases/public/plugin.ts", "path": "x-pack/plugins/cases/public/plugin.ts",
@ -138,7 +162,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(core: ", "(core: ",
"CoreStart", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
", plugins: ", ", plugins: ",
"CasesPluginStart", "CasesPluginStart",
") => ", ") => ",
@ -162,7 +192,13 @@
"label": "core", "label": "core",
"description": [], "description": [],
"signature": [ "signature": [
"CoreStart" {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
}
], ],
"path": "x-pack/plugins/cases/public/plugin.ts", "path": "x-pack/plugins/cases/public/plugin.ts",
"deprecated": false, "deprecated": false,
@ -285,9 +321,21 @@
"description": [], "description": [],
"signature": [ "signature": [
"<T extends ", "<T extends ",
"AppDeepLink", {
"pluginId": "@kbn/core-application-browser",
"scope": "common",
"docId": "kibKbnCoreApplicationBrowserPluginApi",
"section": "def-common.AppDeepLink",
"text": "AppDeepLink"
},
" = ", " = ",
"AppDeepLink", {
"pluginId": "@kbn/core-application-browser",
"scope": "common",
"docId": "kibKbnCoreApplicationBrowserPluginApi",
"section": "def-common.AppDeepLink",
"text": "AppDeepLink"
},
">({ basePath, extend, }: { basePath?: string | undefined; extend?: Partial<Record<", ">({ basePath, extend, }: { basePath?: string | undefined; extend?: Partial<Record<",
{ {
"pluginId": "cases", "pluginId": "cases",
@ -296,7 +344,7 @@
"section": "def-public.ICasesDeepLinkId", "section": "def-public.ICasesDeepLinkId",
"text": "ICasesDeepLinkId" "text": "ICasesDeepLinkId"
}, },
", Partial<T>>> | undefined; }) => { id: \"cases\"; path: string; deepLinks: ({ id: \"cases_create\"; path: string; title: string | T[\"title\"]; keywords?: T[\"keywords\"] | undefined; navLinkStatus?: T[\"navLinkStatus\"] | undefined; searchable?: T[\"searchable\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; deepLinks?: T[\"deepLinks\"] | undefined; } | { id: \"cases_configure\"; path: string; title: string | T[\"title\"]; keywords?: T[\"keywords\"] | undefined; navLinkStatus?: T[\"navLinkStatus\"] | undefined; searchable?: T[\"searchable\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; deepLinks?: T[\"deepLinks\"] | undefined; })[]; title: string | T[\"title\"]; keywords?: T[\"keywords\"] | undefined; navLinkStatus?: T[\"navLinkStatus\"] | undefined; searchable?: T[\"searchable\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; }" ", Partial<T>>> | undefined; }) => { id: \"cases\"; path: string; deepLinks: ({ id: \"cases_create\"; path: string; title: any; keywords?: T[\"keywords\"] | undefined; navLinkStatus?: T[\"navLinkStatus\"] | undefined; searchable?: T[\"searchable\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; deepLinks?: T[\"deepLinks\"] | undefined; } | { id: \"cases_configure\"; path: string; title: any; keywords?: T[\"keywords\"] | undefined; navLinkStatus?: T[\"navLinkStatus\"] | undefined; searchable?: T[\"searchable\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; deepLinks?: T[\"deepLinks\"] | undefined; })[]; title: any; keywords?: T[\"keywords\"] | undefined; navLinkStatus?: T[\"navLinkStatus\"] | undefined; searchable?: T[\"searchable\"] | undefined; order?: T[\"order\"] | undefined; tooltip?: T[\"tooltip\"] | undefined; euiIconType?: T[\"euiIconType\"] | undefined; icon?: T[\"icon\"] | undefined; }"
], ],
"path": "x-pack/plugins/cases/public/common/navigation/deep_links.ts", "path": "x-pack/plugins/cases/public/common/navigation/deep_links.ts",
"deprecated": false, "deprecated": false,
@ -715,7 +763,13 @@
"text": "ExternalReferenceStorageType" "text": "ExternalReferenceStorageType"
}, },
".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ", ".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
"JsonValue", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ", "; } | null; type: ",
{ {
"pluginId": "cases", "pluginId": "cases",
@ -733,7 +787,13 @@
"text": "CommentType" "text": "CommentType"
}, },
".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: ", ".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: ",
"JsonValue", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonValue",
"text": "JsonValue"
},
"; }; }" "; }; }"
], ],
"path": "x-pack/plugins/cases/public/types.ts", "path": "x-pack/plugins/cases/public/types.ts",
@ -779,7 +839,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"{ getRelatedCases: (alertId: string, query: { owner?: string | string[] | undefined; }) => Promise<{ id: string; title: string; }[]>; cases: { find: (query: { tags?: string | string[] | undefined; status?: ", "{ getRelatedCases: (alertId: string, query: { owner?: string | string[] | undefined; }) => Promise<{ id: string; title: string; }[]>; cases: { find: (query: { tags?: string | string[] | undefined; status?: ",
"CaseStatuses", {
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
" | undefined; severity?: ", " | undefined; severity?: ",
"CaseSeverity", "CaseSeverity",
" | undefined; assignees?: string | string[] | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; fields?: string | string[] | undefined; from?: string | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string | string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<", " | undefined; assignees?: string | string[] | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; fields?: string | string[] | undefined; from?: string | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string | string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<",
@ -1130,7 +1196,13 @@
], ],
"signature": [ "signature": [
"(request: ", "(request: ",
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => Promise<", "<unknown, unknown, unknown, any>) => Promise<",
{ {
"pluginId": "cases", "pluginId": "cases",
@ -1155,7 +1227,13 @@
"a KibanaRequest" "a KibanaRequest"
], ],
"signature": [ "signature": [
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>" "<unknown, unknown, unknown, any>"
], ],
"path": "x-pack/plugins/cases/server/types.ts", "path": "x-pack/plugins/cases/server/types.ts",
@ -1469,10 +1547,7 @@
"tags": [], "tags": [],
"label": "CaseStatuses", "label": "CaseStatuses",
"description": [], "description": [],
"signature": [ "path": "packages/kbn-cases-components/src/status/types.ts",
"CaseStatuses"
],
"path": "node_modules/@types/kbn__cases-components/index.d.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false, "trackAdoption": false,
"initialIsOpen": false "initialIsOpen": false
@ -1512,7 +1587,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"Omit<{ description: string; status: ", "Omit<{ description: string; status: ",
"CaseStatuses", {
"pluginId": "@kbn/cases-components",
"scope": "common",
"docId": "kibKbnCasesComponentsPluginApi",
"section": "def-common.CaseStatuses",
"text": "CaseStatuses"
},
"; tags: string[]; title: string; connector: { id: string; type: ", "; tags: string[]; title: string; connector: { id: string; type: ",
"ConnectorTypes", "ConnectorTypes",
".casesWebhook; fields: null; name: string; } | { id: string; type: ", ".casesWebhook; fields: null; name: string; } | { id: string; type: ",
@ -1562,7 +1643,13 @@
"text": "ExternalReferenceStorageType" "text": "ExternalReferenceStorageType"
}, },
".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ", ".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
"JsonValue", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ", "; } | null; type: ",
{ {
"pluginId": "cases", "pluginId": "cases",
@ -1580,7 +1667,13 @@
"text": "ExternalReferenceStorageType" "text": "ExternalReferenceStorageType"
}, },
".savedObject; soType: string; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ", ".savedObject; soType: string; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
"JsonValue", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonValue",
"text": "JsonValue"
},
"; } | null; type: ", "; } | null; type: ",
{ {
"pluginId": "cases", "pluginId": "cases",
@ -1598,7 +1691,13 @@
"text": "CommentType" "text": "CommentType"
}, },
".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: ", ".persistableState; owner: string; persistableStateAttachmentTypeId: string; persistableStateAttachmentState: { [x: string]: ",
"JsonValue", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonValue",
"text": "JsonValue"
},
"; }; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; })) & { id: string; version: string; })[] | undefined; }, \"comments\"> & { comments: ", "; }; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }; owner: string; pushed_at: string | null; pushed_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; updated_at: string | null; updated_by: ({ email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } & { profile_uid?: string | undefined; }) | null; })) & { id: string; version: string; })[] | undefined; }, \"comments\"> & { comments: ",
"Comment", "Comment",
"[]; }" "[]; }"

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases
title: "cases" title: "cases"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cases plugin description: API docs for the cases plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
--- ---
import casesObj from './cases.devdocs.json'; import casesObj from './cases.devdocs.json';
@ -21,7 +21,7 @@ Contact [ResponseOps](https://github.com/orgs/elastic/teams/response-ops) for qu
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 87 | 0 | 70 | 28 | | 87 | 0 | 71 | 28 |
## Client ## Client

View file

@ -1057,7 +1057,13 @@
"label": "continuity", "label": "continuity",
"description": [], "description": [],
"signature": [ "signature": [
"PaletteContinuity", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteContinuity",
"text": "PaletteContinuity"
},
" | undefined" " | undefined"
], ],
"path": "src/plugins/charts/common/expressions/palette/types.ts", "path": "src/plugins/charts/common/expressions/palette/types.ts",
@ -1161,7 +1167,13 @@
"label": "continuity", "label": "continuity",
"description": [], "description": [],
"signature": [ "signature": [
"PaletteContinuity", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteContinuity",
"text": "PaletteContinuity"
},
" | undefined" " | undefined"
], ],
"path": "src/plugins/charts/common/expressions/palette/types.ts", "path": "src/plugins/charts/common/expressions/palette/types.ts",
@ -1478,10 +1490,13 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-public.defaultCountLabel", "id": "def-public.defaultCountLabel",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "defaultCountLabel", "label": "defaultCountLabel",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/components/collections.ts", "path": "src/plugins/charts/common/static/components/collections.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false, "trackAdoption": false,
@ -1802,10 +1817,13 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-public.vislibColorMaps.ColorSchemas.Blues.label", "id": "def-public.vislibColorMaps.ColorSchemas.Blues.label",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1861,10 +1879,13 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-public.vislibColorMaps.ColorSchemas.Greens.label", "id": "def-public.vislibColorMaps.ColorSchemas.Greens.label",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1920,10 +1941,13 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-public.vislibColorMaps.ColorSchemas.Greys.label", "id": "def-public.vislibColorMaps.ColorSchemas.Greys.label",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1979,10 +2003,13 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-public.vislibColorMaps.ColorSchemas.Reds.label", "id": "def-public.vislibColorMaps.ColorSchemas.Reds.label",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2038,10 +2065,13 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-public.vislibColorMaps.ColorSchemas.YellowToRed.label", "id": "def-public.vislibColorMaps.ColorSchemas.YellowToRed.label",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2097,10 +2127,13 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-public.vislibColorMaps.ColorSchemas.GreenToRed.label", "id": "def-public.vislibColorMaps.ColorSchemas.GreenToRed.label",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2199,7 +2232,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"{ getPalettes: () => Promise<", "{ getPalettes: () => Promise<",
"PaletteRegistry", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteRegistry",
"text": "PaletteRegistry"
},
">; }" ">; }"
], ],
"path": "src/plugins/charts/public/plugin.ts", "path": "src/plugins/charts/public/plugin.ts",
@ -2354,7 +2393,13 @@
"label": "continuity", "label": "continuity",
"description": [], "description": [],
"signature": [ "signature": [
"PaletteContinuity", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteContinuity",
"text": "PaletteContinuity"
},
" | undefined" " | undefined"
], ],
"path": "src/plugins/charts/common/expressions/palette/types.ts", "path": "src/plugins/charts/common/expressions/palette/types.ts",
@ -2458,7 +2503,13 @@
"label": "continuity", "label": "continuity",
"description": [], "description": [],
"signature": [ "signature": [
"PaletteContinuity", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteContinuity",
"text": "PaletteContinuity"
},
" | undefined" " | undefined"
], ],
"path": "src/plugins/charts/common/expressions/palette/types.ts", "path": "src/plugins/charts/common/expressions/palette/types.ts",
@ -2626,7 +2677,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/charts/common/expressions/palette/system_palette.ts", "path": "src/plugins/charts/common/expressions/palette/system_palette.ts",
@ -2877,7 +2934,13 @@
"label": "continuity", "label": "continuity",
"description": [], "description": [],
"signature": [ "signature": [
"PaletteContinuity", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteContinuity",
"text": "PaletteContinuity"
},
" | undefined" " | undefined"
], ],
"path": "src/plugins/charts/common/expressions/palette/types.ts", "path": "src/plugins/charts/common/expressions/palette/types.ts",
@ -2981,7 +3044,13 @@
"label": "continuity", "label": "continuity",
"description": [], "description": [],
"signature": [ "signature": [
"PaletteContinuity", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteContinuity",
"text": "PaletteContinuity"
},
" | undefined" " | undefined"
], ],
"path": "src/plugins/charts/common/expressions/palette/types.ts", "path": "src/plugins/charts/common/expressions/palette/types.ts",
@ -3313,10 +3382,13 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-common.defaultCountLabel", "id": "def-common.defaultCountLabel",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "defaultCountLabel", "label": "defaultCountLabel",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/components/collections.ts", "path": "src/plugins/charts/common/static/components/collections.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false, "trackAdoption": false,
@ -3650,10 +3722,13 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-common.vislibColorMaps.ColorSchemas.Blues.label", "id": "def-common.vislibColorMaps.ColorSchemas.Blues.label",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3709,10 +3784,13 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-common.vislibColorMaps.ColorSchemas.Greens.label", "id": "def-common.vislibColorMaps.ColorSchemas.Greens.label",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3768,10 +3846,13 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-common.vislibColorMaps.ColorSchemas.Greys.label", "id": "def-common.vislibColorMaps.ColorSchemas.Greys.label",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3827,10 +3908,13 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-common.vislibColorMaps.ColorSchemas.Reds.label", "id": "def-common.vislibColorMaps.ColorSchemas.Reds.label",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3886,10 +3970,13 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-common.vislibColorMaps.ColorSchemas.YellowToRed.label", "id": "def-common.vislibColorMaps.ColorSchemas.YellowToRed.label",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -3945,10 +4032,13 @@
{ {
"parentPluginId": "charts", "parentPluginId": "charts",
"id": "def-common.vislibColorMaps.ColorSchemas.GreenToRed.label", "id": "def-common.vislibColorMaps.ColorSchemas.GreenToRed.label",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "label", "label": "label",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/charts/common/static/color_maps/color_maps.ts", "path": "src/plugins/charts/common/static/color_maps/color_maps.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts
title: "charts" title: "charts"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the charts plugin description: API docs for the charts plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
--- ---
import chartsObj from './charts.devdocs.json'; import chartsObj from './charts.devdocs.json';
@ -21,7 +21,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 264 | 2 | 249 | 9 | | 264 | 16 | 249 | 9 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud
title: "cloud" title: "cloud"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloud plugin description: API docs for the cloud plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
--- ---
import cloudObj from './cloud.devdocs.json'; import cloudObj from './cloud.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChat
title: "cloudChat" title: "cloudChat"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudChat plugin description: API docs for the cloudChat plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat']
--- ---
import cloudChatObj from './cloud_chat.devdocs.json'; import cloudChatObj from './cloud_chat.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudExperiments
title: "cloudExperiments" title: "cloudExperiments"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudExperiments plugin description: API docs for the cloudExperiments plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments']
--- ---
import cloudExperimentsObj from './cloud_experiments.devdocs.json'; import cloudExperimentsObj from './cloud_experiments.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture
title: "cloudSecurityPosture" title: "cloudSecurityPosture"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudSecurityPosture plugin description: API docs for the cloudSecurityPosture plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
--- ---
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json'; import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';

View file

@ -18,7 +18,13 @@
"text": "ConsoleUIPlugin" "text": "ConsoleUIPlugin"
}, },
" implements ", " implements ",
"Plugin", {
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.Plugin",
"text": "Plugin"
},
"<void, void, ", "<void, void, ",
"AppSetupUIPluginDependencies", "AppSetupUIPluginDependencies",
", object>" ", object>"
@ -49,7 +55,13 @@
"label": "ctx", "label": "ctx",
"description": [], "description": [],
"signature": [ "signature": [
"PluginInitializerContext", {
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<object>" "<object>"
], ],
"path": "src/plugins/console/public/plugin.ts", "path": "src/plugins/console/public/plugin.ts",
@ -69,7 +81,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"({ notifications, getStartServices, http }: ", "({ notifications, getStartServices, http }: ",
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>, { devTools, home, share, usageCollection }: ", "<object, unknown>, { devTools, home, share, usageCollection }: ",
"AppSetupUIPluginDependencies", "AppSetupUIPluginDependencies",
") => ", ") => ",
@ -93,7 +111,13 @@
"label": "{ notifications, getStartServices, http }", "label": "{ notifications, getStartServices, http }",
"description": [], "description": [],
"signature": [ "signature": [
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>" "<object, unknown>"
], ],
"path": "src/plugins/console/public/plugin.ts", "path": "src/plugins/console/public/plugin.ts",
@ -200,7 +224,13 @@
"text": "ConsoleUILocatorParams" "text": "ConsoleUILocatorParams"
}, },
" extends ", " extends ",
"SerializableRecord" {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
}
], ],
"path": "src/plugins/console/public/types/locator.ts", "path": "src/plugins/console/public/types/locator.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/console
title: "console" title: "console"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the console plugin description: API docs for the console plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
--- ---
import consoleObj from './console.devdocs.json'; import consoleObj from './console.devdocs.json';

View file

@ -88,7 +88,13 @@
"signature": [ "signature": [
"Subject", "Subject",
"<", "<",
"Filter", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]>" "[]>"
], ],
"path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx",
@ -239,15 +245,45 @@
"text": "ViewMode" "text": "ViewMode"
}, },
"; title: string; id: string; lastReloadRequestTime: number; hidePanelTitles: boolean; enhancements: ", "; title: string; id: string; lastReloadRequestTime: number; hidePanelTitles: boolean; enhancements: ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
"; disabledActions: string[]; disableTriggers: boolean; searchSessionId: string; syncColors: boolean; syncCursor: boolean; syncTooltips: boolean; executionContext: ", "; disabledActions: string[]; disableTriggers: boolean; searchSessionId: string; syncColors: boolean; syncCursor: boolean; syncTooltips: boolean; executionContext: ",
"KibanaExecutionContext", {
"pluginId": "@kbn/core-execution-context-common",
"scope": "common",
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
"section": "def-common.KibanaExecutionContext",
"text": "KibanaExecutionContext"
},
"; query: ", "; query: ",
"Query", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
"; filters: ", "; filters: ",
"Filter", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]; timeRange: ", "[]; timeRange: ",
"TimeRange", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
"; timeslice: [number, number]; controlStyle: \"twoLine\" | \"oneLine\"; ignoreParentSettings: ", "; timeslice: [number, number]; controlStyle: \"twoLine\" | \"oneLine\"; ignoreParentSettings: ",
"ParentIgnoreSettings", "ParentIgnoreSettings",
"; fieldName: string; parentFieldName: string; childFieldName: string; dataViewId: string; }, ", "; fieldName: string; parentFieldName: string; childFieldName: string; dataViewId: string; }, ",
@ -565,7 +601,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(filters: ", "(filters: ",
"Filter", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]) => void" "[]) => void"
], ],
"path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx",
@ -580,7 +622,13 @@
"label": "filters", "label": "filters",
"description": [], "description": [],
"signature": [ "signature": [
"Filter", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]" "[]"
], ],
"path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx",
@ -990,7 +1038,13 @@
"text": "EmbeddableStateWithType" "text": "EmbeddableStateWithType"
}, },
", references: ", ", references: ",
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]) => ", "[]) => ",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
@ -1027,7 +1081,13 @@
"label": "references", "label": "references",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]" "[]"
], ],
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts", "path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
@ -1061,7 +1121,13 @@
"text": "EmbeddableStateWithType" "text": "EmbeddableStateWithType"
}, },
"; references: ", "; references: ",
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]; }" "[]; }"
], ],
"path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts",
@ -1147,7 +1213,7 @@
"label": "getDisplayName", "label": "getDisplayName",
"description": [], "description": [],
"signature": [ "signature": [
"() => string" "() => any"
], ],
"path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts",
"deprecated": false, "deprecated": false,
@ -2051,7 +2117,7 @@
"label": "getDisplayName", "label": "getDisplayName",
"description": [], "description": [],
"signature": [ "signature": [
"() => string" "() => any"
], ],
"path": "src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx", "path": "src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx",
"deprecated": false, "deprecated": false,
@ -2083,7 +2149,7 @@
"label": "getDescription", "label": "getDescription",
"description": [], "description": [],
"signature": [ "signature": [
"() => string" "() => any"
], ],
"path": "src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx", "path": "src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx",
"deprecated": false, "deprecated": false,
@ -2108,7 +2174,13 @@
"text": "EmbeddableStateWithType" "text": "EmbeddableStateWithType"
}, },
", references: ", ", references: ",
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]) => ", "[]) => ",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
@ -2145,7 +2217,13 @@
"label": "references", "label": "references",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]" "[]"
], ],
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts", "path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
@ -2179,7 +2257,13 @@
"text": "EmbeddableStateWithType" "text": "EmbeddableStateWithType"
}, },
"; references: ", "; references: ",
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]; }" "[]; }"
], ],
"path": "src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx", "path": "src/plugins/controls/public/options_list/embeddable/options_list_embeddable_factory.tsx",
@ -2581,7 +2665,7 @@
"label": "getDisplayName", "label": "getDisplayName",
"description": [], "description": [],
"signature": [ "signature": [
"() => string" "() => any"
], ],
"path": "src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx", "path": "src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx",
"deprecated": false, "deprecated": false,
@ -2597,7 +2681,7 @@
"label": "getDescription", "label": "getDescription",
"description": [], "description": [],
"signature": [ "signature": [
"() => string" "() => any"
], ],
"path": "src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx", "path": "src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx",
"deprecated": false, "deprecated": false,
@ -2938,7 +3022,13 @@
"text": "EmbeddableStateWithType" "text": "EmbeddableStateWithType"
}, },
", references: ", ", references: ",
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]) => ", "[]) => ",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
@ -2975,7 +3065,13 @@
"label": "references", "label": "references",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]" "[]"
], ],
"path": "src/plugins/kibana_utils/common/persistable_state/types.ts", "path": "src/plugins/kibana_utils/common/persistable_state/types.ts",
@ -3009,7 +3105,13 @@
"text": "EmbeddableStateWithType" "text": "EmbeddableStateWithType"
}, },
"; references: ", "; references: ",
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]; }" "[]; }"
], ],
"path": "src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx", "path": "src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable_factory.tsx",
@ -3185,7 +3287,13 @@
"label": "filters", "label": "filters",
"description": [], "description": [],
"signature": [ "signature": [
"Filter", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined" "[] | undefined"
], ],
"path": "src/plugins/controls/public/types.ts", "path": "src/plugins/controls/public/types.ts",
@ -4016,11 +4124,29 @@
"text": "EmbeddableInput" "text": "EmbeddableInput"
}, },
" & { query?: ", " & { query?: ",
"Query", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined; filters?: ", " | undefined; filters?: ",
"Filter", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined; timeRange?: ", "[] | undefined; timeRange?: ",
"TimeRange", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; timeslice?: [number, number] | undefined; controlStyle?: ", " | undefined; timeslice?: [number, number] | undefined; controlStyle?: ",
"ControlStyle", "ControlStyle",
" | undefined; ignoreParentSettings?: ", " | undefined; ignoreParentSettings?: ",
@ -4422,7 +4548,13 @@
"text": "RawControlGroupAttributes" "text": "RawControlGroupAttributes"
}, },
", \"id\">) => ", ", \"id\">) => ",
"SerializableRecord" {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
}
], ],
"path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "path": "src/plugins/controls/common/control_group/control_group_persistence.ts",
"deprecated": false, "deprecated": false,
@ -4464,7 +4596,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(serializable: ", "(serializable: ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
") => Omit<", ") => Omit<",
{ {
"pluginId": "controls", "pluginId": "controls",
@ -4487,7 +4625,13 @@
"label": "serializable", "label": "serializable",
"description": [], "description": [],
"signature": [ "signature": [
"SerializableRecord" {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
}
], ],
"path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "path": "src/plugins/controls/common/control_group/control_group_persistence.ts",
"deprecated": false, "deprecated": false,
@ -5111,11 +5255,23 @@
"text": "ControlsPanels" "text": "ControlsPanels"
}, },
" & ", " & ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
"; ignoreParentSettings: ", "; ignoreParentSettings: ",
"ParentIgnoreSettings", "ParentIgnoreSettings",
" & ", " & ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
"; }" "; }"
], ],
"path": "src/plugins/controls/common/control_group/types.ts", "path": "src/plugins/controls/common/control_group/types.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/controls
title: "controls" title: "controls"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the controls plugin description: API docs for the controls plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
--- ---
import controlsObj from './controls.devdocs.json'; import controlsObj from './controls.devdocs.json';

File diff suppressed because one or more lines are too long

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/core
title: "core" title: "core"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the core plugin description: API docs for the core plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core']
--- ---
import coreObj from './core.devdocs.json'; import coreObj from './core.devdocs.json';
@ -21,7 +21,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 2700 | 0 | 0 | 0 | | 2703 | 17 | 1201 | 0 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/customIntegrations
title: "customIntegrations" title: "customIntegrations"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the customIntegrations plugin description: API docs for the customIntegrations plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
--- ---
import customIntegrationsObj from './custom_integrations.devdocs.json'; import customIntegrationsObj from './custom_integrations.devdocs.json';

View file

@ -330,7 +330,13 @@
"label": "filters", "label": "filters",
"description": [], "description": [],
"signature": [ "signature": [
"Filter", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]" "[]"
], ],
"path": "src/plugins/dashboard/public/types.ts", "path": "src/plugins/dashboard/public/types.ts",
@ -400,7 +406,13 @@
"label": "executionContext", "label": "executionContext",
"description": [], "description": [],
"signature": [ "signature": [
"KibanaExecutionContext", {
"pluginId": "@kbn/core-execution-context-common",
"scope": "common",
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
"section": "def-common.KibanaExecutionContext",
"text": "KibanaExecutionContext"
},
" | undefined" " | undefined"
], ],
"path": "src/plugins/dashboard/public/types.ts", "path": "src/plugins/dashboard/public/types.ts",
@ -457,7 +469,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"{ [key: string]: ", "{ [key: string]: ",
"Serializable", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.Serializable",
"text": "Serializable"
},
"; }" "; }"
], ],
"path": "src/plugins/dashboard/common/types.ts", "path": "src/plugins/dashboard/common/types.ts",
@ -621,7 +639,13 @@
], ],
"signature": [ "signature": [
"{ dashboardId?: string | undefined; timeRange?: ", "{ dashboardId?: string | undefined; timeRange?: ",
"TimeRange", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; refreshInterval?: ", " | undefined; refreshInterval?: ",
{ {
"pluginId": "data", "pluginId": "data",
@ -631,9 +655,21 @@
"text": "RefreshInterval" "text": "RefreshInterval"
}, },
" | undefined; filters?: ", " | undefined; filters?: ",
"Filter", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined; query?: ", "[] | undefined; query?: ",
"Query", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined; useHash?: boolean | undefined; preserveSavedFilters?: boolean | undefined; viewMode?: ", " | undefined; useHash?: boolean | undefined; preserveSavedFilters?: boolean | undefined; viewMode?: ",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
@ -651,7 +687,13 @@
"text": "SavedDashboardPanel" "text": "SavedDashboardPanel"
}, },
" & ", " & ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
")[] | undefined; savedQuery?: string | undefined; tags?: string[] | undefined; options?: ", ")[] | undefined; savedQuery?: string | undefined; tags?: string[] | undefined; options?: ",
"DashboardOptions", "DashboardOptions",
" | undefined; controlGroupInput?: ", " | undefined; controlGroupInput?: ",
@ -939,9 +981,21 @@
"description": [], "description": [],
"signature": [ "signature": [
"(savedObjectClient: Pick<", "(savedObjectClient: Pick<",
"ISavedObjectsRepository", {
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.ISavedObjectsRepository",
"text": "ISavedObjectsRepository"
},
", \"find\">, embeddableType: string) => Promise<{ [key: string]: ", ", \"find\">, embeddableType: string) => Promise<{ [key: string]: ",
"Serializable", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.Serializable",
"text": "Serializable"
},
"; }[]>" "; }[]>"
], ],
"path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts", "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts",
@ -957,7 +1011,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"Pick<", "Pick<",
"ISavedObjectsRepository", {
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.ISavedObjectsRepository",
"text": "ISavedObjectsRepository"
},
", \"find\">" ", \"find\">"
], ],
"path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts", "path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts",
@ -1320,7 +1380,13 @@
"text": "EmbeddableStateWithType" "text": "EmbeddableStateWithType"
}, },
"; references: ", "; references: ",
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]; }" "[]; }"
], ],
"path": "src/plugins/dashboard/common/persistable_state/dashboard_container_references.ts", "path": "src/plugins/dashboard/common/persistable_state/dashboard_container_references.ts",
@ -1377,7 +1443,13 @@
"text": "EmbeddableStateWithType" "text": "EmbeddableStateWithType"
}, },
", references: ", ", references: ",
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]) => ", "[]) => ",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
@ -1477,7 +1549,13 @@
"({ attributes, references = [] }: SavedObjectAttributesAndReferences, deps: ", "({ attributes, references = [] }: SavedObjectAttributesAndReferences, deps: ",
"InjectDeps", "InjectDeps",
") => ", ") => ",
"SavedObjectAttributes" {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
}
], ],
"path": "src/plugins/dashboard/common/persistable_state/dashboard_saved_object_references.ts", "path": "src/plugins/dashboard/common/persistable_state/dashboard_saved_object_references.ts",
"deprecated": false, "deprecated": false,
@ -1991,7 +2069,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"{ [key: string]: ", "{ [key: string]: ",
"Serializable", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.Serializable",
"text": "Serializable"
},
"; }" "; }"
], ],
"path": "src/plugins/dashboard/common/types.ts", "path": "src/plugins/dashboard/common/types.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboard
title: "dashboard" title: "dashboard"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboard plugin description: API docs for the dashboard plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
--- ---
import dashboardObj from './dashboard.devdocs.json'; import dashboardObj from './dashboard.devdocs.json';

View file

@ -212,7 +212,7 @@
"label": "getDisplayName", "label": "getDisplayName",
"description": [], "description": [],
"signature": [ "signature": [
"() => string" "() => any"
], ],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
"deprecated": false, "deprecated": false,
@ -552,7 +552,13 @@
"text": "DashboardStart" "text": "DashboardStart"
}, },
"; }, unknown, ", "; }, unknown, ",
"CoreStart", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
">" ">"
], ],
"path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx", "path": "x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx",
@ -642,7 +648,13 @@
"; navigate(options: ", "; navigate(options: ",
"RedirectOptions", "RedirectOptions",
"<", "<",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">): void; setAnonymousAccessServiceProvider: (provider: () => ", ">): void; setAnonymousAccessServiceProvider: (provider: () => ",
{ {
"pluginId": "share", "pluginId": "share",
@ -758,7 +770,13 @@
"; navigate(options: ", "; navigate(options: ",
"RedirectOptions", "RedirectOptions",
"<", "<",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">): void; }" ">): void; }"
], ],
"path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts", "path": "x-pack/plugins/dashboard_enhanced/public/plugin.ts",
@ -964,7 +982,13 @@
"text": "SerializedEvent" "text": "SerializedEvent"
}, },
"; references: ", "; references: ",
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]; }" "[]; }"
], ],
"path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts", "path": "x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts",
@ -1016,7 +1040,13 @@
"text": "SerializedEvent" "text": "SerializedEvent"
}, },
", references: ", ", references: ",
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]) => ", "[]) => ",
{ {
"pluginId": "uiActionsEnhanced", "pluginId": "uiActionsEnhanced",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced
title: "dashboardEnhanced" title: "dashboardEnhanced"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboardEnhanced plugin description: API docs for the dashboardEnhanced plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
--- ---
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json'; import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';

File diff suppressed because it is too large Load diff

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data
title: "data" title: "data"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the data plugin description: API docs for the data plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
--- ---
import dataObj from './data.devdocs.json'; import dataObj from './data.devdocs.json';
@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 3251 | 33 | 2523 | 24 | | 3251 | 119 | 2546 | 24 |
## Client ## Client

File diff suppressed because it is too large Load diff

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query
title: "data.query" title: "data.query"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the data.query plugin description: API docs for the data.query plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
--- ---
import dataQueryObj from './data_query.devdocs.json'; import dataQueryObj from './data_query.devdocs.json';
@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 3251 | 33 | 2523 | 24 | | 3251 | 119 | 2546 | 24 |
## Client ## Client

File diff suppressed because it is too large Load diff

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search
title: "data.search" title: "data.search"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the data.search plugin description: API docs for the data.search plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
--- ---
import dataSearchObj from './data_search.devdocs.json'; import dataSearchObj from './data_search.devdocs.json';
@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 3251 | 33 | 2523 | 24 | | 3251 | 119 | 2546 | 24 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewEditor
title: "dataViewEditor" title: "dataViewEditor"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewEditor plugin description: API docs for the dataViewEditor plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
--- ---
import dataViewEditorObj from './data_view_editor.devdocs.json'; import dataViewEditorObj from './data_view_editor.devdocs.json';

View file

@ -95,7 +95,7 @@
"section": "def-public.FormatEditorState", "section": "def-public.FormatEditorState",
"text": "FormatEditorState" "text": "FormatEditorState"
}, },
") => { error: string | undefined; samples: ", ") => { error: any; samples: ",
{ {
"pluginId": "dataViewFieldEditor", "pluginId": "dataViewFieldEditor",
"scope": "public", "scope": "public",
@ -406,7 +406,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(newParams: ", "(newParams: ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
") => void" ") => void"
], ],
"path": "src/plugins/data_view_field_editor/public/components/field_format_editor/editors/types.ts", "path": "src/plugins/data_view_field_editor/public/components/field_format_editor/editors/types.ts",
@ -421,7 +427,13 @@
"label": "newParams", "label": "newParams",
"description": [], "description": [],
"signature": [ "signature": [
"SerializableRecord" {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
}
], ],
"path": "src/plugins/data_view_field_editor/public/components/field_format_editor/editors/types.ts", "path": "src/plugins/data_view_field_editor/public/components/field_format_editor/editors/types.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor
title: "dataViewFieldEditor" title: "dataViewFieldEditor"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewFieldEditor plugin description: API docs for the dataViewFieldEditor plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
--- ---
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json'; import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewManagement
title: "dataViewManagement" title: "dataViewManagement"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewManagement plugin description: API docs for the dataViewManagement plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
--- ---
import dataViewManagementObj from './data_view_management.devdocs.json'; import dataViewManagementObj from './data_view_management.devdocs.json';

File diff suppressed because one or more lines are too long

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews
title: "dataViews" title: "dataViews"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViews plugin description: API docs for the dataViews plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
--- ---
import dataViewsObj from './data_views.devdocs.json'; import dataViewsObj from './data_views.devdocs.json';
@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 1021 | 0 | 229 | 2 | | 1021 | 0 | 231 | 2 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataVisualizer
title: "dataVisualizer" title: "dataVisualizer"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataVisualizer plugin description: API docs for the dataVisualizer plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
--- ---
import dataVisualizerObj from './data_visualizer.devdocs.json'; import dataVisualizerObj from './data_visualizer.devdocs.json';

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
title: Deprecated API usage by API title: Deprecated API usage by API
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---
@ -24,15 +24,17 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.create" text="create"/> | alerting, discover, securitySolution | - | | <DocLink id="kibDataPluginApi" section="def-common.SearchSource.create" text="create"/> | alerting, discover, securitySolution | - |
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | - | | <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | - |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | actions, alerting | - | | <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | actions, alerting | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | savedObjects, embeddable, fleet, visualizations, dashboard, infra, canvas, graph, actions, alerting, enterpriseSearch, securitySolution, taskManager, savedSearch, ml, @kbn/core-saved-objects-server-internal | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | @kbn/core-saved-objects-common, savedObjects, embeddable, fleet, visualizations, dashboard, infra, canvas, graph, actions, alerting, enterpriseSearch, securitySolution, taskManager, savedSearch, ml, @kbn/core-saved-objects-server-internal | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | savedObjects, embeddable, fleet, visualizations, dashboard, infra, canvas, graph, actions, alerting, enterpriseSearch, securitySolution, taskManager, savedSearch, ml, @kbn/core-saved-objects-server-internal | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | @kbn/core-saved-objects-common, savedObjects, embeddable, fleet, visualizations, dashboard, infra, canvas, graph, actions, alerting, enterpriseSearch, securitySolution, taskManager, savedSearch, ml, @kbn/core-saved-objects-server-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | core, savedObjects, embeddable, fleet, visualizations, dashboard, infra, canvas, graph, actions, alerting, enterpriseSearch, securitySolution, taskManager, savedSearch, ml, @kbn/core-saved-objects-server-internal | - |
| <DocLink id="kibDataPluginApi" section="def-public.syncQueryStateWithUrl" text="syncQueryStateWithUrl"/> | discover, maps, monitoring | - | | <DocLink id="kibDataPluginApi" section="def-public.syncQueryStateWithUrl" text="syncQueryStateWithUrl"/> | discover, maps, monitoring | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.title" text="title"/> | securitySolution, timelines, lists, threatIntelligence, dataViews, dataViewEditor, unifiedSearch, triggersActionsUi, savedObjectsManagement, unifiedFieldList, aiops, presentationUtil, controls, lens, observability, infra, dataVisualizer, ml, fleet, visTypeTimeseries, apm, canvas, reporting, graph, stackAlerts, synthetics, transform, upgradeAssistant, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, visTypeTimelion, visTypeVega, discover, data | - | | <DocLink id="kibDataPluginApi" section="def-common.DataView.title" text="title"/> | @kbn/es-query, securitySolution, timelines, lists, threatIntelligence, dataViews, dataViewEditor, unifiedSearch, triggersActionsUi, savedObjectsManagement, unifiedFieldList, aiops, presentationUtil, controls, lens, observability, infra, dataVisualizer, ml, fleet, visTypeTimeseries, apm, canvas, reporting, graph, stackAlerts, synthetics, transform, upgradeAssistant, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, visTypeTimelion, visTypeVega, discover, data | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.title" text="title"/> | securitySolution, timelines, lists, threatIntelligence, dataViews, dataViewEditor, unifiedSearch, triggersActionsUi, savedObjectsManagement, unifiedFieldList, aiops, presentationUtil, controls, lens, observability, infra, dataVisualizer, ml, fleet, visTypeTimeseries, apm, canvas, reporting, graph, stackAlerts, synthetics, transform, upgradeAssistant, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, visTypeTimelion, visTypeVega, discover, data | - | | <DocLink id="kibDataPluginApi" section="def-server.DataView.title" text="title"/> | @kbn/es-query, securitySolution, timelines, lists, threatIntelligence, dataViews, dataViewEditor, unifiedSearch, triggersActionsUi, savedObjectsManagement, unifiedFieldList, aiops, presentationUtil, controls, lens, observability, infra, dataVisualizer, ml, fleet, visTypeTimeseries, apm, canvas, reporting, graph, stackAlerts, synthetics, transform, upgradeAssistant, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, visTypeTimelion, visTypeVega, discover, data | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | securitySolution, timelines, lists, threatIntelligence, data, dataViewEditor, unifiedSearch, triggersActionsUi, savedObjectsManagement, unifiedFieldList, aiops, presentationUtil, controls, lens, observability, infra, dataVisualizer, ml, fleet, visTypeTimeseries, apm, canvas, reporting, graph, stackAlerts, synthetics, transform, upgradeAssistant, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, visTypeTimelion, visTypeVega, discover | - | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | @kbn/es-query, securitySolution, timelines, lists, threatIntelligence, data, dataViewEditor, unifiedSearch, triggersActionsUi, savedObjectsManagement, unifiedFieldList, aiops, presentationUtil, controls, lens, observability, infra, dataVisualizer, ml, fleet, visTypeTimeseries, apm, canvas, reporting, graph, stackAlerts, synthetics, transform, upgradeAssistant, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, visTypeTimelion, visTypeVega, discover | - |
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.executeTriggerActions" text="executeTriggerActions"/> | data, discover, embeddable | - | | <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.executeTriggerActions" text="executeTriggerActions"/> | data, discover, embeddable | - |
| <DocLink id="kibCorePluginApi" section="def-public.UiSettingsParams.metric" text="metric"/> | advancedSettings, discover | - | | <DocLink id="kibCorePluginApi" section="def-public.UiSettingsParams.metric" text="metric"/> | advancedSettings, discover | - |
| <DocLink id="kibCorePluginApi" section="def-server.UiSettingsParams.metric" text="metric"/> | advancedSettings, discover | - | | <DocLink id="kibCorePluginApi" section="def-server.UiSettingsParams.metric" text="metric"/> | advancedSettings, discover | - |
| <DocLink id="kibKbnCoreUiSettingsCommonPluginApi" section="def-common.UiSettingsParams.metric" text="metric"/> | advancedSettings, discover | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | infra, graph, securitySolution, stackAlerts, inputControlVis, savedObjects | - | | <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | infra, graph, securitySolution, stackAlerts, inputControlVis, savedObjects | - |
| <DocLink id="kibDataPluginApi" section="def-common.EqlSearchStrategyRequest.options" text="options"/> | securitySolution | - | | <DocLink id="kibDataPluginApi" section="def-common.EqlSearchStrategyRequest.options" text="options"/> | securitySolution | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | encryptedSavedObjects, actions, data, ml, logstash, securitySolution, cloudChat | - | | <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | encryptedSavedObjects, actions, data, ml, logstash, securitySolution, cloudChat | - |
@ -54,7 +56,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKibanaReactPluginApi" section="def-public.RedirectAppLinks" text="RedirectAppLinks"/> | home, data, esUiShared, spaces, savedObjectsManagement, fleet, observability, ml, apm, indexLifecycleManagement, synthetics, upgradeAssistant, ux, kibanaOverview | - | | <DocLink id="kibKibanaReactPluginApi" section="def-public.RedirectAppLinks" text="RedirectAppLinks"/> | home, data, esUiShared, spaces, savedObjectsManagement, fleet, observability, ml, apm, indexLifecycleManagement, synthetics, upgradeAssistant, ux, kibanaOverview | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | spaces, savedObjectsManagement | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | spaces, savedObjectsManagement | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | spaces, savedObjectsManagement | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | spaces, savedObjectsManagement | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaPageTemplate" text="KibanaPageTemplate"/> | spaces, ml, canvas, osquery | - | | <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | spaces, savedObjectsManagement | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaPageTemplate" text="KibanaPageTemplate"/> | home, spaces, ml, canvas, osquery | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | actions, ml, savedObjectsTagging, enterpriseSearch | - | | <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | actions, ml, savedObjectsTagging, enterpriseSearch | - |
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionFunctionDefinition.context" text="context"/> | canvas | - | | <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionFunctionDefinition.context" text="context"/> | canvas | - |
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionsServiceSetup.getFunction" text="getFunction"/> | canvas | - | | <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionsServiceSetup.getFunction" text="getFunction"/> | canvas | - |
@ -69,33 +72,46 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.removeScriptedField" text="removeScriptedField"/> | dataViewManagement | - | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.removeScriptedField" text="removeScriptedField"/> | dataViewManagement | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.getScriptedFields" text="getScriptedFields"/> | dataViewManagement | - | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.getScriptedFields" text="getScriptedFields"/> | dataViewManagement | - |
| <DocLink id="kibSecurityPluginApi" section="def-public.SecurityPluginStart.uiApi" text="uiApi"/> | enterpriseSearch | - | | <DocLink id="kibSecurityPluginApi" section="def-public.SecurityPluginStart.uiApi" text="uiApi"/> | enterpriseSearch | - |
| <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | console, @kbn/core-elasticsearch-server-internal, @kbn/core-plugins-server-internal | - | | <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | @kbn/core-elasticsearch-server-internal, @kbn/core-plugins-server-internal, console | - |
| <DocLink id="kibCorePluginApi" section="def-server.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> | @kbn/core-plugins-server-internal | - | | <DocLink id="kibCorePluginApi" section="def-server.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> | @kbn/core-plugins-server-internal | - |
| <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getKibanaFeatures" text="getKibanaFeatures"/> | spaces, security, alerting | 8.8.0 | | <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getKibanaFeatures" text="getKibanaFeatures"/> | spaces, security, alerting | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, securitySolution, snapshotRestore, transform, upgradeAssistant | 8.8.0 | | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, securitySolution, snapshotRestore, transform, upgradeAssistant | 8.8.0 |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | embeddable, discover, presentationUtil, dashboard, graph | 8.8.0 | | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | embeddable, discover, presentationUtil, dashboard, graph | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | apm, security, securitySolution | 8.8.0 | | <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | apm, security, securitySolution | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | apm, security, securitySolution | 8.8.0 | | <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | apm, security, securitySolution | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | visualizations, dashboard, lens, maps, ml, securitySolution, security, @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks, visualizations, dashboard, lens, maps, ml, securitySolution, security | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | securitySolution, @kbn/core-application-browser-internal | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | @kbn/core-application-browser, @kbn/core-application-browser-internal, securitySolution | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppLeaveHandler" text="AppLeaveHandler"/> | @kbn/core-application-browser-internal, core, securitySolution | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks, visualizations, dashboard, lens, maps, ml, securitySolution, security, core | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | maps, dashboard, @kbn/core-saved-objects-migration-server-internal | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | maps, dashboard, @kbn/core-saved-objects-migration-server-internal | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | monitoring, kibanaUsageCollection, @kbn/core-apps-browser-internal, @kbn/core-metrics-server-internal, @kbn/core-status-server-internal, @kbn/core-usage-data-server-internal | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | @kbn/core-apps-browser-internal, @kbn/core-metrics-server-internal, @kbn/core-status-server-internal, @kbn/core-usage-data-server-internal, monitoring, kibanaUsageCollection | 8.8.0 |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | savedObjectsTaggingOss, dashboard | 8.8.0 | | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | savedObjectsTaggingOss, dashboard | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | security, licenseManagement, ml, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | 8.8.0 | | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | security, licenseManagement, ml, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | 8.8.0 |
| <DocLink id="kibFeaturesPluginApi" section="def-public.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 | | <DocLink id="kibFeaturesPluginApi" section="def-public.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 |
| <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 | | <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 |
| <DocLink id="kibFeaturesPluginApi" section="def-server.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 | | <DocLink id="kibFeaturesPluginApi" section="def-server.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | management, fleet, security, kibanaOverview, @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks, management, fleet, security, kibanaOverview | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks, management, fleet, security, kibanaOverview, core | 8.8.0 |
| <DocLink id="kibHomePluginApi" section="def-public.HomePublicPluginSetup.environment" text="environment"/> | apm | 8.8.0 | | <DocLink id="kibHomePluginApi" section="def-public.HomePublicPluginSetup.environment" text="environment"/> | apm | 8.8.0 |
| <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getElasticsearchFeatures" text="getElasticsearchFeatures"/> | security | 8.8.0 | | <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getElasticsearchFeatures" text="getElasticsearchFeatures"/> | security | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.refresh" text="refresh"/> | mapsEms | 8.8.0 | | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.refresh" text="refresh"/> | mapsEms | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-server.AsyncPlugin" text="AsyncPlugin"/> | @kbn/core-plugins-server-internal | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-server.AsyncPlugin" text="AsyncPlugin"/> | @kbn/core-plugins-server, @kbn/core-plugins-server-internal, core | 8.8.0 |
| <DocLink id="kibKbnCoreInjectedMetadataBrowserPluginApi" section="def-common.InjectedMetadataStart" text="InjectedMetadataStart"/> | @kbn/core-lifecycle-browser | 8.8.0 |
| <DocLink id="kibKbnCoreInjectedMetadataBrowserPluginApi" section="def-common.InjectedMetadataSetup" text="InjectedMetadataSetup"/> | @kbn/core-lifecycle-browser | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.IHttpFetchError.req" text="req"/> | ml, @kbn/core-http-browser-internal | 8.8.0 | <DocLink id="kibCorePluginApi" section="def-public.IHttpFetchError.req" text="req"/> | ml, @kbn/core-http-browser-internal | 8.8.0
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibKbnCoreHttpBrowserPluginApi" section="def-common.IHttpFetchError.req" text="req"/> | ml, @kbn/core-http-browser-internal | 8.8.0
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
so TS and code-reference navigation might not highlight them. | so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibCorePluginApi" section="def-public.IHttpFetchError.res" text="res"/> | @kbn/core-http-browser-internal | 8.8.0 | <DocLink id="kibCorePluginApi" section="def-public.IHttpFetchError.res" text="res"/> | @kbn/core-http-browser-internal | 8.8.0
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibKbnCoreHttpBrowserPluginApi" section="def-common.IHttpFetchError.res" text="res"/> | @kbn/core-http-browser-internal | 8.8.0
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
so TS and code-reference navigation might not highlight them. | so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureElasticsearchPrivileges.requiredRoles" text="requiredRoles"/> | security | 8.8.0 | <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureElasticsearchPrivileges.requiredRoles" text="requiredRoles"/> | security | 8.8.0
@ -144,19 +160,4 @@ Safe to remove.
| <DocLink id="kibReportingPluginApi" section="def-common.BasePayload" text="BasePayload"/> | reporting | | <DocLink id="kibReportingPluginApi" section="def-common.BasePayload" text="BasePayload"/> | reporting |
| <DocLink id="kibReportingPluginApi" section="def-common.JobAppParamsPDF" text="JobAppParamsPDF"/> | reporting | | <DocLink id="kibReportingPluginApi" section="def-common.JobAppParamsPDF" text="JobAppParamsPDF"/> | reporting |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.ConcreteTaskInstance.interval" text="interval"/> | taskManager | | <DocLink id="kibTaskManagerPluginApi" section="def-server.ConcreteTaskInstance.interval" text="interval"/> | taskManager |
| <DocLink id="kibKbnStorybookPluginApi" section="def-server.StorybookConfig.config" text="config"/> | @kbn/storybook | | <DocLink id="kibKbnStorybookPluginApi" section="def-server.StorybookConfig.config" text="config"/> | @kbn/storybook |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppLeaveHandler" text="AppLeaveHandler"/> | @kbn/core-application-browser |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | @kbn/core-application-browser |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | @kbn/core-application-browser |
| <DocLink id="kibKbnCoreElasticsearchServerPluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | @kbn/core-elasticsearch-server |
| <DocLink id="kibKbnCoreHttpBrowserPluginApi" section="def-common.IHttpFetchError.req" text="req"/> | @kbn/core-http-browser |
| <DocLink id="kibKbnCoreHttpBrowserPluginApi" section="def-common.IHttpFetchError.res" text="res"/> | @kbn/core-http-browser |
| <DocLink id="kibKbnCoreInjectedMetadataBrowserPluginApi" section="def-common.InjectedMetadataStart" text="InjectedMetadataStart"/> | @kbn/core-injected-metadata-browser |
| <DocLink id="kibKbnCoreInjectedMetadataBrowserPluginApi" section="def-common.InjectedMetadataSetup" text="InjectedMetadataSetup"/> | @kbn/core-injected-metadata-browser |
| <DocLink id="kibKbnCoreMetricsServerPluginApi" section="def-server.OpsMetrics.process" text="process"/> | @kbn/core-metrics-server |
| <DocLink id="kibKbnCorePluginsServerPluginApi" section="def-server.AsyncPlugin" text="AsyncPlugin"/> | @kbn/core-plugins-server |
| <DocLink id="kibKbnCorePluginsServerPluginApi" section="def-server.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> | @kbn/core-plugins-server |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | @kbn/core-saved-objects-common |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | @kbn/core-saved-objects-common |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | @kbn/core-saved-objects-server |
| <DocLink id="kibKbnCoreUiSettingsCommonPluginApi" section="def-common.UiSettingsParams.metric" text="metric"/> | @kbn/core-ui-settings-common |

View file

@ -7,11 +7,19 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
title: Deprecated API usage by plugin title: Deprecated API usage by plugin
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---
## @kbn/core-application-browser
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | [app_leave.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser/src/app_leave.ts#:~:text=AppLeaveHandler), [app_leave.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser/src/app_leave.ts#:~:text=AppLeaveHandler), [app_leave.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser/src/app_leave.ts#:~:text=AppLeaveHandler), [app_leave.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser/src/app_leave.ts#:~:text=AppLeaveHandler), [app_mount.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser/src/app_mount.ts#:~:text=AppLeaveHandler), [app_mount.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser/src/app_mount.ts#:~:text=AppLeaveHandler), [index.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser/index.ts#:~:text=AppLeaveHandler) | 8.8.0 |
## @kbn/core-application-browser-internal ## @kbn/core-application-browser-internal
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
@ -19,6 +27,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=appBasePath) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=appBasePath) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=onAppLeave) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=onAppLeave) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler) | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppLeaveHandler" text="AppLeaveHandler"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler) | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=appBasePath) | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=onAppLeave) | 8.8.0 |
@ -28,6 +39,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=appBasePath) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=appBasePath) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=onAppLeave) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=onAppLeave) | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=appBasePath) | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=onAppLeave) | 8.8.0 |
@ -35,7 +48,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts#:~:text=process) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process)+ 4 more | 8.8.0 |
@ -43,7 +56,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | [elasticsearch_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.ts#:~:text=legacy), [elasticsearch_service.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.test.ts#:~:text=legacy) | - | | <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | [elasticsearch_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.ts#:~:text=legacy), [elasticsearch_service.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.test.ts#:~:text=legacy), [elasticsearch_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.ts#:~:text=legacy), [elasticsearch_service.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/elasticsearch/core-elasticsearch-server-internal/src/elasticsearch_service.test.ts#:~:text=legacy) | - |
@ -59,6 +72,23 @@ so TS and code-reference navigation might not highlight them. |
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
so TS and code-reference navigation might not highlight them. | so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibKbnCoreHttpBrowserPluginApi" section="def-common.IHttpFetchError.req" text="req"/> | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/main/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/main/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req) | 8.8.0
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibKbnCoreHttpBrowserPluginApi" section="def-common.IHttpFetchError.res" text="res"/> | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/main/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=res), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/main/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=res) | 8.8.0
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
so TS and code-reference navigation might not highlight them. |
## @kbn/core-lifecycle-browser
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKbnCoreInjectedMetadataBrowserPluginApi" section="def-common.InjectedMetadataStart" text="InjectedMetadataStart"/> | [core_start.ts](https://github.com/elastic/kibana/tree/main/packages/core/lifecycle/core-lifecycle-browser/src/core_start.ts#:~:text=InjectedMetadataStart), [core_start.ts](https://github.com/elastic/kibana/tree/main/packages/core/lifecycle/core-lifecycle-browser/src/core_start.ts#:~:text=InjectedMetadataStart) | 8.8.0 |
| <DocLink id="kibKbnCoreInjectedMetadataBrowserPluginApi" section="def-common.InjectedMetadataSetup" text="InjectedMetadataSetup"/> | [core_setup.ts](https://github.com/elastic/kibana/tree/main/packages/core/lifecycle/core-lifecycle-browser/src/core_setup.ts#:~:text=InjectedMetadataSetup), [core_setup.ts](https://github.com/elastic/kibana/tree/main/packages/core/lifecycle/core-lifecycle-browser/src/core_setup.ts#:~:text=InjectedMetadataSetup) | 8.8.0 |
@ -66,7 +96,15 @@ so TS and code-reference navigation might not highlight them. |
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [ops_metrics_collector.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/ops_metrics_collector.ts#:~:text=process), [get_ops_metrics_log.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.ts#:~:text=process), [get_ops_metrics_log.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.test.ts#:~:text=process) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [ops_metrics_collector.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/ops_metrics_collector.ts#:~:text=process), [get_ops_metrics_log.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.ts#:~:text=process), [get_ops_metrics_log.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.test.ts#:~:text=process), [ops_metrics_collector.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/ops_metrics_collector.ts#:~:text=process), [get_ops_metrics_log.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.ts#:~:text=process), [get_ops_metrics_log.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.test.ts#:~:text=process) | 8.8.0 |
## @kbn/core-plugins-server
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-server.AsyncPlugin" text="AsyncPlugin"/> | [types.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server/src/types.ts#:~:text=AsyncPlugin), [index.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server/src/index.ts#:~:text=AsyncPlugin), [index.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server/index.ts#:~:text=AsyncPlugin) | 8.8.0 |
@ -74,9 +112,18 @@ so TS and code-reference navigation might not highlight them. |
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | [plugin_context.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts#:~:text=legacy), [plugin_context.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts#:~:text=legacy) | - | | <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | [plugin_context.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts#:~:text=legacy), [plugin_context.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts#:~:text=legacy), [plugin_context.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts#:~:text=legacy), [plugin_context.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin_context.ts#:~:text=legacy) | - |
| <DocLink id="kibCorePluginApi" section="def-server.AsyncPlugin" text="AsyncPlugin"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin), [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-server.AsyncPlugin" text="AsyncPlugin"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin), [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin), [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin), [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-server.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> | [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs) | - | | <DocLink id="kibCorePluginApi" section="def-server.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> | [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs)+ 2 more | - |
## @kbn/core-saved-objects-common
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [saved_objects.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts#:~:text=SavedObjectAttributes), [saved_objects.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts#:~:text=SavedObjectAttributes), [index.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-common/index.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [saved_objects.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts#:~:text=SavedObjectAttributes), [saved_objects.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts#:~:text=SavedObjectAttributes), [index.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-common/index.ts#:~:text=SavedObjectAttributes) | - |
@ -84,7 +131,7 @@ so TS and code-reference navigation might not highlight them. |
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/document_migrator.test.ts#:~:text=warning), [migration_logger.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/migration_logger.ts#:~:text=warning) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/document_migrator.test.ts#:~:text=warning), [migration_logger.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/migration_logger.ts#:~:text=warning), [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/document_migrator.test.ts#:~:text=warning), [migration_logger.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/migration_logger.ts#:~:text=warning) | 8.8.0 |
@ -94,6 +141,7 @@ so TS and code-reference navigation might not highlight them. |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [collect_references_deep.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts#:~:text=SavedObjectAttributes), [collect_references_deep.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [collect_references_deep.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts#:~:text=SavedObjectAttributes), [collect_references_deep.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [collect_references_deep.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts#:~:text=SavedObjectAttributes), [collect_references_deep.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [collect_references_deep.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts#:~:text=SavedObjectAttributes), [collect_references_deep.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [collect_references_deep.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts#:~:text=SavedObjectAttributes), [collect_references_deep.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/legacy_import_export/lib/collect_references_deep.test.ts#:~:text=SavedObjectAttributes) | - |
@ -101,7 +149,7 @@ so TS and code-reference navigation might not highlight them. |
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [status.ts](https://github.com/elastic/kibana/tree/main/packages/core/status/core-status-server-internal/src/routes/status.ts#:~:text=process), [status.ts](https://github.com/elastic/kibana/tree/main/packages/core/status/core-status-server-internal/src/routes/status.ts#:~:text=process) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [status.ts](https://github.com/elastic/kibana/tree/main/packages/core/status/core-status-server-internal/src/routes/status.ts#:~:text=process), [status.ts](https://github.com/elastic/kibana/tree/main/packages/core/status/core-status-server-internal/src/routes/status.ts#:~:text=process), [status.ts](https://github.com/elastic/kibana/tree/main/packages/core/status/core-status-server-internal/src/routes/status.ts#:~:text=process), [status.ts](https://github.com/elastic/kibana/tree/main/packages/core/status/core-status-server-internal/src/routes/status.ts#:~:text=process) | 8.8.0 |
@ -109,7 +157,17 @@ so TS and code-reference navigation might not highlight them. |
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [core_usage_data_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/usage-data/core-usage-data-server-internal/src/core_usage_data_service.ts#:~:text=process), [core_usage_data_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/usage-data/core-usage-data-server-internal/src/core_usage_data_service.ts#:~:text=process), [core_usage_data_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/usage-data/core-usage-data-server-internal/src/core_usage_data_service.ts#:~:text=process) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [core_usage_data_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/usage-data/core-usage-data-server-internal/src/core_usage_data_service.ts#:~:text=process), [core_usage_data_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/usage-data/core-usage-data-server-internal/src/core_usage_data_service.ts#:~:text=process), [core_usage_data_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/usage-data/core-usage-data-server-internal/src/core_usage_data_service.ts#:~:text=process), [core_usage_data_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/usage-data/core-usage-data-server-internal/src/core_usage_data_service.ts#:~:text=process), [core_usage_data_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/usage-data/core-usage-data-server-internal/src/core_usage_data_service.ts#:~:text=process), [core_usage_data_service.ts](https://github.com/elastic/kibana/tree/main/packages/core/usage-data/core-usage-data-server-internal/src/core_usage_data_service.ts#:~:text=process) | 8.8.0 |
## @kbn/es-query
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibDataPluginApi" section="def-common.DataView.title" text="title"/> | [types.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/types.ts#:~:text=title), [build_es_query.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/build_es_query.test.ts#:~:text=title), [from_filters.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/from_filters.test.ts#:~:text=title), [from_filters.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/from_filters.test.ts#:~:text=title), [from_kuery.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/from_kuery.test.ts#:~:text=title), [handle_combined_filter.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/handle_combined_filter.test.ts#:~:text=title), [handle_nested_filter.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/handle_nested_filter.test.ts#:~:text=title), [build_filter.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/filters/build_filters/build_filter.test.ts#:~:text=title), [exists_filter.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/filters/build_filters/exists_filter.test.ts#:~:text=title), [get_filter_field.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/filters/build_filters/get_filter_field.test.ts#:~:text=title)+ 36 more | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.title" text="title"/> | [types.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/types.ts#:~:text=title), [build_es_query.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/build_es_query.test.ts#:~:text=title), [from_filters.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/from_filters.test.ts#:~:text=title), [from_filters.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/from_filters.test.ts#:~:text=title), [from_kuery.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/from_kuery.test.ts#:~:text=title), [handle_combined_filter.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/handle_combined_filter.test.ts#:~:text=title), [handle_nested_filter.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/handle_nested_filter.test.ts#:~:text=title), [build_filter.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/filters/build_filters/build_filter.test.ts#:~:text=title), [exists_filter.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/filters/build_filters/exists_filter.test.ts#:~:text=title), [get_filter_field.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/filters/build_filters/get_filter_field.test.ts#:~:text=title)+ 36 more | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | [types.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/types.ts#:~:text=title), [build_es_query.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/build_es_query.test.ts#:~:text=title), [from_filters.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/from_filters.test.ts#:~:text=title), [from_filters.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/from_filters.test.ts#:~:text=title), [from_kuery.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/from_kuery.test.ts#:~:text=title), [handle_combined_filter.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/handle_combined_filter.test.ts#:~:text=title), [handle_nested_filter.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/es_query/handle_nested_filter.test.ts#:~:text=title), [build_filter.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/filters/build_filters/build_filter.test.ts#:~:text=title), [exists_filter.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/filters/build_filters/exists_filter.test.ts#:~:text=title), [get_filter_field.test.ts](https://github.com/elastic/kibana/tree/main/packages/kbn-es-query/src/filters/build_filters/get_filter_field.test.ts#:~:text=title)+ 13 more | - |
@ -123,6 +181,7 @@ so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/plugin.ts#:~:text=index), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/plugin.ts#:~:text=index) | - | | <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/plugin.ts#:~:text=index), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/plugin.ts#:~:text=index) | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes)+ 3 more | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes)+ 3 more | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes)+ 3 more | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes)+ 3 more | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [actions_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/actions_client.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/actions/server/types.ts#:~:text=SavedObjectAttributes)+ 3 more | - |
@ -132,6 +191,7 @@ so TS and code-reference navigation might not highlight them. |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-public.UiSettingsParams.metric" text="metric"/> | [to_editable_config.ts](https://github.com/elastic/kibana/tree/main/src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts#:~:text=metric) | - | | <DocLink id="kibCorePluginApi" section="def-public.UiSettingsParams.metric" text="metric"/> | [to_editable_config.ts](https://github.com/elastic/kibana/tree/main/src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts#:~:text=metric) | - |
| <DocLink id="kibCorePluginApi" section="def-server.UiSettingsParams.metric" text="metric"/> | [to_editable_config.ts](https://github.com/elastic/kibana/tree/main/src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts#:~:text=metric) | - | | <DocLink id="kibCorePluginApi" section="def-server.UiSettingsParams.metric" text="metric"/> | [to_editable_config.ts](https://github.com/elastic/kibana/tree/main/src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts#:~:text=metric) | - |
| <DocLink id="kibKbnCoreUiSettingsCommonPluginApi" section="def-common.UiSettingsParams.metric" text="metric"/> | [to_editable_config.ts](https://github.com/elastic/kibana/tree/main/src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts#:~:text=metric) | - |
@ -158,6 +218,7 @@ so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | [task.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/usage/task.ts#:~:text=index) | - | | <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | [task.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/usage/task.ts#:~:text=index) | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes)+ 11 more | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes)+ 11 more | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes)+ 11 more | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes)+ 11 more | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/common/rule.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/saved_objects/geo_containment/migrations.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/alerting/server/types.ts#:~:text=SavedObjectAttributes)+ 11 more | - |
@ -180,9 +241,9 @@ so TS and code-reference navigation might not highlight them. |
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibDataPluginApi" section="def-common.DataView.title" text="title"/> | [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title) | - | | <DocLink id="kibDataPluginApi" section="def-common.DataView.title" text="title"/> | [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.tsx#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [datasource_component.js](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/datasource/datasource_component.js#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title)+ 4 more | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.title" text="title"/> | [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title) | - | | <DocLink id="kibDataPluginApi" section="def-server.DataView.title" text="title"/> | [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.tsx#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [datasource_component.js](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/datasource/datasource_component.js#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title)+ 4 more | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title) | - | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.tsx#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [datasource_component.js](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/datasource/datasource_component.js#:~:text=title) | - |
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionFunctionDefinition.context" text="context"/> | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context) | - | | <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionFunctionDefinition.context" text="context"/> | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context) | - |
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionsServiceSetup.getFunction" text="getFunction"/> | [setup_expressions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getFunction) | - | | <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionsServiceSetup.getFunction" text="getFunction"/> | [setup_expressions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getFunction) | - |
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionsServiceSetup.getFunctions" text="getFunctions"/> | [functions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/functions/functions.test.ts#:~:text=getFunctions) | - | | <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionsServiceSetup.getFunctions" text="getFunctions"/> | [functions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/functions/functions.test.ts#:~:text=getFunctions) | - |
@ -196,6 +257,7 @@ so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaPageTemplate" text="KibanaPageTemplate"/> | [home.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate), [home.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate), [home.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate) | - | | <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaPageTemplate" text="KibanaPageTemplate"/> | [home.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate), [home.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate), [home.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/home/home.component.tsx#:~:text=KibanaPageTemplate) | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/shareable_runtime/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/shareable_runtime/types.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/custom_elements/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/custom_elements/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/workpad/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/workpad/find.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/shareable_runtime/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/shareable_runtime/types.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/custom_elements/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/custom_elements/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/workpad/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/workpad/find.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/shareable_runtime/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/shareable_runtime/types.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/custom_elements/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/custom_elements/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/workpad/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/workpad/find.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/shareable_runtime/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/shareable_runtime/types.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/custom_elements/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/custom_elements/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/workpad/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/workpad/find.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/shareable_runtime/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/shareable_runtime/types.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/custom_elements/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/custom_elements/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/workpad/find.ts#:~:text=SavedObjectAttributes), [find.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/server/routes/workpad/find.ts#:~:text=SavedObjectAttributes) | - |
@ -219,7 +281,7 @@ so TS and code-reference navigation might not highlight them. |
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/console/server/plugin.ts#:~:text=legacy) | - | | <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/console/server/plugin.ts#:~:text=legacy), [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/console/server/plugin.ts#:~:text=legacy) | - |
@ -233,6 +295,18 @@ so TS and code-reference navigation might not highlight them. |
## core
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppLeaveHandler" text="AppLeaveHandler"/> | [index.ts](https://github.com/elastic/kibana/tree/main/src/core/public/index.ts#:~:text=AppLeaveHandler) | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [mocks.ts](https://github.com/elastic/kibana/tree/main/src/core/public/mocks.ts#:~:text=appBasePath) | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [mocks.ts](https://github.com/elastic/kibana/tree/main/src/core/public/mocks.ts#:~:text=onAppLeave) | 8.8.0 |
| <DocLink id="kibKbnCorePluginsServerPluginApi" section="def-server.AsyncPlugin" text="AsyncPlugin"/> | [index.ts](https://github.com/elastic/kibana/tree/main/src/core/server/index.ts#:~:text=AsyncPlugin) | 8.8.0 |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [index.ts](https://github.com/elastic/kibana/tree/main/src/core/public/index.ts#:~:text=SavedObjectAttributes), [index.ts](https://github.com/elastic/kibana/tree/main/src/core/server/index.ts#:~:text=SavedObjectAttributes), [index.ts](https://github.com/elastic/kibana/tree/main/src/core/types/index.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/core/server/types.ts#:~:text=SavedObjectAttributes) | - |
## crossClusterReplication ## crossClusterReplication
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
@ -252,7 +326,9 @@ so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [load_dashboard_state_from_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/dashboard_saved_object/lib/load_dashboard_state_from_saved_object.ts#:~:text=SavedObjectAttributes), [load_dashboard_state_from_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/dashboard_saved_object/lib/load_dashboard_state_from_saved_object.ts#:~:text=SavedObjectAttributes), [migrate_extract_panel_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_extract_panel_references.ts#:~:text=SavedObjectAttributes), [migrate_extract_panel_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_extract_panel_references.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry.ts#:~:text=SavedObjectAttributes), [find_by_value_embeddables.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/find_by_value_embeddables.ts#:~:text=SavedObjectAttributes)+ 11 more | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [load_dashboard_state_from_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/dashboard_saved_object/lib/load_dashboard_state_from_saved_object.ts#:~:text=SavedObjectAttributes), [load_dashboard_state_from_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/dashboard_saved_object/lib/load_dashboard_state_from_saved_object.ts#:~:text=SavedObjectAttributes), [migrate_extract_panel_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_extract_panel_references.ts#:~:text=SavedObjectAttributes), [migrate_extract_panel_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_extract_panel_references.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry.ts#:~:text=SavedObjectAttributes), [find_by_value_embeddables.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/find_by_value_embeddables.ts#:~:text=SavedObjectAttributes)+ 11 more | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [load_dashboard_state_from_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/dashboard_saved_object/lib/load_dashboard_state_from_saved_object.ts#:~:text=SavedObjectAttributes), [load_dashboard_state_from_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/dashboard_saved_object/lib/load_dashboard_state_from_saved_object.ts#:~:text=SavedObjectAttributes), [migrate_extract_panel_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_extract_panel_references.ts#:~:text=SavedObjectAttributes), [migrate_extract_panel_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_extract_panel_references.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry.ts#:~:text=SavedObjectAttributes), [find_by_value_embeddables.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/find_by_value_embeddables.ts#:~:text=SavedObjectAttributes)+ 11 more | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [load_dashboard_state_from_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/dashboard_saved_object/lib/load_dashboard_state_from_saved_object.ts#:~:text=SavedObjectAttributes), [load_dashboard_state_from_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/dashboard_saved_object/lib/load_dashboard_state_from_saved_object.ts#:~:text=SavedObjectAttributes), [migrate_extract_panel_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_extract_panel_references.ts#:~:text=SavedObjectAttributes), [migrate_extract_panel_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_extract_panel_references.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry.ts#:~:text=SavedObjectAttributes), [find_by_value_embeddables.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/find_by_value_embeddables.ts#:~:text=SavedObjectAttributes)+ 11 more | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_to_730/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_to_730/migrations_730.ts#:~:text=warning) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_to_730/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_to_730/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_to_730/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_to_730/migrations_730.ts#:~:text=warning) | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [load_dashboard_state_from_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/dashboard_saved_object/lib/load_dashboard_state_from_saved_object.ts#:~:text=SavedObjectAttributes), [load_dashboard_state_from_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/dashboard_saved_object/lib/load_dashboard_state_from_saved_object.ts#:~:text=SavedObjectAttributes), [migrate_extract_panel_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_extract_panel_references.ts#:~:text=SavedObjectAttributes), [migrate_extract_panel_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_extract_panel_references.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry_collection_task.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry_collection_task.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry.ts#:~:text=SavedObjectAttributes), [dashboard_telemetry.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/dashboard_telemetry.ts#:~:text=SavedObjectAttributes), [find_by_value_embeddables.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/usage/find_by_value_embeddables.ts#:~:text=SavedObjectAttributes)+ 11 more | - |
@ -341,6 +417,7 @@ so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.executeTriggerActions" text="executeTriggerActions"/> | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=executeTriggerActions), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=executeTriggerActions), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/discover/public/plugin.tsx#:~:text=executeTriggerActions) | - | | <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.executeTriggerActions" text="executeTriggerActions"/> | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=executeTriggerActions), [search_embeddable_factory.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/public/embeddable/search_embeddable_factory.ts#:~:text=executeTriggerActions), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/discover/public/plugin.tsx#:~:text=executeTriggerActions) | - |
| <DocLink id="kibCorePluginApi" section="def-public.UiSettingsParams.metric" text="metric"/> | [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric) | - | | <DocLink id="kibCorePluginApi" section="def-public.UiSettingsParams.metric" text="metric"/> | [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric) | - |
| <DocLink id="kibCorePluginApi" section="def-server.UiSettingsParams.metric" text="metric"/> | [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric) | - | | <DocLink id="kibCorePluginApi" section="def-server.UiSettingsParams.metric" text="metric"/> | [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric) | - |
| <DocLink id="kibKbnCoreUiSettingsCommonPluginApi" section="def-common.UiSettingsParams.metric" text="metric"/> | [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/plugins/discover/server/ui_settings.ts#:~:text=metric) | - |
@ -360,6 +437,7 @@ so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.executeTriggerActions" text="executeTriggerActions"/> | [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [explicit_input.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/explicit_input.test.ts#:~:text=executeTriggerActions) | - | | <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.executeTriggerActions" text="executeTriggerActions"/> | [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [container.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/container.test.ts#:~:text=executeTriggerActions), [explicit_input.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/tests/explicit_input.test.ts#:~:text=executeTriggerActions) | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [add_panel_flyout.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_flyout.tsx#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [default_embeddable_factory_provider.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/types.ts#:~:text=SavedObjectAttributes) | - |
@ -379,6 +457,7 @@ so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | [check_access.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz), [check_access.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz), [check_access.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz) | - | | <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | [check_access.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz), [check_access.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz), [check_access.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/lib/check_access.ts#:~:text=authz) | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes), [telemetry.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/enterprise_search/server/collectors/lib/telemetry.ts#:~:text=SavedObjectAttributes) | - |
@ -413,6 +492,8 @@ so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [epm.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/epm.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes), [settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/common/types/models/settings.ts#:~:text=SavedObjectAttributes) | - |
@ -431,6 +512,7 @@ so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 | | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [saved_workspace_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts#:~:text=SavedObjectAttributes), [saved_workspace_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts#:~:text=SavedObjectAttributes), [saved_workspace_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts#:~:text=SavedObjectAttributes), [saved_workspace_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [saved_workspace_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts#:~:text=SavedObjectAttributes), [saved_workspace_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts#:~:text=SavedObjectAttributes), [saved_workspace_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts#:~:text=SavedObjectAttributes), [saved_workspace_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [saved_workspace_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts#:~:text=SavedObjectAttributes), [saved_workspace_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts#:~:text=SavedObjectAttributes), [saved_workspace_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts#:~:text=SavedObjectAttributes), [saved_workspace_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [saved_workspace_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts#:~:text=SavedObjectAttributes), [saved_workspace_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts#:~:text=SavedObjectAttributes), [saved_workspace_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts#:~:text=SavedObjectAttributes), [saved_workspace_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [saved_workspace_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts#:~:text=SavedObjectAttributes), [saved_workspace_references.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/services/persistence/saved_workspace_references.ts#:~:text=SavedObjectAttributes), [saved_workspace_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts#:~:text=SavedObjectAttributes), [saved_workspace_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/helpers/saved_workspace_utils.ts#:~:text=SavedObjectAttributes) | - |
@ -438,7 +520,8 @@ so TS and code-reference navigation might not highlight them. |
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.RedirectAppLinks" text="RedirectAppLinks"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/application.tsx#:~:text=RedirectAppLinks), [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/application.tsx#:~:text=RedirectAppLinks), [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/application.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks)+ 1 more | - | | <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaPageTemplate" text="KibanaPageTemplate"/> | [tutorial_directory.js](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/tutorial_directory.js#:~:text=KibanaPageTemplate), [tutorial_directory.js](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/tutorial_directory.js#:~:text=KibanaPageTemplate), [tutorial_directory.js](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/tutorial_directory.js#:~:text=KibanaPageTemplate), [tutorial.js](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/tutorial/tutorial.js#:~:text=KibanaPageTemplate), [tutorial.js](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/tutorial/tutorial.js#:~:text=KibanaPageTemplate), [tutorial.js](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/tutorial/tutorial.js#:~:text=KibanaPageTemplate), [tutorial.js](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/tutorial/tutorial.js#:~:text=KibanaPageTemplate) | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.RedirectAppLinks" text="RedirectAppLinks"/> | [add_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/application.tsx#:~:text=RedirectAppLinks), [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/home/public/application/application.tsx#:~:text=RedirectAppLinks)+ 1 more | - |
@ -461,6 +544,7 @@ so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | [resolved_log_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/log_views/resolved_log_view.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [use_data_view.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_data_view.test.ts#:~:text=title) | - | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | [resolved_log_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/log_views/resolved_log_view.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [validation_errors.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/logs/settings/validation_errors.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [index_patterns.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/common/dependency_mocks/index_patterns.ts#:~:text=title), [use_data_view.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/pages/metrics/hosts/hooks/use_data_view.test.ts#:~:text=title) | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [use_find_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx#:~:text=SavedObjectAttributes), [use_find_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_get_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx#:~:text=SavedObjectAttributes), [use_get_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes)+ 2 more | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [use_find_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx#:~:text=SavedObjectAttributes), [use_find_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_get_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx#:~:text=SavedObjectAttributes), [use_get_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes)+ 2 more | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [use_find_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx#:~:text=SavedObjectAttributes), [use_find_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_get_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx#:~:text=SavedObjectAttributes), [use_get_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes)+ 2 more | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [use_find_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx#:~:text=SavedObjectAttributes), [use_find_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_get_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx#:~:text=SavedObjectAttributes), [use_get_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes)+ 2 more | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [use_find_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx#:~:text=SavedObjectAttributes), [use_find_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_find_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_create_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_create_saved_object.tsx#:~:text=SavedObjectAttributes), [use_get_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx#:~:text=SavedObjectAttributes), [use_get_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_get_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes), [use_update_saved_object.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/infra/public/hooks/use_update_saved_object.tsx#:~:text=SavedObjectAttributes)+ 2 more | - |
@ -483,6 +567,7 @@ so TS and code-reference navigation might not highlight them. |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.RedirectAppLinks" text="RedirectAppLinks"/> | [add_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks) | - | | <DocLink id="kibKibanaReactPluginApi" section="def-public.RedirectAppLinks" text="RedirectAppLinks"/> | [add_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [add_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/components/add_data/add_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks), [manage_data.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/components/manage_data/manage_data.tsx#:~:text=RedirectAppLinks) | - |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath) | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath) | 8.8.0 |
@ -490,7 +575,7 @@ so TS and code-reference navigation might not highlight them. |
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [ops_stats_collector.ts](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_usage_collection/server/collectors/ops_stats/ops_stats_collector.ts#:~:text=process) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [ops_stats_collector.ts](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_usage_collection/server/collectors/ops_stats/ops_stats_collector.ts#:~:text=process), [ops_stats_collector.ts](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_usage_collection/server/collectors/ops_stats/ops_stats_collector.ts#:~:text=process) | 8.8.0 |
@ -502,6 +587,7 @@ so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.title" text="title"/> | [loader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.ts#:~:text=title), [lens_top_nav.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title), [loader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.ts#:~:text=title), [lens_top_nav.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title) | - | | <DocLink id="kibDataPluginApi" section="def-server.DataView.title" text="title"/> | [loader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.ts#:~:text=title), [lens_top_nav.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title), [loader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.ts#:~:text=title), [lens_top_nav.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title) | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | [loader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.ts#:~:text=title), [lens_top_nav.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title) | - | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | [loader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.ts#:~:text=title), [lens_top_nav.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title), [loader.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.test.ts#:~:text=title) | - |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave) | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave) | 8.8.0 |
@ -537,6 +623,7 @@ so TS and code-reference navigation might not highlight them. |
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 |
@ -552,7 +639,8 @@ so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=title) | - | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=title) | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.flattenHit" text="flattenHit"/> | [es_search_source.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.flattenHit" text="flattenHit"/> | [es_search_source.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit), [es_search_source.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/classes/sources/es_search_source/es_search_source.tsx#:~:text=flattenHit) | - |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [render_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [render_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning), [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning) | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [render_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave) | 8.8.0 |
@ -585,6 +673,12 @@ so TS and code-reference navigation might not highlight them. |
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
so TS and code-reference navigation might not highlight them. | so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [modules.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/types/modules.ts#:~:text=SavedObjectAttributes), [modules.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/types/modules.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [modules.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/types/modules.ts#:~:text=SavedObjectAttributes), [modules.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/types/modules.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/app.tsx#:~:text=onAppLeave) | 8.8.0 |
| <DocLink id="kibKbnCoreHttpBrowserPluginApi" section="def-common.IHttpFetchError.req" text="req"/> | [errors.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/util/errors/errors.test.ts#:~:text=req), [errors.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/util/errors/errors.test.ts#:~:text=req) | 8.8.0
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [modules.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/types/modules.ts#:~:text=SavedObjectAttributes), [modules.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/types/modules.ts#:~:text=SavedObjectAttributes) | - |
@ -593,7 +687,7 @@ so TS and code-reference navigation might not highlight them. |
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibDataPluginApi" section="def-public.syncQueryStateWithUrl" text="syncQueryStateWithUrl"/> | [url_state.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/monitoring/public/url_state.ts#:~:text=syncQueryStateWithUrl), [url_state.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/monitoring/public/url_state.ts#:~:text=syncQueryStateWithUrl) | - | | <DocLink id="kibDataPluginApi" section="def-public.syncQueryStateWithUrl" text="syncQueryStateWithUrl"/> | [url_state.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/monitoring/public/url_state.ts#:~:text=syncQueryStateWithUrl), [url_state.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/monitoring/public/url_state.ts#:~:text=syncQueryStateWithUrl) | - |
| <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [bulk_uploader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [bulk_uploader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process), [bulk_uploader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process) | 8.8.0 |
@ -671,6 +765,7 @@ so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | [saved_object.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/saved_object.test.ts#:~:text=indexPatterns), [saved_object.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/saved_object.test.ts#:~:text=indexPatterns) | - | | <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | [saved_object.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/saved_object.test.ts#:~:text=indexPatterns), [saved_object.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/saved_object.test.ts#:~:text=indexPatterns) | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [create_source.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/create_source.ts#:~:text=SavedObjectAttributes), [create_source.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/create_source.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#:~:text=SavedObjectAttributes)+ 15 more | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [create_source.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/create_source.ts#:~:text=SavedObjectAttributes), [create_source.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/create_source.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#:~:text=SavedObjectAttributes)+ 15 more | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [create_source.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/create_source.ts#:~:text=SavedObjectAttributes), [create_source.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/create_source.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#:~:text=SavedObjectAttributes)+ 15 more | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [create_source.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/create_source.ts#:~:text=SavedObjectAttributes), [create_source.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/create_source.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#:~:text=SavedObjectAttributes)+ 15 more | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/types.ts#:~:text=SavedObjectAttributes), [create_source.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/create_source.ts#:~:text=SavedObjectAttributes), [create_source.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/create_source.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/find_object_by_title.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts#:~:text=SavedObjectAttributes)+ 15 more | - |
@ -684,6 +779,7 @@ so TS and code-reference navigation might not highlight them. |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.RedirectAppLinks" text="RedirectAppLinks"/> | [saved_objects_edition_page.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx#:~:text=RedirectAppLinks), [saved_objects_edition_page.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx#:~:text=RedirectAppLinks), [saved_objects_edition_page.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx#:~:text=RedirectAppLinks), [saved_objects_table.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx#:~:text=RedirectAppLinks), [saved_objects_table.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx#:~:text=RedirectAppLinks), [saved_objects_table.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx#:~:text=RedirectAppLinks) | - | | <DocLink id="kibKibanaReactPluginApi" section="def-public.RedirectAppLinks" text="RedirectAppLinks"/> | [saved_objects_edition_page.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx#:~:text=RedirectAppLinks), [saved_objects_edition_page.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx#:~:text=RedirectAppLinks), [saved_objects_edition_page.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx#:~:text=RedirectAppLinks), [saved_objects_table.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx#:~:text=RedirectAppLinks), [saved_objects_table.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx#:~:text=RedirectAppLinks), [saved_objects_table.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx#:~:text=RedirectAppLinks) | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | [resolve_import_errors.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts#:~:text=createNewCopy) | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | [resolve_import_errors.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts#:~:text=createNewCopy) | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | [resolve_import_errors.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts#:~:text=createNewCopy) | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | [resolve_import_errors.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts#:~:text=createNewCopy) | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | [resolve_import_errors.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts#:~:text=createNewCopy) | - |
@ -709,6 +805,7 @@ so TS and code-reference navigation might not highlight them. |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes), [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes), [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes), [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes), [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes), [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes) | - |
@ -744,6 +841,8 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/plugin.ts#:~:text=license%24) | 8.8.0 | | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/plugin.ts#:~:text=license%24) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=onAppLeave) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=onAppLeave) | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=onAppLeave) | 8.8.0 |
@ -768,6 +867,9 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/types.ts#:~:text=AppLeaveHandler), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/types.ts#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [use_timeline_save_prompt.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/hooks/timeline/use_timeline_save_prompt.ts#:~:text=AppLeaveHandler)+ 1 more | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/types.ts#:~:text=AppLeaveHandler), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/types.ts#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [use_timeline_save_prompt.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/hooks/timeline/use_timeline_save_prompt.ts#:~:text=AppLeaveHandler)+ 1 more | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [legacy_types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_types.ts#:~:text=SavedObjectAttributes), [legacy_types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_types.ts#:~:text=SavedObjectAttributes), [legacy_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_migrations.ts#:~:text=SavedObjectAttributes), [legacy_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_migrations.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [legacy_types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_types.ts#:~:text=SavedObjectAttributes), [legacy_types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_types.ts#:~:text=SavedObjectAttributes), [legacy_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_migrations.ts#:~:text=SavedObjectAttributes), [legacy_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_migrations.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [legacy_types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_types.ts#:~:text=SavedObjectAttributes), [legacy_types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_types.ts#:~:text=SavedObjectAttributes), [legacy_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_migrations.ts#:~:text=SavedObjectAttributes), [legacy_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_migrations.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [legacy_types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_types.ts#:~:text=SavedObjectAttributes), [legacy_types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_types.ts#:~:text=SavedObjectAttributes), [legacy_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_migrations.ts#:~:text=SavedObjectAttributes), [legacy_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_migrations.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppLeaveHandler" text="AppLeaveHandler"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/types.ts#:~:text=AppLeaveHandler), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/types.ts#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [use_timeline_save_prompt.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/hooks/timeline/use_timeline_save_prompt.ts#:~:text=AppLeaveHandler)+ 1 more | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/index.tsx#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [legacy_types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_types.ts#:~:text=SavedObjectAttributes), [legacy_types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_types.ts#:~:text=SavedObjectAttributes), [legacy_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_migrations.ts#:~:text=SavedObjectAttributes), [legacy_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_actions_legacy/logic/rule_actions/legacy_migrations.ts#:~:text=SavedObjectAttributes) | - |
@ -789,6 +891,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [spaces_usage_collector.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [spaces_usage_collector.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.test.ts#:~:text=license%24) | 8.8.0 | | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [spaces_usage_collector.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [spaces_usage_collector.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.test.ts#:~:text=license%24) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | [copy_to_space_flyout_internal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx#:~:text=createNewCopy) | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | [copy_to_space_flyout_internal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx#:~:text=createNewCopy) | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | [copy_to_space_flyout_internal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx#:~:text=createNewCopy) | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | [copy_to_space_flyout_internal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx#:~:text=createNewCopy) | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | [copy_to_space_flyout_internal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx#:~:text=createNewCopy) | - |
@ -824,6 +927,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [task_store.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/task_manager/server/task_store.test.ts#:~:text=SavedObjectAttributes), [task_store.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/task_manager/server/task_store.test.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [task_store.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/task_manager/server/task_store.test.ts#:~:text=SavedObjectAttributes), [task_store.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/task_manager/server/task_store.test.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [task_store.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/task_manager/server/task_store.test.ts#:~:text=SavedObjectAttributes), [task_store.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/task_manager/server/task_store.test.ts#:~:text=SavedObjectAttributes) | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [task_store.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/task_manager/server/task_store.test.ts#:~:text=SavedObjectAttributes), [task_store.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/task_manager/server/task_store.test.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [task_store.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/task_manager/server/task_store.test.ts#:~:text=SavedObjectAttributes), [task_store.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/task_manager/server/task_store.test.ts#:~:text=SavedObjectAttributes) | - |
@ -980,6 +1084,8 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave) | 8.8.0 | | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts#:~:text=SavedObjectAttributes), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttributes), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes)+ 13 more | - | | <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts#:~:text=SavedObjectAttributes), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttributes), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes)+ 13 more | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts#:~:text=SavedObjectAttributes), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttributes), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes)+ 13 more | - | | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts#:~:text=SavedObjectAttributes), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttributes), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes)+ 13 more | - |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave) | 8.8.0 |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectAttributes), [save_with_confirmation.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/save_with_confirmation.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts#:~:text=SavedObjectAttributes), [find_object_by_title.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_objects_utils/find_object_by_title.ts#:~:text=SavedObjectAttributes), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttributes), [saved_visualization_references.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualization_references/saved_visualization_references.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes), [saved_visualize_utils.ts](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/utils/saved_visualize_utils.ts#:~:text=SavedObjectAttributes)+ 13 more | - |

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
title: Deprecated APIs due to be removed, by team title: Deprecated APIs due to be removed, by team
description: Lists the teams that are referencing deprecated APIs with a remove by date. description: Lists the teams that are referencing deprecated APIs with a remove by date.
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---
@ -48,6 +48,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| fleet | <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureKibanaPrivileges.disabled" text="disabled"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | fleet | <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureKibanaPrivileges.disabled" text="disabled"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 |
| fleet | <DocLink id="kibFeaturesPluginApi" section="def-server.FeatureKibanaPrivileges.disabled" text="disabled"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | fleet | <DocLink id="kibFeaturesPluginApi" section="def-server.FeatureKibanaPrivileges.disabled" text="disabled"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 |
| fleet | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 | | fleet | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 |
| fleet | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 |
@ -56,7 +57,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Plugin | Deprecated API | Reference location(s) | Remove By | | Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------| | --------|-------|-----------|-----------|
| maps | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [render_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave) | 8.8.0 | | maps | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [render_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave) | 8.8.0 |
| maps | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | | maps | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning), [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts#:~:text=warning) | 8.8.0 |
| maps | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [render_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/render_app.tsx#:~:text=onAppLeave), [map_app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx#:~:text=onAppLeave), [map_page.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/maps/public/routes/map_page/map_page.tsx#:~:text=onAppLeave) | 8.8.0 |
| mapsEms | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [index.ts](https://github.com/elastic/kibana/tree/main/src/plugins/maps_ems/server/index.ts#:~:text=license%24) | 8.8.0 | | mapsEms | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [index.ts](https://github.com/elastic/kibana/tree/main/src/plugins/maps_ems/server/index.ts#:~:text=license%24) | 8.8.0 |
| mapsEms | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.refresh" text="refresh"/> | [index.ts](https://github.com/elastic/kibana/tree/main/src/plugins/maps_ems/server/index.ts#:~:text=refresh) | 8.8.0 | | mapsEms | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.refresh" text="refresh"/> | [index.ts](https://github.com/elastic/kibana/tree/main/src/plugins/maps_ems/server/index.ts#:~:text=refresh) | 8.8.0 |
@ -67,9 +69,12 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Plugin | Deprecated API | Reference location(s) | Remove By | | Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------| | --------|-------|-----------|-----------|
| kibanaOverview | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath), [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=appBasePath), [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=appBasePath) | 8.8.0 | | kibanaOverview | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath), [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=appBasePath), [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=appBasePath) | 8.8.0 |
| kibanaOverview | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath), [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=appBasePath), [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=appBasePath), [mocks.ts](https://github.com/elastic/kibana/tree/main/src/core/public/mocks.ts#:~:text=appBasePath) | 8.8.0 |
| savedObjectsTaggingOss | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject) | 8.8.0 | | savedObjectsTaggingOss | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject) | 8.8.0 |
| @kbn/core-application-browser-internal | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=onAppLeave), [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=onAppLeave) | 8.8.0 | | @kbn/core-application-browser-internal | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=onAppLeave), [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=onAppLeave) | 8.8.0 |
| @kbn/core-application-browser-internal | <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler) | 8.8.0 | | @kbn/core-application-browser-internal | <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [app_leave.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser/src/app_leave.ts#:~:text=AppLeaveHandler)+ 6 more | 8.8.0 |
| @kbn/core-application-browser-internal | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppLeaveHandler" text="AppLeaveHandler"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [index.ts](https://github.com/elastic/kibana/tree/main/src/core/public/index.ts#:~:text=AppLeaveHandler) | 8.8.0 |
| @kbn/core-application-browser-internal | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=onAppLeave), [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=onAppLeave), [mocks.ts](https://github.com/elastic/kibana/tree/main/src/core/public/mocks.ts#:~:text=onAppLeave) | 8.8.0 |
| @kbn/core-http-browser-internal | <DocLink id="kibCorePluginApi" section="def-public.IHttpFetchError.req" text="req"/> | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/main/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/main/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req) | 8.8.0 | @kbn/core-http-browser-internal | <DocLink id="kibCorePluginApi" section="def-public.IHttpFetchError.req" text="req"/> | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/main/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/main/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req) | 8.8.0
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
@ -78,9 +83,19 @@ so TS and code-reference navigation might not highlight them. |
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
so TS and code-reference navigation might not highlight them. | so TS and code-reference navigation might not highlight them. |
| @kbn/core-plugins-server-internal | <DocLink id="kibCorePluginApi" section="def-server.AsyncPlugin" text="AsyncPlugin"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin), [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin) | 8.8.0 | | @kbn/core-http-browser-internal | <DocLink id="kibKbnCoreHttpBrowserPluginApi" section="def-common.IHttpFetchError.req" text="req"/> | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/main/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/main/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req) | 8.8.0
| @kbn/core-saved-objects-migration-server-internal | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/document_migrator.test.ts#:~:text=warning), [migration_logger.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/migration_logger.ts#:~:text=warning) | 8.8.0 |
| @kbn/core-apps-browser-internal | <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts#:~:text=process), [ops_metrics_collector.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/ops_metrics_collector.ts#:~:text=process), [get_ops_metrics_log.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.ts#:~:text=process), [get_ops_metrics_log.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.test.ts#:~:text=process)+ 5 more | 8.8.0 | Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
so TS and code-reference navigation might not highlight them. |
| @kbn/core-http-browser-internal | <DocLink id="kibKbnCoreHttpBrowserPluginApi" section="def-common.IHttpFetchError.res" text="res"/> | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/main/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=res), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/main/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=res) | 8.8.0
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
so TS and code-reference navigation might not highlight them. |
| @kbn/core-plugins-server-internal | <DocLink id="kibCorePluginApi" section="def-server.AsyncPlugin" text="AsyncPlugin"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin), [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin), [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin), [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin), [types.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server/src/types.ts#:~:text=AsyncPlugin), [index.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server/src/index.ts#:~:text=AsyncPlugin), [index.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server/index.ts#:~:text=AsyncPlugin), [index.ts](https://github.com/elastic/kibana/tree/main/src/core/server/index.ts#:~:text=AsyncPlugin) | 8.8.0 |
| @kbn/core-saved-objects-migration-server-internal | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/document_migrator.test.ts#:~:text=warning), [migration_logger.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/migration_logger.ts#:~:text=warning), [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/document_migrator.test.ts#:~:text=warning), [migration_logger.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/core/migration_logger.ts#:~:text=warning) | 8.8.0 |
| @kbn/core-apps-browser-internal | <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.test.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process), [load_status.ts](https://github.com/elastic/kibana/tree/main/packages/core/apps/core-apps-browser-internal/src/status/lib/load_status.ts#:~:text=process)+ 20 more | 8.8.0 |
| @kbn/core-lifecycle-browser | <DocLink id="kibKbnCoreInjectedMetadataBrowserPluginApi" section="def-common.InjectedMetadataStart" text="InjectedMetadataStart"/> | [core_start.ts](https://github.com/elastic/kibana/tree/main/packages/core/lifecycle/core-lifecycle-browser/src/core_start.ts#:~:text=InjectedMetadataStart), [core_start.ts](https://github.com/elastic/kibana/tree/main/packages/core/lifecycle/core-lifecycle-browser/src/core_start.ts#:~:text=InjectedMetadataStart) | 8.8.0 |
| @kbn/core-lifecycle-browser | <DocLink id="kibKbnCoreInjectedMetadataBrowserPluginApi" section="def-common.InjectedMetadataSetup" text="InjectedMetadataSetup"/> | [core_setup.ts](https://github.com/elastic/kibana/tree/main/packages/core/lifecycle/core-lifecycle-browser/src/core_setup.ts#:~:text=InjectedMetadataSetup), [core_setup.ts](https://github.com/elastic/kibana/tree/main/packages/core/lifecycle/core-lifecycle-browser/src/core_setup.ts#:~:text=InjectedMetadataSetup) | 8.8.0 |
@ -91,7 +106,8 @@ so TS and code-reference navigation might not highlight them. |
| dashboard | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | dashboard | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 |
| dashboard | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject) | 8.8.0 | | dashboard | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject) | 8.8.0 |
| dashboard | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 | | dashboard | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 |
| dashboard | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_to_730/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_to_730/migrations_730.ts#:~:text=warning) | 8.8.0 | | dashboard | <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_to_730/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_to_730/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_to_730/migrations_730.ts#:~:text=warning), [migrations_730.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/server/saved_objects/migrations/migrate_to_730/migrations_730.ts#:~:text=warning) | 8.8.0 |
| dashboard | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/types.ts#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 |
@ -99,7 +115,7 @@ so TS and code-reference navigation might not highlight them. |
| Plugin | Deprecated API | Reference location(s) | Remove By | | Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------| | --------|-------|-----------|-----------|
| kibanaUsageCollection | <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [ops_stats_collector.ts](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_usage_collection/server/collectors/ops_stats/ops_stats_collector.ts#:~:text=process) | 8.8.0 | | kibanaUsageCollection | <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [ops_stats_collector.ts](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_usage_collection/server/collectors/ops_stats/ops_stats_collector.ts#:~:text=process), [ops_stats_collector.ts](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_usage_collection/server/collectors/ops_stats/ops_stats_collector.ts#:~:text=process) | 8.8.0 |
@ -122,6 +138,11 @@ so TS and code-reference navigation might not highlight them. |
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
so TS and code-reference navigation might not highlight them. | so TS and code-reference navigation might not highlight them. |
| ml | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/application/app.tsx#:~:text=onAppLeave) | 8.8.0 |
| ml | <DocLink id="kibKbnCoreHttpBrowserPluginApi" section="def-common.IHttpFetchError.req" text="req"/> | [errors.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/util/errors/errors.test.ts#:~:text=req), [errors.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/common/util/errors/errors.test.ts#:~:text=req) | 8.8.0
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,
so TS and code-reference navigation might not highlight them. |
@ -148,6 +169,8 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| security | <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | | security | <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 |
| security | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 | | security | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 |
| security | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=onAppLeave) | 8.8.0 | | security | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=onAppLeave) | 8.8.0 |
| security | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 |
| security | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=onAppLeave) | 8.8.0 |
@ -169,6 +192,8 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/signals/executors/query.ts#:~:text=license%24) | 8.8.0 | | securitySolution | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/signals/executors/query.ts#:~:text=license%24) | 8.8.0 |
| securitySolution | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/index.tsx#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 | | securitySolution | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/index.tsx#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 |
| securitySolution | <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/types.ts#:~:text=AppLeaveHandler), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/types.ts#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [use_timeline_save_prompt.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/hooks/timeline/use_timeline_save_prompt.ts#:~:text=AppLeaveHandler)+ 1 more | 8.8.0 | | securitySolution | <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/types.ts#:~:text=AppLeaveHandler), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/types.ts#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [use_timeline_save_prompt.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/hooks/timeline/use_timeline_save_prompt.ts#:~:text=AppLeaveHandler)+ 1 more | 8.8.0 |
| securitySolution | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppLeaveHandler" text="AppLeaveHandler"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/timelines/components/flyout/index.tsx#:~:text=AppLeaveHandler), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/types.ts#:~:text=AppLeaveHandler), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/types.ts#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [routes.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/routes.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=AppLeaveHandler), [use_timeline_save_prompt.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/hooks/timeline/use_timeline_save_prompt.ts#:~:text=AppLeaveHandler)+ 1 more | 8.8.0 |
| securitySolution | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/index.tsx#:~:text=onAppLeave), [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/plugin.tsx#:~:text=onAppLeave) | 8.8.0 |
@ -185,7 +210,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| Plugin | Deprecated API | Reference location(s) | Remove By | | Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------| | --------|-------|-----------|-----------|
| monitoring | <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [bulk_uploader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process) | 8.8.0 | | monitoring | <DocLink id="kibCorePluginApi" section="def-server.OpsMetrics.process" text="process"/> | [bulk_uploader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process), [bulk_uploader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process) | 8.8.0 |
@ -194,4 +219,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| Plugin | Deprecated API | Reference location(s) | Remove By | | Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------| | --------|-------|-----------|-----------|
| lens | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave), [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave) | 8.8.0 | | lens | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave), [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave) | 8.8.0 |
| management | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 | | lens | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave), [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave) | 8.8.0 |
| management | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 |
| management | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 |

View file

@ -18,7 +18,13 @@
"text": "DevToolsPlugin" "text": "DevToolsPlugin"
}, },
" implements ", " implements ",
"Plugin", {
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.Plugin",
"text": "Plugin"
},
"<", "<",
{ {
"pluginId": "devTools", "pluginId": "devTools",
@ -42,7 +48,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(coreSetup: ", "(coreSetup: ",
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>, { urlForwarding }: { urlForwarding: { forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }; }) => { register: (devToolArgs: ", "<object, unknown>, { urlForwarding }: { urlForwarding: { forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }; }) => { register: (devToolArgs: ",
"CreateDevToolArgs", "CreateDevToolArgs",
") => ", ") => ",
@ -61,7 +73,13 @@
"label": "coreSetup", "label": "coreSetup",
"description": [], "description": [],
"signature": [ "signature": [
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>" "<object, unknown>"
], ],
"path": "src/plugins/dev_tools/public/plugin.ts", "path": "src/plugins/dev_tools/public/plugin.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/devTools
title: "devTools" title: "devTools"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the devTools plugin description: API docs for the devTools plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
--- ---
import devToolsObj from './dev_tools.devdocs.json'; import devToolsObj from './dev_tools.devdocs.json';

View file

@ -141,7 +141,7 @@
"section": "def-public.SavedSearch", "section": "def-public.SavedSearch",
"text": "SavedSearch" "text": "SavedSearch"
}, },
") => Promise<string>" ") => Promise<any>"
], ],
"path": "src/plugins/saved_search/public/services/saved_searches/saved_searches_utils.ts", "path": "src/plugins/saved_search/public/services/saved_searches/saved_searches_utils.ts",
"deprecated": false, "deprecated": false,
@ -256,7 +256,13 @@
"text": "DiscoverAppLocatorParams" "text": "DiscoverAppLocatorParams"
}, },
" extends ", " extends ",
"SerializableRecord" {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
}
], ],
"path": "src/plugins/discover/public/locator.ts", "path": "src/plugins/discover/public/locator.ts",
"deprecated": false, "deprecated": false,
@ -389,7 +395,13 @@
"\nOptionally set the time range in the time picker." "\nOptionally set the time range in the time picker."
], ],
"signature": [ "signature": [
"TimeRange", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined" " | undefined"
], ],
"path": "src/plugins/discover/public/locator.ts", "path": "src/plugins/discover/public/locator.ts",
@ -415,7 +427,13 @@
"text": "RefreshInterval" "text": "RefreshInterval"
}, },
" & ", " & ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
") | undefined" ") | undefined"
], ],
"path": "src/plugins/discover/public/locator.ts", "path": "src/plugins/discover/public/locator.ts",
@ -432,7 +450,13 @@
"\nOptionally apply filters." "\nOptionally apply filters."
], ],
"signature": [ "signature": [
"Filter", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined" "[] | undefined"
], ],
"path": "src/plugins/discover/public/locator.ts", "path": "src/plugins/discover/public/locator.ts",
@ -449,9 +473,21 @@
"\nOptionally set a query." "\nOptionally set a query."
], ],
"signature": [ "signature": [
"Query", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ", " | ",
"AggregateQuery", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined" " | undefined"
], ],
"path": "src/plugins/discover/public/locator.ts", "path": "src/plugins/discover/public/locator.ts",
@ -957,7 +993,13 @@
"text": "SerializedSearchSourceFields" "text": "SerializedSearchSourceFields"
}, },
"; serialize: () => { searchSourceJSON: string; references: ", "; serialize: () => { searchSourceJSON: string; references: ",
"SavedObjectReference", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[]; }; toExpressionAst: ({ asDatatable }?: ExpressionAstOptions) => ", "[]; }; toExpressionAst: ({ asDatatable }?: ExpressionAstOptions) => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -1307,7 +1349,13 @@
"label": "query", "label": "query",
"description": [], "description": [],
"signature": [ "signature": [
"Query", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined" " | undefined"
], ],
"path": "src/plugins/discover/public/embeddable/types.ts", "path": "src/plugins/discover/public/embeddable/types.ts",
@ -1322,7 +1370,13 @@
"label": "filters", "label": "filters",
"description": [], "description": [],
"signature": [ "signature": [
"Filter", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined" "[] | undefined"
], ],
"path": "src/plugins/discover/public/embeddable/types.ts", "path": "src/plugins/discover/public/embeddable/types.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover
title: "discover" title: "discover"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the discover plugin description: API docs for the discover plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
--- ---
import discoverObj from './discover.devdocs.json'; import discoverObj from './discover.devdocs.json';

View file

@ -18,7 +18,13 @@
"text": "DiscoverEnhancedPlugin" "text": "DiscoverEnhancedPlugin"
}, },
" implements ", " implements ",
"Plugin", {
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.Plugin",
"text": "Plugin"
},
"<void, void, ", "<void, void, ",
{ {
"pluginId": "discoverEnhanced", "pluginId": "discoverEnhanced",
@ -83,7 +89,13 @@
"label": "context", "label": "context",
"description": [], "description": [],
"signature": [ "signature": [
"PluginInitializerContext", {
"pluginId": "@kbn/core-plugins-browser",
"scope": "common",
"docId": "kibKbnCorePluginsBrowserPluginApi",
"section": "def-common.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<object>" "<object>"
], ],
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts", "path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
@ -103,7 +115,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(core: ", "(core: ",
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<", "<",
{ {
"pluginId": "discoverEnhanced", "pluginId": "discoverEnhanced",
@ -134,7 +152,13 @@
"label": "core", "label": "core",
"description": [], "description": [],
"signature": [ "signature": [
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<", "<",
{ {
"pluginId": "discoverEnhanced", "pluginId": "discoverEnhanced",
@ -183,7 +207,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(core: ", "(core: ",
"CoreStart", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
},
", plugins: ", ", plugins: ",
{ {
"pluginId": "discoverEnhanced", "pluginId": "discoverEnhanced",
@ -206,7 +236,13 @@
"label": "core", "label": "core",
"description": [], "description": [],
"signature": [ "signature": [
"CoreStart" {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreStart",
"text": "CoreStart"
}
], ],
"path": "x-pack/plugins/discover_enhanced/public/plugin.ts", "path": "x-pack/plugins/discover_enhanced/public/plugin.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced
title: "discoverEnhanced" title: "discoverEnhanced"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the discoverEnhanced plugin description: API docs for the discoverEnhanced plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
--- ---
import discoverEnhancedObj from './discover_enhanced.devdocs.json'; import discoverEnhancedObj from './discover_enhanced.devdocs.json';

View file

@ -215,7 +215,13 @@
"label": "overlays", "label": "overlays",
"description": [], "description": [],
"signature": [ "signature": [
"OverlayStart" {
"pluginId": "@kbn/core-overlays-browser",
"scope": "common",
"docId": "kibKbnCoreOverlaysBrowserPluginApi",
"section": "def-common.OverlayStart",
"text": "OverlayStart"
}
], ],
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
"deprecated": false, "deprecated": false,
@ -230,7 +236,13 @@
"label": "notifications", "label": "notifications",
"description": [], "description": [],
"signature": [ "signature": [
"NotificationsStart" {
"pluginId": "@kbn/core-notifications-browser",
"scope": "common",
"docId": "kibKbnCoreNotificationsBrowserPluginApi",
"section": "def-common.NotificationsStart",
"text": "NotificationsStart"
}
], ],
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
"deprecated": false, "deprecated": false,
@ -260,7 +272,13 @@
"label": "theme", "label": "theme",
"description": [], "description": [],
"signature": [ "signature": [
"ThemeServiceStart" {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.ThemeServiceStart",
"text": "ThemeServiceStart"
}
], ],
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
"deprecated": false, "deprecated": false,
@ -293,7 +311,7 @@
"label": "getDisplayName", "label": "getDisplayName",
"description": [], "description": [],
"signature": [ "signature": [
"() => string" "() => any"
], ],
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts", "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts",
"deprecated": false, "deprecated": false,
@ -502,7 +520,13 @@
"label": "toasts", "label": "toasts",
"description": [], "description": [],
"signature": [ "signature": [
"IToasts" {
"pluginId": "@kbn/core-notifications-browser",
"scope": "common",
"docId": "kibKbnCoreNotificationsBrowserPluginApi",
"section": "def-common.IToasts",
"text": "IToasts"
}
], ],
"path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx", "path": "src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx",
"deprecated": false, "deprecated": false,
@ -2096,7 +2120,13 @@
"label": "application", "label": "application",
"description": [], "description": [],
"signature": [ "signature": [
"ApplicationStart" {
"pluginId": "@kbn/core-application-browser",
"scope": "common",
"docId": "kibKbnCoreApplicationBrowserPluginApi",
"section": "def-common.ApplicationStart",
"text": "ApplicationStart"
}
], ],
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
"deprecated": false, "deprecated": false,
@ -2151,7 +2181,7 @@
"label": "getDisplayName", "label": "getDisplayName",
"description": [], "description": [],
"signature": [ "signature": [
"({ embeddable }: ActionContext) => string" "({ embeddable }: ActionContext) => any"
], ],
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts", "path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
"deprecated": false, "deprecated": false,
@ -3805,7 +3835,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(appId: string, options?: ", "(appId: string, options?: ",
"NavigateToAppOptions", {
"pluginId": "@kbn/core-application-browser",
"scope": "common",
"docId": "kibKbnCoreApplicationBrowserPluginApi",
"section": "def-common.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
" | undefined) => Promise<void>" " | undefined) => Promise<void>"
], ],
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
@ -3838,7 +3874,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"ReadonlyMap<string, ", "ReadonlyMap<string, ",
"PublicAppInfo", {
"pluginId": "@kbn/core-application-browser",
"scope": "common",
"docId": "kibKbnCoreApplicationBrowserPluginApi",
"section": "def-common.PublicAppInfo",
"text": "PublicAppInfo"
},
"> | undefined" "> | undefined"
], ],
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts", "path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
@ -4583,7 +4625,13 @@
"text": "IEmbeddable" "text": "IEmbeddable"
}, },
"<I, O, any>, T = ", "<I, O, any>, T = ",
"SavedObjectAttributes", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectAttributes",
"text": "SavedObjectAttributes"
},
">(def: ", ">(def: ",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
@ -5630,13 +5678,37 @@
"text": "EmbeddableOutput" "text": "EmbeddableOutput"
}, },
", any>, unknown>>; overlays: ", ", any>, unknown>>; overlays: ",
"OverlayStart", {
"pluginId": "@kbn/core-overlays-browser",
"scope": "common",
"docId": "kibKbnCoreOverlaysBrowserPluginApi",
"section": "def-common.OverlayStart",
"text": "OverlayStart"
},
"; notifications: ", "; notifications: ",
"NotificationsStart", {
"pluginId": "@kbn/core-notifications-browser",
"scope": "common",
"docId": "kibKbnCoreNotificationsBrowserPluginApi",
"section": "def-common.NotificationsStart",
"text": "NotificationsStart"
},
"; SavedObjectFinder: React.ComponentType<any>; showCreateNewMenu?: boolean | undefined; reportUiCounter?: ((appName: string, type: string, eventNames: string | string[], count?: number | undefined) => void) | undefined; theme: ", "; SavedObjectFinder: React.ComponentType<any>; showCreateNewMenu?: boolean | undefined; reportUiCounter?: ((appName: string, type: string, eventNames: string | string[], count?: number | undefined) => void) | undefined; theme: ",
"ThemeServiceStart", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.ThemeServiceStart",
"text": "ThemeServiceStart"
},
"; }) => ", "; }) => ",
"OverlayRef" {
"pluginId": "@kbn/core-mount-utils-browser",
"scope": "common",
"docId": "kibKbnCoreMountUtilsBrowserPluginApi",
"section": "def-common.OverlayRef",
"text": "OverlayRef"
}
], ],
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
"deprecated": false, "deprecated": false,
@ -5846,7 +5918,13 @@
"label": "overlays", "label": "overlays",
"description": [], "description": [],
"signature": [ "signature": [
"OverlayStart" {
"pluginId": "@kbn/core-overlays-browser",
"scope": "common",
"docId": "kibKbnCoreOverlaysBrowserPluginApi",
"section": "def-common.OverlayStart",
"text": "OverlayStart"
}
], ],
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
"deprecated": false, "deprecated": false,
@ -5860,7 +5938,13 @@
"label": "notifications", "label": "notifications",
"description": [], "description": [],
"signature": [ "signature": [
"NotificationsStart" {
"pluginId": "@kbn/core-notifications-browser",
"scope": "common",
"docId": "kibKbnCoreNotificationsBrowserPluginApi",
"section": "def-common.NotificationsStart",
"text": "NotificationsStart"
}
], ],
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
"deprecated": false, "deprecated": false,
@ -5916,7 +6000,13 @@
"label": "theme", "label": "theme",
"description": [], "description": [],
"signature": [ "signature": [
"ThemeServiceStart" {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.ThemeServiceStart",
"text": "ThemeServiceStart"
}
], ],
"path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx", "path": "src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx",
"deprecated": false, "deprecated": false,
@ -7739,7 +7829,13 @@
], ],
"signature": [ "signature": [
"() => Promise<", "() => Promise<",
"Filter", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[]>" "[]>"
], ],
"path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts", "path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts",
@ -7759,9 +7855,21 @@
], ],
"signature": [ "signature": [
"() => Promise<", "() => Promise<",
"Query", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ", " | ",
"AggregateQuery", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined>" " | undefined>"
], ],
"path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts", "path": "src/plugins/embeddable/public/lib/filterable_embeddable/types.ts",
@ -9719,9 +9827,21 @@
"text": "ViewMode" "text": "ViewMode"
}, },
" | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ", " | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
" | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; syncCursor?: boolean | undefined; syncTooltips?: boolean | undefined; executionContext?: ", " | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; syncCursor?: boolean | undefined; syncTooltips?: boolean | undefined; executionContext?: ",
"KibanaExecutionContext", {
"pluginId": "@kbn/core-execution-context-common",
"scope": "common",
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
"section": "def-common.KibanaExecutionContext",
"text": "KibanaExecutionContext"
},
" | undefined; }" " | undefined; }"
], ],
"path": "src/plugins/embeddable/common/types.ts", "path": "src/plugins/embeddable/common/types.ts",
@ -9926,10 +10046,13 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.contextMenuTrigger.title", "id": "def-public.contextMenuTrigger.title",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -9937,10 +10060,13 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.contextMenuTrigger.description", "id": "def-public.contextMenuTrigger.description",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "description", "label": "description",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -9973,10 +10099,13 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.panelBadgeTrigger.title", "id": "def-public.panelBadgeTrigger.title",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -9984,10 +10113,13 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.panelBadgeTrigger.description", "id": "def-public.panelBadgeTrigger.description",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "description", "label": "description",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -10020,10 +10152,13 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.panelNotificationTrigger.title", "id": "def-public.panelNotificationTrigger.title",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "title", "label": "title",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -10031,10 +10166,13 @@
{ {
"parentPluginId": "embeddable", "parentPluginId": "embeddable",
"id": "def-public.panelNotificationTrigger.description", "id": "def-public.panelNotificationTrigger.description",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "description", "label": "description",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts", "path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -10173,7 +10311,13 @@
"text": "EnhancementRegistryDefinition" "text": "EnhancementRegistryDefinition"
}, },
"<", "<",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">) => void" ">) => void"
], ],
"path": "src/plugins/embeddable/public/plugin.tsx", "path": "src/plugins/embeddable/public/plugin.tsx",
@ -10196,7 +10340,13 @@
"text": "EnhancementRegistryDefinition" "text": "EnhancementRegistryDefinition"
}, },
"<", "<",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">" ">"
], ],
"path": "src/plugins/embeddable/public/plugin.tsx", "path": "src/plugins/embeddable/public/plugin.tsx",
@ -10871,7 +11021,13 @@
"text": "EnhancementRegistryDefinition" "text": "EnhancementRegistryDefinition"
}, },
"<", "<",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">) => void" ">) => void"
], ],
"path": "src/plugins/embeddable/server/plugin.ts", "path": "src/plugins/embeddable/server/plugin.ts",
@ -10894,7 +11050,13 @@
"text": "EnhancementRegistryDefinition" "text": "EnhancementRegistryDefinition"
}, },
"<", "<",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">" ">"
], ],
"path": "src/plugins/embeddable/server/plugin.ts", "path": "src/plugins/embeddable/server/plugin.ts",
@ -11060,7 +11222,13 @@
"text": "PersistableState" "text": "PersistableState"
}, },
"<", "<",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
"> & { isContainerType: boolean; }" "> & { isContainerType: boolean; }"
], ],
"path": "src/plugins/embeddable/common/types.ts", "path": "src/plugins/embeddable/common/types.ts",
@ -11102,7 +11270,13 @@
"text": "PersistableState" "text": "PersistableState"
}, },
"<", "<",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">" ">"
], ],
"path": "src/plugins/embeddable/common/types.ts", "path": "src/plugins/embeddable/common/types.ts",
@ -11297,9 +11471,21 @@
"text": "ViewMode" "text": "ViewMode"
}, },
" | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ", " | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
" | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; syncCursor?: boolean | undefined; syncTooltips?: boolean | undefined; executionContext?: ", " | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; syncCursor?: boolean | undefined; syncTooltips?: boolean | undefined; executionContext?: ",
"KibanaExecutionContext", {
"pluginId": "@kbn/core-execution-context-common",
"scope": "common",
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
"section": "def-common.KibanaExecutionContext",
"text": "KibanaExecutionContext"
},
" | undefined; }" " | undefined; }"
], ],
"path": "src/plugins/embeddable/common/types.ts", "path": "src/plugins/embeddable/common/types.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable
title: "embeddable" title: "embeddable"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddable plugin description: API docs for the embeddable plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
--- ---
import embeddableObj from './embeddable.devdocs.json'; import embeddableObj from './embeddable.devdocs.json';
@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 510 | 0 | 410 | 4 | | 510 | 6 | 410 | 4 |
## Client ## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced
title: "embeddableEnhanced" title: "embeddableEnhanced"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddableEnhanced plugin description: API docs for the embeddableEnhanced plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
--- ---
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json'; import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';

View file

@ -207,11 +207,29 @@
"description": [], "description": [],
"signature": [ "signature": [
"(encryptedDoc: ", "(encryptedDoc: ",
"SavedObjectUnsanitizedDoc", {
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes> | ", "<InputAttributes> | ",
"SavedObjectUnsanitizedDoc", {
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<MigratedAttributes>) => encryptedDoc is ", "<MigratedAttributes>) => encryptedDoc is ",
"SavedObjectUnsanitizedDoc", {
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes>" "<InputAttributes>"
], ],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts", "path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
@ -227,9 +245,21 @@
"label": "encryptedDoc", "label": "encryptedDoc",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectUnsanitizedDoc", {
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes> | ", "<InputAttributes> | ",
"SavedObjectUnsanitizedDoc", {
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<MigratedAttributes>" "<MigratedAttributes>"
], ],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts", "path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
@ -247,11 +277,29 @@
"description": [], "description": [],
"signature": [ "signature": [
"(doc: ", "(doc: ",
"SavedObjectUnsanitizedDoc", {
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes>, context: ", "<InputAttributes>, context: ",
"SavedObjectMigrationContext", {
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectMigrationContext",
"text": "SavedObjectMigrationContext"
},
") => ", ") => ",
"SavedObjectUnsanitizedDoc", {
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<MigratedAttributes>" "<MigratedAttributes>"
], ],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts", "path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
@ -267,12 +315,17 @@
"label": "doc", "label": "doc",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectDoc", "SavedObjectDoc<InputAttributes> & { references?: ",
"<InputAttributes> & { references?: ", {
"SavedObjectReference", "pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObjectReference",
"text": "SavedObjectReference"
},
"[] | undefined; }" "[] | undefined; }"
], ],
"path": "node_modules/@types/kbn__core-saved-objects-server/index.d.ts", "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
}, },
@ -284,9 +337,15 @@
"label": "context", "label": "context",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectMigrationContext" {
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectMigrationContext",
"text": "SavedObjectMigrationContext"
}
], ],
"path": "node_modules/@types/kbn__core-saved-objects-server/index.d.ts", "path": "packages/core/saved-objects/core-saved-objects-server/src/migration.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
} }
@ -371,9 +430,21 @@
"description": [], "description": [],
"signature": [ "signature": [
"<T = unknown>(type: string, id: string, options?: ", "<T = unknown>(type: string, id: string, options?: ",
"SavedObjectsBaseOptions", {
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<", " | undefined) => Promise<",
"SavedObject", {
"pluginId": "@kbn/core-saved-objects-common",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsCommonPluginApi",
"section": "def-common.SavedObject",
"text": "SavedObject"
},
"<T>>" "<T>>"
], ],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
@ -418,7 +489,13 @@
"label": "options", "label": "options",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectsBaseOptions", {
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined" " | undefined"
], ],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
@ -440,11 +517,29 @@
], ],
"signature": [ "signature": [
"<T = unknown, A = unknown>(findOptions: ", "<T = unknown, A = unknown>(findOptions: ",
"SavedObjectsCreatePointInTimeFinderOptions", {
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderOptions",
"text": "SavedObjectsCreatePointInTimeFinderOptions"
},
", dependencies?: ", ", dependencies?: ",
"SavedObjectsCreatePointInTimeFinderDependencies", {
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined) => Promise<", " | undefined) => Promise<",
"ISavedObjectsPointInTimeFinder", {
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.ISavedObjectsPointInTimeFinder",
"text": "ISavedObjectsPointInTimeFinder"
},
"<T, A>>" "<T, A>>"
], ],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
@ -461,7 +556,13 @@
"matches interface of corresponding argument of Saved Objects API `createPointInTimeFinder` {@link SavedObjectsCreatePointInTimeFinderOptions }" "matches interface of corresponding argument of Saved Objects API `createPointInTimeFinder` {@link SavedObjectsCreatePointInTimeFinderOptions }"
], ],
"signature": [ "signature": [
"SavedObjectsCreatePointInTimeFinderOptions" {
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderOptions",
"text": "SavedObjectsCreatePointInTimeFinderOptions"
}
], ],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
"deprecated": false, "deprecated": false,
@ -478,7 +579,13 @@
"matches interface of corresponding argument of Saved Objects API `createPointInTimeFinder` {@link SavedObjectsCreatePointInTimeFinderDependencies }" "matches interface of corresponding argument of Saved Objects API `createPointInTimeFinder` {@link SavedObjectsCreatePointInTimeFinderDependencies }"
], ],
"signature": [ "signature": [
"SavedObjectsCreatePointInTimeFinderDependencies", {
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined" " | undefined"
], ],
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
@ -711,11 +818,29 @@
"description": [], "description": [],
"signature": [ "signature": [
"(encryptedDoc: ", "(encryptedDoc: ",
"SavedObjectUnsanitizedDoc", {
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes> | ", "<InputAttributes> | ",
"SavedObjectUnsanitizedDoc", {
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<MigratedAttributes>) => encryptedDoc is ", "<MigratedAttributes>) => encryptedDoc is ",
"SavedObjectUnsanitizedDoc", {
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes>" "<InputAttributes>"
], ],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts", "path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
@ -731,9 +856,21 @@
"label": "encryptedDoc", "label": "encryptedDoc",
"description": [], "description": [],
"signature": [ "signature": [
"SavedObjectUnsanitizedDoc", {
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<InputAttributes> | ", "<InputAttributes> | ",
"SavedObjectUnsanitizedDoc", {
"pluginId": "@kbn/core-saved-objects-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsServerPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<MigratedAttributes>" "<MigratedAttributes>"
], ],
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts", "path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects
title: "encryptedSavedObjects" title: "encryptedSavedObjects"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the encryptedSavedObjects plugin description: API docs for the encryptedSavedObjects plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
--- ---
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json'; import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';
@ -21,7 +21,7 @@ Contact [Platform Security](https://github.com/orgs/elastic/teams/kibana-securit
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 51 | 0 | 42 | 0 | | 51 | 0 | 44 | 0 |
## Server ## Server

View file

@ -144,21 +144,69 @@
"label": "configSchema", "label": "configSchema",
"description": [], "description": [],
"signature": [ "signature": [
"ObjectType", {
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ObjectType",
"text": "ObjectType"
},
"<{ accessCheckTimeout: ", "<{ accessCheckTimeout: ",
"Type", {
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<number>; accessCheckTimeoutWarning: ", "<number>; accessCheckTimeoutWarning: ",
"Type", {
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<number>; customHeaders: ", "<number>; customHeaders: ",
"Type", {
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<Readonly<{} & {}> | undefined>; host: ", "<Readonly<{} & {}> | undefined>; host: ",
"Type", {
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<string | undefined>; ssl: ", "<string | undefined>; ssl: ",
"ObjectType", {
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.ObjectType",
"text": "ObjectType"
},
"<{ certificateAuthorities: ", "<{ certificateAuthorities: ",
"Type", {
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<string | string[] | undefined>; verificationMode: ", "<string | string[] | undefined>; verificationMode: ",
"Type", {
"pluginId": "@kbn/config-schema",
"scope": "server",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-server.Type",
"text": "Type"
},
"<\"none\" | \"full\" | \"certificate\">; }>; }>" "<\"none\" | \"full\" | \"certificate\">; }>; }>"
], ],
"path": "x-pack/plugins/enterprise_search/server/index.ts", "path": "x-pack/plugins/enterprise_search/server/index.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch
title: "enterpriseSearch" title: "enterpriseSearch"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the enterpriseSearch plugin description: API docs for the enterpriseSearch plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
--- ---
import enterpriseSearchObj from './enterprise_search.devdocs.json'; import enterpriseSearchObj from './enterprise_search.devdocs.json';

View file

@ -561,7 +561,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"<D = any, E = any>(httpClient: ", "<D = any, E = any>(httpClient: ",
"HttpSetup", {
"pluginId": "@kbn/core-http-browser",
"scope": "common",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-common.HttpSetup",
"text": "HttpSetup"
},
", { path, method, body, query, asSystemRequest }: ", ", { path, method, body, query, asSystemRequest }: ",
{ {
"pluginId": "esUiShared", "pluginId": "esUiShared",
@ -592,7 +598,13 @@
"label": "httpClient", "label": "httpClient",
"description": [], "description": [],
"signature": [ "signature": [
"HttpSetup" {
"pluginId": "@kbn/core-http-browser",
"scope": "common",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-common.HttpSetup",
"text": "HttpSetup"
}
], ],
"path": "src/plugins/es_ui_shared/public/request/send_request.ts", "path": "src/plugins/es_ui_shared/public/request/send_request.ts",
"deprecated": false, "deprecated": false,
@ -651,7 +663,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"<D = any, E = Error>(httpClient: ", "<D = any, E = Error>(httpClient: ",
"HttpSetup", {
"pluginId": "@kbn/core-http-browser",
"scope": "common",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-common.HttpSetup",
"text": "HttpSetup"
},
", { path, method, query, body, pollIntervalMs, initialData, deserializer }: ", ", { path, method, query, body, pollIntervalMs, initialData, deserializer }: ",
{ {
"pluginId": "esUiShared", "pluginId": "esUiShared",
@ -682,7 +700,13 @@
"label": "httpClient", "label": "httpClient",
"description": [], "description": [],
"signature": [ "signature": [
"HttpSetup" {
"pluginId": "@kbn/core-http-browser",
"scope": "common",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-common.HttpSetup",
"text": "HttpSetup"
}
], ],
"path": "src/plugins/es_ui_shared/public/request/use_request.ts", "path": "src/plugins/es_ui_shared/public/request/use_request.ts",
"deprecated": false, "deprecated": false,
@ -1304,7 +1328,13 @@
"label": "query", "label": "query",
"description": [], "description": [],
"signature": [ "signature": [
"HttpFetchQuery", {
"pluginId": "@kbn/core-http-browser",
"scope": "common",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-common.HttpFetchQuery",
"text": "HttpFetchQuery"
},
" | undefined" " | undefined"
], ],
"path": "src/plugins/es_ui_shared/public/request/send_request.ts", "path": "src/plugins/es_ui_shared/public/request/send_request.ts",
@ -1794,7 +1824,13 @@
], ],
"signature": [ "signature": [
"({ error, response, handleCustomError, }: EsErrorHandlerParams) => ", "({ error, response, handleCustomError, }: EsErrorHandlerParams) => ",
"IKibanaResponse", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.IKibanaResponse",
"text": "IKibanaResponse"
},
"<any>" "<any>"
], ],
"path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts", "path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esUiShared
title: "esUiShared" title: "esUiShared"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the esUiShared plugin description: API docs for the esUiShared plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
--- ---
import esUiSharedObj from './es_ui_shared.devdocs.json'; import esUiSharedObj from './es_ui_shared.devdocs.json';

View file

@ -443,7 +443,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/event_annotation/common/event_annotation_group/index.ts", "path": "src/plugins/event_annotation/common/event_annotation_group/index.ts",
@ -1028,10 +1034,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.help", "id": "def-common.manualPointEventAnnotation.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1103,10 +1112,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.id.help", "id": "def-common.manualPointEventAnnotation.args.id.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1141,10 +1153,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.time.help", "id": "def-common.manualPointEventAnnotation.args.time.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1179,10 +1194,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.label.help", "id": "def-common.manualPointEventAnnotation.args.label.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1217,10 +1235,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.color.help", "id": "def-common.manualPointEventAnnotation.args.color.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1269,10 +1290,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.lineStyle.help", "id": "def-common.manualPointEventAnnotation.args.lineStyle.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1307,10 +1331,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.lineWidth.help", "id": "def-common.manualPointEventAnnotation.args.lineWidth.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1345,10 +1372,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.icon.help", "id": "def-common.manualPointEventAnnotation.args.icon.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1411,10 +1441,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.textVisibility.help", "id": "def-common.manualPointEventAnnotation.args.textVisibility.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1449,10 +1482,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualPointEventAnnotation.args.isHidden.help", "id": "def-common.manualPointEventAnnotation.args.isHidden.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1593,10 +1629,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.help", "id": "def-common.manualRangeEventAnnotation.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1668,10 +1707,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.id.help", "id": "def-common.manualRangeEventAnnotation.args.id.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1706,10 +1748,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.time.help", "id": "def-common.manualRangeEventAnnotation.args.time.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1744,10 +1789,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.endTime.help", "id": "def-common.manualRangeEventAnnotation.args.endTime.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1848,10 +1896,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.label.help", "id": "def-common.manualRangeEventAnnotation.args.label.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1886,10 +1937,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.color.help", "id": "def-common.manualRangeEventAnnotation.args.color.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1924,10 +1978,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.manualRangeEventAnnotation.args.isHidden.help", "id": "def-common.manualRangeEventAnnotation.args.isHidden.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2048,10 +2105,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.help", "id": "def-common.queryPointEventAnnotation.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2123,10 +2183,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.id.help", "id": "def-common.queryPointEventAnnotation.args.id.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2161,10 +2224,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.filter.help", "id": "def-common.queryPointEventAnnotation.args.filter.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2213,10 +2279,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.extraFields.help", "id": "def-common.queryPointEventAnnotation.args.extraFields.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2251,10 +2320,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.timeField.help", "id": "def-common.queryPointEventAnnotation.args.timeField.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2289,10 +2361,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.label.help", "id": "def-common.queryPointEventAnnotation.args.label.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2327,10 +2402,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.color.help", "id": "def-common.queryPointEventAnnotation.args.color.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2379,10 +2457,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.lineStyle.help", "id": "def-common.queryPointEventAnnotation.args.lineStyle.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2417,10 +2498,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.lineWidth.help", "id": "def-common.queryPointEventAnnotation.args.lineWidth.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2455,10 +2539,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.icon.help", "id": "def-common.queryPointEventAnnotation.args.icon.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2521,10 +2608,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.textVisibility.help", "id": "def-common.queryPointEventAnnotation.args.textVisibility.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2559,10 +2649,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.textField.help", "id": "def-common.queryPointEventAnnotation.args.textField.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2597,10 +2690,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.isHidden.help", "id": "def-common.queryPointEventAnnotation.args.isHidden.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -2635,10 +2731,13 @@
{ {
"parentPluginId": "eventAnnotation", "parentPluginId": "eventAnnotation",
"id": "def-common.queryPointEventAnnotation.args.ignoreGlobalFilters.help", "id": "def-common.queryPointEventAnnotation.args.ignoreGlobalFilters.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation
title: "eventAnnotation" title: "eventAnnotation"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the eventAnnotation plugin description: API docs for the eventAnnotation plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
--- ---
import eventAnnotationObj from './event_annotation.devdocs.json'; import eventAnnotationObj from './event_annotation.devdocs.json';
@ -21,7 +21,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 174 | 0 | 174 | 3 | | 174 | 31 | 174 | 3 |
## Client ## Client

View file

@ -1059,7 +1059,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(type: string, authFilter: ", "(type: string, authFilter: ",
"KueryNode", {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
},
", options?: Partial<", ", options?: Partial<",
"AggregateOptionsType", "AggregateOptionsType",
"> | undefined) => Promise<", "> | undefined) => Promise<",
@ -1099,7 +1105,13 @@
"label": "authFilter", "label": "authFilter",
"description": [], "description": [],
"signature": [ "signature": [
"KueryNode" {
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.KueryNode",
"text": "KueryNode"
}
], ],
"path": "x-pack/plugins/event_log/server/types.ts", "path": "x-pack/plugins/event_log/server/types.ts",
"deprecated": false, "deprecated": false,
@ -1312,7 +1324,7 @@
"label": "data", "label": "data",
"description": [], "description": [],
"signature": [ "signature": [
"(Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; uuid?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; uuid?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: 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?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]" "(Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; uuid?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; uuid?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; reason?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]"
], ],
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"deprecated": false, "deprecated": false,
@ -1332,7 +1344,7 @@
"label": "IEvent", "label": "IEvent",
"description": [], "description": [],
"signature": [ "signature": [
"DeepPartial<DeepWriteable<Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; uuid?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; uuid?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: 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?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined" "DeepPartial<DeepWriteable<Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; uuid?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; uuid?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; reason?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined"
], ],
"path": "x-pack/plugins/event_log/generated/schemas.ts", "path": "x-pack/plugins/event_log/generated/schemas.ts",
"deprecated": false, "deprecated": false,
@ -1347,7 +1359,7 @@
"label": "IValidatedEvent", "label": "IValidatedEvent",
"description": [], "description": [],
"signature": [ "signature": [
"Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; uuid?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; uuid?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: 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?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined" "Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; uuid?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; uuid?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; reason?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined"
], ],
"path": "x-pack/plugins/event_log/generated/schemas.ts", "path": "x-pack/plugins/event_log/generated/schemas.ts",
"deprecated": false, "deprecated": false,
@ -1670,7 +1682,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(request: ", "(request: ",
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>) => ", "<unknown, unknown, unknown, any>) => ",
{ {
"pluginId": "eventLog", "pluginId": "eventLog",
@ -1692,7 +1710,13 @@
"label": "request", "label": "request",
"description": [], "description": [],
"signature": [ "signature": [
"KibanaRequest", {
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>" "<unknown, unknown, unknown, any>"
], ],
"path": "x-pack/plugins/event_log/server/types.ts", "path": "x-pack/plugins/event_log/server/types.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventLog
title: "eventLog" title: "eventLog"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the eventLog plugin description: API docs for the eventLog plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
--- ---
import eventLogObj from './event_log.devdocs.json'; import eventLogObj from './event_log.devdocs.json';

View file

@ -12,7 +12,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(core: ", "(core: ",
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>) => () => ", "<object, unknown>) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -35,7 +41,13 @@
"label": "core", "label": "core",
"description": [], "description": [],
"signature": [ "signature": [
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>" "<object, unknown>"
], ],
"path": "src/plugins/expression_error/public/expression_renderers/debug_renderer.tsx", "path": "src/plugins/expression_error/public/expression_renderers/debug_renderer.tsx",
@ -56,7 +68,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(core: ", "(core: ",
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>) => () => ", "<object, unknown>) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -81,7 +99,13 @@
"label": "core", "label": "core",
"description": [], "description": [],
"signature": [ "signature": [
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>" "<object, unknown>"
], ],
"path": "src/plugins/expression_error/public/expression_renderers/error_renderer.tsx", "path": "src/plugins/expression_error/public/expression_renderers/error_renderer.tsx",
@ -104,7 +128,13 @@
"(theme$?: ", "(theme$?: ",
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">) => () => ", ">) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -129,7 +159,13 @@
"signature": [ "signature": [
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">" ">"
], ],
"path": "src/plugins/expression_error/public/expression_renderers/debug_renderer.tsx", "path": "src/plugins/expression_error/public/expression_renderers/debug_renderer.tsx",
@ -152,7 +188,13 @@
"(theme$?: ", "(theme$?: ",
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">) => () => ", ">) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -179,7 +221,13 @@
"signature": [ "signature": [
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">" ">"
], ],
"path": "src/plugins/expression_error/public/expression_renderers/error_renderer.tsx", "path": "src/plugins/expression_error/public/expression_renderers/error_renderer.tsx",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionError
title: "expressionError" title: "expressionError"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionError plugin description: API docs for the expressionError plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
--- ---
import expressionErrorObj from './expression_error.devdocs.json'; import expressionErrorObj from './expression_error.devdocs.json';

View file

@ -106,7 +106,13 @@
"text": "Accessors" "text": "Accessors"
}, },
" | undefined, paletteParams?: ", " | undefined, paletteParams?: ",
"CustomPaletteParams", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.CustomPaletteParams",
"text": "CustomPaletteParams"
},
" | undefined, isRespectRanges?: boolean | undefined) => number" " | undefined, isRespectRanges?: boolean | undefined) => number"
], ],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts", "path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
@ -165,7 +171,13 @@
"label": "paletteParams", "label": "paletteParams",
"description": [], "description": [],
"signature": [ "signature": [
"CustomPaletteParams", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.CustomPaletteParams",
"text": "CustomPaletteParams"
},
" | undefined" " | undefined"
], ],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts", "path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
@ -217,7 +229,13 @@
"text": "Accessors" "text": "Accessors"
}, },
" | undefined, paletteParams?: ", " | undefined, paletteParams?: ",
"CustomPaletteParams", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.CustomPaletteParams",
"text": "CustomPaletteParams"
},
" | undefined, isRespectRanges?: boolean | undefined) => any" " | undefined, isRespectRanges?: boolean | undefined) => any"
], ],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts", "path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
@ -276,7 +294,13 @@
"label": "paletteParams", "label": "paletteParams",
"description": [], "description": [],
"signature": [ "signature": [
"CustomPaletteParams", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.CustomPaletteParams",
"text": "CustomPaletteParams"
},
" | undefined" " | undefined"
], ],
"path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts", "path": "src/plugins/chart_expressions/expression_gauge/public/components/utils/accessors.ts",
@ -536,7 +560,13 @@
"; colorMode: ", "; colorMode: ",
"GaugeColorMode", "GaugeColorMode",
"; palette?: ", "; palette?: ",
"PaletteOutput", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<", "<",
{ {
"pluginId": "charts", "pluginId": "charts",
@ -772,9 +802,21 @@
"label": "palette", "label": "palette",
"description": [], "description": [],
"signature": [ "signature": [
"PaletteOutput", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<", "<",
"CustomPaletteParams", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.CustomPaletteParams",
"text": "CustomPaletteParams"
},
"> | undefined" "> | undefined"
], ],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
@ -883,7 +925,13 @@
"text": "SerializedFieldFormat" "text": "SerializedFieldFormat"
}, },
"<{}, ", "<{}, ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
"> | undefined) => ", "> | undefined) => ",
{ {
"pluginId": "fieldFormats", "pluginId": "fieldFormats",
@ -914,7 +962,13 @@
"text": "SerializedFieldFormat" "text": "SerializedFieldFormat"
}, },
"<{}, ", "<{}, ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
"> | undefined" "> | undefined"
], ],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts", "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_renderers.ts",
@ -950,7 +1004,13 @@
"; colorMode: ", "; colorMode: ",
"GaugeColorMode", "GaugeColorMode",
"; palette?: ", "; palette?: ",
"PaletteOutput", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<", "<",
{ {
"pluginId": "charts", "pluginId": "charts",
@ -1030,7 +1090,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
@ -1079,7 +1145,13 @@
"; chartsThemeService: ", "; chartsThemeService: ",
"Theme", "Theme",
"; paletteService: ", "; paletteService: ",
"PaletteRegistry", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteRegistry",
"text": "PaletteRegistry"
},
"; renderComplete: () => void; uiState: ", "; renderComplete: () => void; uiState: ",
{ {
"pluginId": "visualizations", "pluginId": "visualizations",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionGauge
title: "expressionGauge" title: "expressionGauge"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionGauge plugin description: API docs for the expressionGauge plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
--- ---
import expressionGaugeObj from './expression_gauge.devdocs.json'; import expressionGaugeObj from './expression_gauge.devdocs.json';

View file

@ -214,7 +214,13 @@
"label": "palette", "label": "palette",
"description": [], "description": [],
"signature": [ "signature": [
"PaletteOutput", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<", "<",
{ {
"pluginId": "charts", "pluginId": "charts",
@ -511,7 +517,13 @@
"text": "SerializedFieldFormat" "text": "SerializedFieldFormat"
}, },
"<{}, ", "<{}, ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
"> | undefined) => ", "> | undefined) => ",
{ {
"pluginId": "fieldFormats", "pluginId": "fieldFormats",
@ -542,7 +554,13 @@
"text": "SerializedFieldFormat" "text": "SerializedFieldFormat"
}, },
"<{}, ", "<{}, ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
"> | undefined" "> | undefined"
], ],
"path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/types/expression_renderers.ts",
@ -636,7 +654,13 @@
"text": "Datatable" "text": "Datatable"
}, },
"; column: number; range: number[]; timeFieldName?: string | undefined; }) => void; paletteService: ", "; column: number; range: number[]; timeFieldName?: string | undefined; }) => void; paletteService: ",
"PaletteRegistry", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteRegistry",
"text": "PaletteRegistry"
},
"; uiState: ", "; uiState: ",
{ {
"pluginId": "visualizations", "pluginId": "visualizations",
@ -803,10 +827,13 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.strokeWidth.help", "id": "def-common.heatmapGridConfig.args.strokeWidth.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -855,10 +882,13 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.strokeColor.help", "id": "def-common.heatmapGridConfig.args.strokeColor.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -909,10 +939,13 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.isCellLabelVisible.help", "id": "def-common.heatmapGridConfig.args.isCellLabelVisible.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -949,10 +982,13 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.isYAxisLabelVisible.help", "id": "def-common.heatmapGridConfig.args.isYAxisLabelVisible.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -987,10 +1023,13 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.isYAxisTitleVisible.help", "id": "def-common.heatmapGridConfig.args.isYAxisTitleVisible.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1025,10 +1064,13 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.yTitle.help", "id": "def-common.heatmapGridConfig.args.yTitle.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1079,10 +1121,13 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.isXAxisLabelVisible.help", "id": "def-common.heatmapGridConfig.args.isXAxisLabelVisible.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1117,10 +1162,13 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.isXAxisTitleVisible.help", "id": "def-common.heatmapGridConfig.args.isXAxisTitleVisible.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1155,10 +1203,13 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapGridConfig.args.xTitle.help", "id": "def-common.heatmapGridConfig.args.xTitle.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_grid.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1350,10 +1401,13 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapLegendConfig.args.isVisible.help", "id": "def-common.heatmapLegendConfig.args.isVisible.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1416,10 +1470,13 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapLegendConfig.args.position.help", "id": "def-common.heatmapLegendConfig.args.position.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1468,10 +1525,13 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapLegendConfig.args.maxLines.help", "id": "def-common.heatmapLegendConfig.args.maxLines.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1520,10 +1580,13 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapLegendConfig.args.shouldTruncate.help", "id": "def-common.heatmapLegendConfig.args.shouldTruncate.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false
@ -1578,10 +1641,13 @@
{ {
"parentPluginId": "expressionHeatmap", "parentPluginId": "expressionHeatmap",
"id": "def-common.heatmapLegendConfig.args.legendSize.help", "id": "def-common.heatmapLegendConfig.args.legendSize.help",
"type": "string", "type": "Any",
"tags": [], "tags": [],
"label": "help", "label": "help",
"description": [], "description": [],
"signature": [
"any"
],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false "trackAdoption": false

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap
title: "expressionHeatmap" title: "expressionHeatmap"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionHeatmap plugin description: API docs for the expressionHeatmap plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
--- ---
import expressionHeatmapObj from './expression_heatmap.devdocs.json'; import expressionHeatmapObj from './expression_heatmap.devdocs.json';
@ -21,7 +21,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 108 | 0 | 104 | 3 | | 108 | 14 | 104 | 3 |
## Common ## Common

View file

@ -14,7 +14,13 @@
"(theme$?: ", "(theme$?: ",
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">) => () => ", ">) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -47,7 +53,13 @@
"signature": [ "signature": [
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">" ">"
], ],
"path": "src/plugins/expression_image/public/expression_renderers/image_renderer.tsx", "path": "src/plugins/expression_image/public/expression_renderers/image_renderer.tsx",
@ -68,7 +80,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(core: ", "(core: ",
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>) => () => ", "<object, unknown>) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -99,7 +117,13 @@
"label": "core", "label": "core",
"description": [], "description": [],
"signature": [ "signature": [
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>" "<object, unknown>"
], ],
"path": "src/plugins/expression_image/public/expression_renderers/image_renderer.tsx", "path": "src/plugins/expression_image/public/expression_renderers/image_renderer.tsx",
@ -383,7 +407,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/expression_image/common/types/expression_functions.ts", "path": "src/plugins/expression_image/common/types/expression_functions.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionImage
title: "expressionImage" title: "expressionImage"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionImage plugin description: API docs for the expressionImage plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
--- ---
import expressionImageObj from './expression_image.devdocs.json'; import expressionImageObj from './expression_image.devdocs.json';

View file

@ -158,7 +158,13 @@
"label": "palette", "label": "palette",
"description": [], "description": [],
"signature": [ "signature": [
"PaletteOutput", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<", "<",
{ {
"pluginId": "charts", "pluginId": "charts",
@ -837,7 +843,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/chart_expressions/expression_legacy_metric/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_legacy_metric/common/types/expression_functions.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis
title: "expressionLegacyMetricVis" title: "expressionLegacyMetricVis"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionLegacyMetricVis plugin description: API docs for the expressionLegacyMetricVis plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
--- ---
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json'; import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';

View file

@ -14,7 +14,13 @@
"(theme$?: ", "(theme$?: ",
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">) => () => ", ">) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -47,7 +53,13 @@
"signature": [ "signature": [
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">" ">"
], ],
"path": "src/plugins/expression_metric/public/expression_renderers/metric_renderer.tsx", "path": "src/plugins/expression_metric/public/expression_renderers/metric_renderer.tsx",
@ -68,7 +80,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(core: ", "(core: ",
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>) => () => ", "<object, unknown>) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -99,7 +117,13 @@
"label": "core", "label": "core",
"description": [], "description": [],
"signature": [ "signature": [
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>" "<object, unknown>"
], ],
"path": "src/plugins/expression_metric/public/expression_renderers/metric_renderer.tsx", "path": "src/plugins/expression_metric/public/expression_renderers/metric_renderer.tsx",
@ -168,7 +192,7 @@
"label": "metricFunction", "label": "metricFunction",
"description": [], "description": [],
"signature": [ "signature": [
"() => { name: \"metric\"; aliases: never[]; type: \"render\"; inputTypes: (\"number\" | \"null\" | \"string\")[]; help: string; args: { label: { types: \"string\"[]; aliases: string[]; help: string; default: string; }; labelFont: { types: \"style\"[]; help: string; default: string; }; metricFont: { types: \"style\"[]; help: string; default: string; }; metricFormat: { types: \"string\"[]; aliases: string[]; help: string; }; }; fn: (input: ", "() => { name: \"metric\"; aliases: never[]; type: \"render\"; inputTypes: (\"number\" | \"null\" | \"string\")[]; help: any; args: { label: { types: \"string\"[]; aliases: string[]; help: any; default: string; }; labelFont: { types: \"style\"[]; help: any; default: string; }; metricFont: { types: \"style\"[]; help: any; default: string; }; metricFormat: { types: \"string\"[]; aliases: string[]; help: any; }; }; fn: (input: ",
{ {
"pluginId": "expressionMetric", "pluginId": "expressionMetric",
"scope": "common", "scope": "common",
@ -506,7 +530,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/expression_metric/common/types/expression_functions.ts", "path": "src/plugins/expression_metric/common/types/expression_functions.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetric
title: "expressionMetric" title: "expressionMetric"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetric plugin description: API docs for the expressionMetric plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
--- ---
import expressionMetricObj from './expression_metric.devdocs.json'; import expressionMetricObj from './expression_metric.devdocs.json';

View file

@ -470,7 +470,13 @@
"label": "palette", "label": "palette",
"description": [], "description": [],
"signature": [ "signature": [
"PaletteOutput", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<", "<",
{ {
"pluginId": "charts", "pluginId": "charts",
@ -1037,7 +1043,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"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", "path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis
title: "expressionMetricVis" title: "expressionMetricVis"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetricVis plugin description: API docs for the expressionMetricVis plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
--- ---
import expressionMetricVisObj from './expression_metric_vis.devdocs.json'; import expressionMetricVisObj from './expression_metric_vis.devdocs.json';

View file

@ -141,7 +141,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/chart_expressions/expression_partition_vis/common/expression_functions/partition_labels_function.ts", "path": "src/plugins/chart_expressions/expression_partition_vis/common/expression_functions/partition_labels_function.ts",
@ -264,7 +270,13 @@
"text": "SerializedFieldFormat" "text": "SerializedFieldFormat"
}, },
"<{}, ", "<{}, ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
"> | undefined; }" "> | undefined; }"
], ],
"path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_renderers.ts", "path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_renderers.ts",
@ -641,7 +653,13 @@
"label": "palette", "label": "palette",
"description": [], "description": [],
"signature": [ "signature": [
"PaletteOutput", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<{ [key: string]: unknown; }>" "<{ [key: string]: unknown; }>"
], ],
"path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_renderers.ts", "path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_renderers.ts",
@ -1157,7 +1175,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_functions.ts",
@ -1268,7 +1292,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_functions.ts",
@ -1379,7 +1409,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_functions.ts",
@ -1460,7 +1496,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_partition_vis/common/types/expression_functions.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis
title: "expressionPartitionVis" title: "expressionPartitionVis"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionPartitionVis plugin description: API docs for the expressionPartitionVis plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
--- ---
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json'; import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';

View file

@ -14,7 +14,13 @@
"(theme$?: ", "(theme$?: ",
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">) => () => ", ">) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -47,7 +53,13 @@
"signature": [ "signature": [
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">" ">"
], ],
"path": "src/plugins/expression_repeat_image/public/expression_renderers/repeat_image_renderer.tsx", "path": "src/plugins/expression_repeat_image/public/expression_renderers/repeat_image_renderer.tsx",
@ -68,7 +80,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(core: ", "(core: ",
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>) => () => ", "<object, unknown>) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -99,7 +117,13 @@
"label": "core", "label": "core",
"description": [], "description": [],
"signature": [ "signature": [
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>" "<object, unknown>"
], ],
"path": "src/plugins/expression_repeat_image/public/expression_renderers/repeat_image_renderer.tsx", "path": "src/plugins/expression_repeat_image/public/expression_renderers/repeat_image_renderer.tsx",
@ -168,7 +192,7 @@
"label": "repeatImageFunction", "label": "repeatImageFunction",
"description": [], "description": [],
"signature": [ "signature": [
"() => { name: \"repeatImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: string; args: { emptyImage: { types: (\"null\" | \"string\")[]; help: string; default: null; }; image: { types: (\"null\" | \"string\")[]; help: string; default: null; }; max: { types: (\"number\" | \"null\")[]; help: string; default: number; }; size: { types: \"number\"[]; default: number; help: string; }; }; fn: (count: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string | null; emptyImage: string | null; size: number; max: number | null; count: number; }; }>; }" "() => { name: \"repeatImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: any; args: { emptyImage: { types: (\"null\" | \"string\")[]; help: any; default: null; }; image: { types: (\"null\" | \"string\")[]; help: any; default: null; }; max: { types: (\"number\" | \"null\")[]; help: any; default: number; }; size: { types: \"number\"[]; default: number; help: any; }; }; fn: (count: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string | null; emptyImage: string | null; size: number; max: number | null; count: number; }; }>; }"
], ],
"path": "src/plugins/expression_repeat_image/common/expression_functions/repeat_image_function.ts", "path": "src/plugins/expression_repeat_image/common/expression_functions/repeat_image_function.ts",
"deprecated": false, "deprecated": false,
@ -430,7 +454,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/expression_repeat_image/common/types/expression_functions.ts", "path": "src/plugins/expression_repeat_image/common/types/expression_functions.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage
title: "expressionRepeatImage" title: "expressionRepeatImage"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRepeatImage plugin description: API docs for the expressionRepeatImage plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
--- ---
import expressionRepeatImageObj from './expression_repeat_image.devdocs.json'; import expressionRepeatImageObj from './expression_repeat_image.devdocs.json';

View file

@ -14,7 +14,13 @@
"(theme$?: ", "(theme$?: ",
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">) => () => ", ">) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -41,7 +47,13 @@
"signature": [ "signature": [
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">" ">"
], ],
"path": "src/plugins/expression_reveal_image/public/expression_renderers/reveal_image_renderer.tsx", "path": "src/plugins/expression_reveal_image/public/expression_renderers/reveal_image_renderer.tsx",
@ -62,7 +74,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(core: ", "(core: ",
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>) => () => ", "<object, unknown>) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -87,7 +105,13 @@
"label": "core", "label": "core",
"description": [], "description": [],
"signature": [ "signature": [
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>" "<object, unknown>"
], ],
"path": "src/plugins/expression_reveal_image/public/expression_renderers/reveal_image_renderer.tsx", "path": "src/plugins/expression_reveal_image/public/expression_renderers/reveal_image_renderer.tsx",
@ -156,7 +180,7 @@
"label": "revealImageFunction", "label": "revealImageFunction",
"description": [], "description": [],
"signature": [ "signature": [
"() => { name: \"revealImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: string; args: { image: { types: (\"null\" | \"string\")[]; help: string; default: null; }; emptyImage: { types: (\"null\" | \"string\")[]; help: string; default: null; }; origin: { types: \"string\"[]; help: string; default: string; options: ", "() => { name: \"revealImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: any; args: { image: { types: (\"null\" | \"string\")[]; help: any; default: null; }; emptyImage: { types: (\"null\" | \"string\")[]; help: any; default: null; }; origin: { types: \"string\"[]; help: any; default: string; options: ",
"Origin", "Origin",
"[]; }; }; fn: (percent: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string; emptyImage: string; origin: ", "[]; }; }; fn: (percent: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string; emptyImage: string; origin: ",
"Origin", "Origin",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage
title: "expressionRevealImage" title: "expressionRevealImage"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRevealImage plugin description: API docs for the expressionRevealImage plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
--- ---
import expressionRevealImageObj from './expression_reveal_image.devdocs.json'; import expressionRevealImageObj from './expression_reveal_image.devdocs.json';

View file

@ -38,7 +38,13 @@
"(theme$?: ", "(theme$?: ",
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">) => () => ", ">) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -71,7 +77,13 @@
"signature": [ "signature": [
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">" ">"
], ],
"path": "src/plugins/expression_shape/public/expression_renderers/progress_renderer.tsx", "path": "src/plugins/expression_shape/public/expression_renderers/progress_renderer.tsx",
@ -94,7 +106,13 @@
"(theme$?: ", "(theme$?: ",
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">) => () => ", ">) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -127,7 +145,13 @@
"signature": [ "signature": [
"Observable", "Observable",
"<", "<",
"CoreTheme", {
"pluginId": "@kbn/core-theme-browser",
"scope": "common",
"docId": "kibKbnCoreThemeBrowserPluginApi",
"section": "def-common.CoreTheme",
"text": "CoreTheme"
},
">" ">"
], ],
"path": "src/plugins/expression_shape/public/expression_renderers/shape_renderer.tsx", "path": "src/plugins/expression_shape/public/expression_renderers/shape_renderer.tsx",
@ -276,7 +300,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(core: ", "(core: ",
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>) => () => ", "<object, unknown>) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -307,7 +337,13 @@
"label": "core", "label": "core",
"description": [], "description": [],
"signature": [ "signature": [
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>" "<object, unknown>"
], ],
"path": "src/plugins/expression_shape/public/expression_renderers/progress_renderer.tsx", "path": "src/plugins/expression_shape/public/expression_renderers/progress_renderer.tsx",
@ -328,7 +364,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"(core: ", "(core: ",
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>) => () => ", "<object, unknown>) => () => ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -359,7 +401,13 @@
"label": "core", "label": "core",
"description": [], "description": [],
"signature": [ "signature": [
"CoreSetup", {
"pluginId": "@kbn/core-lifecycle-browser",
"scope": "common",
"docId": "kibKbnCoreLifecycleBrowserPluginApi",
"section": "def-common.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>" "<object, unknown>"
], ],
"path": "src/plugins/expression_shape/public/expression_renderers/shape_renderer.tsx", "path": "src/plugins/expression_shape/public/expression_renderers/shape_renderer.tsx",
@ -1502,7 +1550,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/expression_shape/common/types/expression_functions.ts", "path": "src/plugins/expression_shape/common/types/expression_functions.ts",
@ -1553,7 +1607,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/expression_shape/common/types/expression_functions.ts", "path": "src/plugins/expression_shape/common/types/expression_functions.ts",
@ -2494,7 +2554,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/expression_shape/common/types/expression_functions.ts", "path": "src/plugins/expression_shape/common/types/expression_functions.ts",
@ -2545,7 +2611,13 @@
"text": "Adapters" "text": "Adapters"
}, },
", ", ", ",
"SerializableRecord", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.SerializableRecord",
"text": "SerializableRecord"
},
">>" ">>"
], ],
"path": "src/plugins/expression_shape/common/types/expression_functions.ts", "path": "src/plugins/expression_shape/common/types/expression_functions.ts",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionShape
title: "expressionShape" title: "expressionShape"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionShape plugin description: API docs for the expressionShape plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
--- ---
import expressionShapeObj from './expression_shape.devdocs.json'; import expressionShapeObj from './expression_shape.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud
title: "expressionTagcloud" title: "expressionTagcloud"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionTagcloud plugin description: API docs for the expressionTagcloud plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
--- ---
import expressionTagcloudObj from './expression_tagcloud.devdocs.json'; import expressionTagcloudObj from './expression_tagcloud.devdocs.json';

View file

@ -769,7 +769,13 @@
"label": "palette", "label": "palette",
"description": [], "description": [],
"signature": [ "signature": [
"PaletteOutput", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<{ [key: string]: unknown; }>" "<{ [key: string]: unknown; }>"
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
@ -2252,7 +2258,13 @@
"text": "DataLayerArgs" "text": "DataLayerArgs"
}, },
", \"palette\"> & { type: \"dataLayer\"; layerType: \"data\"; palette: ", ", \"palette\"> & { type: \"dataLayer\"; layerType: \"data\"; palette: ",
"PaletteOutput", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<{ [key: string]: unknown; }>; table: ", "<{ [key: string]: unknown; }>; table: ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -2286,7 +2298,13 @@
"text": "DataLayerArgs" "text": "DataLayerArgs"
}, },
", \"palette\"> & { type: \"dataLayer\"; layerType: \"data\"; palette: ", ", \"palette\"> & { type: \"dataLayer\"; layerType: \"data\"; palette: ",
"PaletteOutput", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<{ [key: string]: unknown; }>; table: ", "<{ [key: string]: unknown; }>; table: ",
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -2328,7 +2346,13 @@
"Omit<", "Omit<",
"ExtendedDataLayerArgs", "ExtendedDataLayerArgs",
", \"palette\"> & { type: \"extendedDataLayer\"; layerType: \"data\"; palette: ", ", \"palette\"> & { type: \"extendedDataLayer\"; layerType: \"data\"; palette: ",
"PaletteOutput", {
"pluginId": "@kbn/coloring",
"scope": "common",
"docId": "kibKbnColoringPluginApi",
"section": "def-common.PaletteOutput",
"text": "PaletteOutput"
},
"<{ [key: string]: unknown; }>; table: ", "<{ [key: string]: unknown; }>; table: ",
{ {
"pluginId": "expressions", "pluginId": "expressions",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionXY
title: "expressionXY" title: "expressionXY"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionXY plugin description: API docs for the expressionXY plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
--- ---
import expressionXYObj from './expression_x_y.devdocs.json'; import expressionXYObj from './expression_x_y.devdocs.json';

File diff suppressed because it is too large Load diff

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions
title: "expressions" title: "expressions"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressions plugin description: API docs for the expressions plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
--- ---
import expressionsObj from './expressions.devdocs.json'; import expressionsObj from './expressions.devdocs.json';
@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 2191 | 17 | 1734 | 5 | | 2191 | 73 | 1734 | 5 |
## Client ## Client

View file

@ -566,7 +566,13 @@
"\nThe category for this feature.\nThis will be used to organize the list of features for display within the\nSpaces and Roles management screens." "\nThe category for this feature.\nThis will be used to organize the list of features for display within the\nSpaces and Roles management screens."
], ],
"signature": [ "signature": [
"AppCategory" {
"pluginId": "@kbn/core-application-common",
"scope": "common",
"docId": "kibKbnCoreApplicationCommonPluginApi",
"section": "def-common.AppCategory",
"text": "AppCategory"
}
], ],
"path": "x-pack/plugins/features/common/kibana_feature.ts", "path": "x-pack/plugins/features/common/kibana_feature.ts",
"deprecated": false, "deprecated": false,
@ -1053,11 +1059,29 @@
"description": [], "description": [],
"signature": [ "signature": [
"Readonly<{ id: string; management?: Readonly<{ [x: string]: ", "Readonly<{ id: string; management?: Readonly<{ [x: string]: ",
"RecursiveReadonlyArray", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.RecursiveReadonlyArray",
"text": "RecursiveReadonlyArray"
},
"<string>; }> | undefined; catalogue?: ", "<string>; }> | undefined; catalogue?: ",
"RecursiveReadonlyArray", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.RecursiveReadonlyArray",
"text": "RecursiveReadonlyArray"
},
"<string> | undefined; privileges: ", "<string> | undefined; privileges: ",
"RecursiveReadonlyArray", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.RecursiveReadonlyArray",
"text": "RecursiveReadonlyArray"
},
"<", "<",
{ {
"pluginId": "features", "pluginId": "features",
@ -1095,7 +1119,13 @@
"label": "catalogue", "label": "catalogue",
"description": [], "description": [],
"signature": [ "signature": [
"RecursiveReadonlyArray", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.RecursiveReadonlyArray",
"text": "RecursiveReadonlyArray"
},
"<string> | undefined" "<string> | undefined"
], ],
"path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "path": "x-pack/plugins/features/common/elasticsearch_feature.ts",
@ -1111,7 +1141,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"Readonly<{ [x: string]: ", "Readonly<{ [x: string]: ",
"RecursiveReadonlyArray", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.RecursiveReadonlyArray",
"text": "RecursiveReadonlyArray"
},
"<string>; }> | undefined" "<string>; }> | undefined"
], ],
"path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "path": "x-pack/plugins/features/common/elasticsearch_feature.ts",
@ -1126,7 +1162,13 @@
"label": "privileges", "label": "privileges",
"description": [], "description": [],
"signature": [ "signature": [
"RecursiveReadonlyArray", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.RecursiveReadonlyArray",
"text": "RecursiveReadonlyArray"
},
"<", "<",
{ {
"pluginId": "features", "pluginId": "features",
@ -1910,7 +1952,13 @@
"\nThe category for this feature.\nThis will be used to organize the list of features for display within the\nSpaces and Roles management screens." "\nThe category for this feature.\nThis will be used to organize the list of features for display within the\nSpaces and Roles management screens."
], ],
"signature": [ "signature": [
"AppCategory" {
"pluginId": "@kbn/core-application-common",
"scope": "common",
"docId": "kibKbnCoreApplicationCommonPluginApi",
"section": "def-common.AppCategory",
"text": "AppCategory"
}
], ],
"path": "x-pack/plugins/features/common/kibana_feature.ts", "path": "x-pack/plugins/features/common/kibana_feature.ts",
"deprecated": false, "deprecated": false,
@ -2435,7 +2483,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"() => ", "() => ",
"Capabilities" {
"pluginId": "@kbn/core-capabilities-common",
"scope": "common",
"docId": "kibKbnCoreCapabilitiesCommonPluginApi",
"section": "def-common.Capabilities",
"text": "Capabilities"
}
], ],
"path": "x-pack/plugins/features/server/plugin.ts", "path": "x-pack/plugins/features/server/plugin.ts",
"deprecated": false, "deprecated": false,
@ -2740,11 +2794,29 @@
"description": [], "description": [],
"signature": [ "signature": [
"Readonly<{ id: string; management?: Readonly<{ [x: string]: ", "Readonly<{ id: string; management?: Readonly<{ [x: string]: ",
"RecursiveReadonlyArray", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.RecursiveReadonlyArray",
"text": "RecursiveReadonlyArray"
},
"<string>; }> | undefined; catalogue?: ", "<string>; }> | undefined; catalogue?: ",
"RecursiveReadonlyArray", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.RecursiveReadonlyArray",
"text": "RecursiveReadonlyArray"
},
"<string> | undefined; privileges: ", "<string> | undefined; privileges: ",
"RecursiveReadonlyArray", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.RecursiveReadonlyArray",
"text": "RecursiveReadonlyArray"
},
"<", "<",
{ {
"pluginId": "features", "pluginId": "features",
@ -2782,7 +2854,13 @@
"label": "catalogue", "label": "catalogue",
"description": [], "description": [],
"signature": [ "signature": [
"RecursiveReadonlyArray", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.RecursiveReadonlyArray",
"text": "RecursiveReadonlyArray"
},
"<string> | undefined" "<string> | undefined"
], ],
"path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "path": "x-pack/plugins/features/common/elasticsearch_feature.ts",
@ -2798,7 +2876,13 @@
"description": [], "description": [],
"signature": [ "signature": [
"Readonly<{ [x: string]: ", "Readonly<{ [x: string]: ",
"RecursiveReadonlyArray", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.RecursiveReadonlyArray",
"text": "RecursiveReadonlyArray"
},
"<string>; }> | undefined" "<string>; }> | undefined"
], ],
"path": "x-pack/plugins/features/common/elasticsearch_feature.ts", "path": "x-pack/plugins/features/common/elasticsearch_feature.ts",
@ -2813,7 +2897,13 @@
"label": "privileges", "label": "privileges",
"description": [], "description": [],
"signature": [ "signature": [
"RecursiveReadonlyArray", {
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.RecursiveReadonlyArray",
"text": "RecursiveReadonlyArray"
},
"<", "<",
{ {
"pluginId": "features", "pluginId": "features",
@ -3719,7 +3809,13 @@
"\nThe category for this feature.\nThis will be used to organize the list of features for display within the\nSpaces and Roles management screens." "\nThe category for this feature.\nThis will be used to organize the list of features for display within the\nSpaces and Roles management screens."
], ],
"signature": [ "signature": [
"AppCategory" {
"pluginId": "@kbn/core-application-common",
"scope": "common",
"docId": "kibKbnCoreApplicationCommonPluginApi",
"section": "def-common.AppCategory",
"text": "AppCategory"
}
], ],
"path": "x-pack/plugins/features/common/kibana_feature.ts", "path": "x-pack/plugins/features/common/kibana_feature.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/features
title: "features" title: "features"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the features plugin description: API docs for the features plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
--- ---
import featuresObj from './features.devdocs.json'; import featuresObj from './features.devdocs.json';

File diff suppressed because it is too large Load diff

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats
title: "fieldFormats" title: "fieldFormats"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the fieldFormats plugin description: API docs for the fieldFormats plugin
date: 2022-10-28 date: 2022-10-29
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
--- ---
import fieldFormatsObj from './field_formats.devdocs.json'; import fieldFormatsObj from './field_formats.devdocs.json';
@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 288 | 5 | 249 | 3 | | 288 | 26 | 249 | 3 |
## Client ## Client

View file

@ -242,9 +242,21 @@
"label": "geoFieldType", "label": "geoFieldType",
"description": [], "description": [],
"signature": [ "signature": [
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".GEO_POINT | ", ".GEO_POINT | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".GEO_SHAPE" ".GEO_SHAPE"
], ],
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts", "path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
@ -604,71 +616,269 @@
"description": [], "description": [],
"signature": [ "signature": [
"{ properties: { [fieldName: string]: { type: ", "{ properties: { [fieldName: string]: { type: ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".STRING | ", ".STRING | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".TEXT | ", ".TEXT | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".MATCH_ONLY_TEXT | ", ".MATCH_ONLY_TEXT | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".KEYWORD | ", ".KEYWORD | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".VERSION | ", ".VERSION | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".BOOLEAN | ", ".BOOLEAN | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".OBJECT | ", ".OBJECT | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".DATE | ", ".DATE | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".DATE_NANOS | ", ".DATE_NANOS | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".DATE_RANGE | ", ".DATE_RANGE | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".GEO_POINT | ", ".GEO_POINT | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".GEO_SHAPE | ", ".GEO_SHAPE | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".FLOAT | ", ".FLOAT | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".HALF_FLOAT | ", ".HALF_FLOAT | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".SCALED_FLOAT | ", ".SCALED_FLOAT | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".DOUBLE | ", ".DOUBLE | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".INTEGER | ", ".INTEGER | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".LONG | ", ".LONG | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".SHORT | ", ".SHORT | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".UNSIGNED_LONG | ", ".UNSIGNED_LONG | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".AGGREGATE_METRIC_DOUBLE | ", ".AGGREGATE_METRIC_DOUBLE | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".FLOAT_RANGE | ", ".FLOAT_RANGE | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".DOUBLE_RANGE | ", ".DOUBLE_RANGE | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".INTEGER_RANGE | ", ".INTEGER_RANGE | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".LONG_RANGE | ", ".LONG_RANGE | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".NESTED | ", ".NESTED | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".BYTE | ", ".BYTE | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".IP | ", ".IP | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".IP_RANGE | ", ".IP_RANGE | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".ATTACHMENT | ", ".ATTACHMENT | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".TOKEN_COUNT | ", ".TOKEN_COUNT | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".MURMUR3 | ", ".MURMUR3 | ",
"ES_FIELD_TYPES", {
"pluginId": "@kbn/field-types",
"scope": "common",
"docId": "kibKbnFieldTypesPluginApi",
"section": "def-common.ES_FIELD_TYPES",
"text": "ES_FIELD_TYPES"
},
".HISTOGRAM; format?: string | undefined; }; }; }" ".HISTOGRAM; format?: string | undefined; }; }; }"
], ],
"path": "x-pack/plugins/file_upload/common/types.ts", "path": "x-pack/plugins/file_upload/common/types.ts",

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