github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity

[api-docs] 2025-06-25 Daily api_docs build (#225198)

Browse source 
Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/1114
This commit is contained in:
Kibana Machine 2025-06-25 08:05:17 +02:00 • committed by GitHub
parent 6e7c61a13e
commit 401ddc0d56
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
909 changed files with 6994 additions and 7653 deletions
Download patch file Download diff file Expand all files Collapse all files

2
api_docs/actions.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions
title: "actions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the actions plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
import actionsObj from './actions.devdocs.json';

2
api_docs/advanced_settings.mdx
View file

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

2
api_docs/ai_assistant_management_selection.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiAssistantManagementSelection
title: "aiAssistantManagementSelection"
image: https://source.unsplash.com/400x175/?github
description: API docs for the aiAssistantManagementSelection plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection']
---
import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json';

2
api_docs/aiops.mdx
View file

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

31
api_docs/alerting.devdocs.json
View file

@ -4319,6 +4319,37 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.RuleType.priority",
"type": "CompoundType",
"tags": [],
"label": "priority",
"description": [
"\nTask priority allowing for tasks to be ran at lower priority (NormalLongRunning vs Normal), defaults to\nnormal priority."
],
"signature": [
{
"pluginId": "taskManager",
"scope": "server",
"docId": "kibTaskManagerPluginApi",
"section": "def-server.TaskPriority",
"text": "TaskPriority"
},
".NormalLongRunning | ",
{
"pluginId": "taskManager",
"scope": "server",
"docId": "kibTaskManagerPluginApi",
"section": "def-server.TaskPriority",
"text": "TaskPriority"
},
".Normal | undefined"
],
"path": "x-pack/platform/plugins/shared/alerting/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.RuleType.internallyManaged",

4
api_docs/alerting.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting
title: "alerting"
image: https://source.unsplash.com/400x175/?github
description: API docs for the alerting plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 915 | 1 | 879 | 57 |
| 916 | 1 | 879 | 57 |
## Client

176
api_docs/apm.devdocs.json
View file

File diff suppressed because one or more lines are too long

4
api_docs/apm.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm
title: "apm"
image: https://source.unsplash.com/400x175/?github
description: API docs for the apm plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/te
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 26 | 0 | 26 | 121 |
| 26 | 0 | 26 | 120 |
## Client

2
api_docs/apm_data_access.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apmDataAccess
title: "apmDataAccess"
image: https://source.unsplash.com/400x175/?github
description: API docs for the apmDataAccess plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
---
import apmDataAccessObj from './apm_data_access.devdocs.json';

2
api_docs/apm_sources_access.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apmSourcesAccess
title: "apmSourcesAccess"
image: https://source.unsplash.com/400x175/?github
description: API docs for the apmSourcesAccess plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmSourcesAccess']
---
import apmSourcesAccessObj from './apm_sources_access.devdocs.json';

2
api_docs/automatic_import.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/automaticImport
title: "automaticImport"
image: https://source.unsplash.com/400x175/?github
description: API docs for the automaticImport plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'automaticImport']
---
import automaticImportObj from './automatic_import.devdocs.json';

2
api_docs/banners.mdx
View file

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

2
api_docs/canvas.mdx
View file

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

2
api_docs/cases.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases
title: "cases"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cases plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
---
import casesObj from './cases.devdocs.json';

2
api_docs/charts.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts
title: "charts"
image: https://source.unsplash.com/400x175/?github
description: API docs for the charts plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
import chartsObj from './charts.devdocs.json';

2
api_docs/cloud.mdx
View file

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

2
api_docs/cloud_data_migration.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration
title: "cloudDataMigration"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDataMigration plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
---
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';

2
api_docs/cloud_security_posture.mdx
View file

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

2
api_docs/console.mdx
View file

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

2
api_docs/content_connectors.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentConnectors
title: "contentConnectors"
image: https://source.unsplash.com/400x175/?github
description: API docs for the contentConnectors plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentConnectors']
---
import contentConnectorsObj from './content_connectors.devdocs.json';

2
api_docs/content_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentManagement
title: "contentManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the contentManagement plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
---
import contentManagementObj from './content_management.devdocs.json';

2
api_docs/controls.mdx
View file

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

2
api_docs/custom_integrations.mdx
View file

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

696
api_docs/dashboard.devdocs.json
View file

@ -19,7 +19,7 @@
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<Partial<Omit<",
"<Partial<",
{
"pluginId": "dashboard",
"scope": "common",
@ -27,7 +27,7 @@
"section": "def-common.DashboardState",
"text": "DashboardState"
},
", \"sections\" | \"panels\"> & { controlGroupInput?: (",
" & { controlGroupInput?: (",
{
"pluginId": "controls",
"scope": "common",
@ -43,15 +43,7 @@
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
") | undefined; panels: (Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
{
"pluginId": "dashboard",
"scope": "server",
"docId": "kibDashboardPluginApi",
"section": "def-server.DashboardPanel",
"text": "DashboardPanel"
},
")[]; references?: (",
") | undefined; references?: (",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
@ -127,7 +119,7 @@
"label": "getLocation",
"description": [],
"signature": [
"(params: Partial<Omit<",
"(params: Partial<",
{
"pluginId": "dashboard",
"scope": "common",
@ -135,7 +127,7 @@
"section": "def-common.DashboardState",
"text": "DashboardState"
},
", \"sections\" | \"panels\"> & { controlGroupInput?: (",
" & { controlGroupInput?: (",
{
"pluginId": "controls",
"scope": "common",
@ -151,15 +143,7 @@
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
") | undefined; panels: (Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
{
"pluginId": "dashboard",
"scope": "server",
"docId": "kibDashboardPluginApi",
"section": "def-server.DashboardPanel",
"text": "DashboardPanel"
},
")[]; references?: (",
") | undefined; references?: (",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
@ -197,7 +181,7 @@
"label": "params",
"description": [],
"signature": [
"Partial<Omit<",
"Partial<",
{
"pluginId": "dashboard",
"scope": "common",
@ -205,7 +189,7 @@
"section": "def-common.DashboardState",
"text": "DashboardState"
},
", \"sections\" | \"panels\"> & { controlGroupInput?: (",
" & { controlGroupInput?: (",
{
"pluginId": "controls",
"scope": "common",
@ -221,15 +205,7 @@
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
") | undefined; panels: (Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
{
"pluginId": "dashboard",
"scope": "server",
"docId": "kibDashboardPluginApi",
"section": "def-server.DashboardPanel",
"text": "DashboardPanel"
},
")[]; references?: (",
") | undefined; references?: (",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
@ -435,7 +411,7 @@
"section": "def-public.DashboardDrilldownOptions",
"text": "DashboardDrilldownOptions"
},
") => Partial<Partial<Omit<",
") => Partial<Partial<",
{
"pluginId": "dashboard",
"scope": "common",
@ -443,7 +419,7 @@
"section": "def-common.DashboardState",
"text": "DashboardState"
},
", \"sections\" | \"panels\"> & { controlGroupInput?: (",
" & { controlGroupInput?: (",
{
"pluginId": "controls",
"scope": "common",
@ -459,15 +435,7 @@
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
") | undefined; panels: (Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
{
"pluginId": "dashboard",
"scope": "server",
"docId": "kibDashboardPluginApi",
"section": "def-server.DashboardPanel",
"text": "DashboardPanel"
},
")[]; references?: (",
") | undefined; references?: (",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
@ -1044,7 +1012,7 @@
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<Partial<Omit<",
"<Partial<",
{
"pluginId": "dashboard",
"scope": "common",
@ -1052,7 +1020,7 @@
"section": "def-common.DashboardState",
"text": "DashboardState"
},
", \"sections\" | \"panels\"> & { controlGroupInput?: (",
" & { controlGroupInput?: (",
{
"pluginId": "controls",
"scope": "common",
@ -1068,15 +1036,7 @@
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
") | undefined; panels: (Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
{
"pluginId": "dashboard",
"scope": "server",
"docId": "kibDashboardPluginApi",
"section": "def-server.DashboardPanel",
"text": "DashboardPanel"
},
")[]; references?: (",
") | undefined; references?: (",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
@ -1516,7 +1476,7 @@
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<Partial<Omit<",
"<Partial<",
{
"pluginId": "dashboard",
"scope": "common",
@ -1524,7 +1484,7 @@
"section": "def-common.DashboardState",
"text": "DashboardState"
},
", \"sections\" | \"panels\"> & { controlGroupInput?: (",
" & { controlGroupInput?: (",
{
"pluginId": "controls",
"scope": "common",
@ -1540,15 +1500,7 @@
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
") | undefined; panels: (Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
{
"pluginId": "dashboard",
"scope": "server",
"docId": "kibDashboardPluginApi",
"section": "def-server.DashboardPanel",
"text": "DashboardPanel"
},
")[]; references?: (",
") | undefined; references?: (",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
@ -1835,7 +1787,7 @@
"section": "def-common.FilterStateStore",
"text": "FilterStateStore"
},
"; }> | undefined; } & { meta: Readonly<{ params?: any; key?: string | undefined; value?: string | undefined; type?: string | undefined; alias?: string | null | undefined; index?: string | undefined; disabled?: boolean | undefined; field?: string | undefined; group?: string | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; isMultiIndex?: boolean | undefined; } & {}>; }>[] | undefined; query?: Readonly<{} & { query: string | Record<string, any>; language: string; }> | undefined; } & {}> | undefined; } & {}>; timeRestore: boolean; panels: (Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }> | Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }>)[]; }>, \"panels\"> & { panels: (Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
"; }> | undefined; } & { meta: Readonly<{ params?: any; key?: string | undefined; value?: string | undefined; type?: string | undefined; alias?: string | null | undefined; index?: string | undefined; disabled?: boolean | undefined; field?: string | undefined; group?: string | undefined; negate?: boolean | undefined; controlledBy?: string | undefined; isMultiIndex?: boolean | undefined; } & {}>; }>[] | undefined; query?: Readonly<{} & { query: string | Record<string, any>; language: string; }> | undefined; } & {}> | undefined; } & {}>; timeRestore: boolean; panels: (Readonly<{ version?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }> | Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ version?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }>)[]; }>, \"panels\"> & { panels: (Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ version?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
{
"pluginId": "dashboard",
"scope": "server",
@ -1873,7 +1825,7 @@
"label": "DashboardPanel",
"description": [],
"signature": [
"Omit<Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>, \"panelConfig\"> & { panelConfig: Readonly<{} & {}> & { [key: string]: any; }; gridData: ",
"Omit<Readonly<{ version?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>, \"panelConfig\"> & { panelConfig: Readonly<{} & {}> & { [key: string]: any; }; gridData: ",
"GridData",
"; }"
],
@ -1890,7 +1842,7 @@
"label": "DashboardSection",
"description": [],
"signature": [
"{ readonly collapsed?: boolean | undefined; readonly title: string; readonly panels: Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; readonly gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }"
"{ readonly collapsed?: boolean | undefined; readonly title: string; readonly panels: Readonly<{ version?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; readonly gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }"
],
"path": "src/platform/plugins/shared/dashboard/server/content_management/v3/types.ts",
"deprecated": false,
@ -2002,6 +1954,133 @@
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "dashboard",
"id": "def-common.getReferencesForControls",
"type": "Function",
"tags": [],
"label": "getReferencesForControls",
"description": [],
"signature": [
"(references: ",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.Reference",
"text": "Reference"
},
"[]) => ",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.Reference",
"text": "Reference"
},
"[]"
],
"path": "src/platform/plugins/shared/dashboard/common/reference_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.getReferencesForControls.$1",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.Reference",
"text": "Reference"
},
"[]"
],
"path": "src/platform/plugins/shared/dashboard/common/reference_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.getReferencesForPanelId",
"type": "Function",
"tags": [],
"label": "getReferencesForPanelId",
"description": [],
"signature": [
"(id: string, references: ",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.Reference",
"text": "Reference"
},
"[]) => ",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.Reference",
"text": "Reference"
},
"[]"
],
"path": "src/platform/plugins/shared/dashboard/common/reference_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.getReferencesForPanelId.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/dashboard/common/reference_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "dashboard",
"id": "def-common.getReferencesForPanelId.$2",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.Reference",
"text": "Reference"
},
"[]"
],
"path": "src/platform/plugins/shared/dashboard/common/reference_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.isDashboardSection",
@ -2010,7 +2089,7 @@
"label": "isDashboardSection",
"description": [],
"signature": [
"(widget: Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
"(widget: Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ version?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
{
"pluginId": "dashboard",
"scope": "server",
@ -2018,9 +2097,9 @@
"section": "def-server.DashboardPanel",
"text": "DashboardPanel"
},
") => widget is Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }>"
") => widget is Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ version?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }>"
],
"path": "src/platform/plugins/shared/dashboard/common/lib/dashboard_panel_converters.ts",
"path": "src/platform/plugins/shared/dashboard/common/is_dashboard_section.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
@ -2032,7 +2111,7 @@
"label": "widget",
"description": [],
"signature": [
"Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
"Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ version?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
{
"pluginId": "dashboard",
"scope": "server",
@ -2041,7 +2120,78 @@
"text": "DashboardPanel"
}
],
"path": "src/platform/plugins/shared/dashboard/common/lib/dashboard_panel_converters.ts",
"path": "src/platform/plugins/shared/dashboard/common/is_dashboard_section.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.prefixReferencesFromPanel",
"type": "Function",
"tags": [],
"label": "prefixReferencesFromPanel",
"description": [],
"signature": [
"(id: string, references: ",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.Reference",
"text": "Reference"
},
"[]) => ",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.Reference",
"text": "Reference"
},
"[]"
],
"path": "src/platform/plugins/shared/dashboard/common/reference_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.prefixReferencesFromPanel.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/dashboard/common/reference_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "dashboard",
"id": "def-common.prefixReferencesFromPanel.$2",
"type": "Array",
"tags": [],
"label": "references",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.Reference",
"text": "Reference"
},
"[]"
],
"path": "src/platform/plugins/shared/dashboard/common/reference_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
@ -2113,257 +2263,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelMap",
"type": "Interface",
"tags": [],
"label": "DashboardPanelMap",
"description": [],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelMap.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[key: string]: DashboardPanelState<object>",
"description": [],
"signature": [
"[key: string]: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "DashboardPanelState"
},
"<object>"
],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelState",
"type": "Interface",
"tags": [],
"label": "DashboardPanelState",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "DashboardPanelState"
},
"<PanelState>"
],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelState.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelState.explicitInput",
"type": "Uncategorized",
"tags": [],
"label": "explicitInput",
"description": [],
"signature": [
"PanelState"
],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelState.gridData",
"type": "CompoundType",
"tags": [],
"label": "gridData",
"description": [],
"signature": [
"Omit<Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>, \"i\"> & { readonly i: string; } & { sectionId?: string | undefined; }"
],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelState.panelRefName",
"type": "string",
"tags": [],
"label": "panelRefName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelState.version",
"type": "string",
"tags": [],
"label": "version",
"description": [
"\nThis version key was used to store Kibana version information from versions 7.3.0 -> 8.11.0.\nAs of version 8.11.0, the versioning information is now per-embeddable-type and is stored on the\nembeddable's input. This key is needed for BWC, but its value will be removed on Dashboard save."
],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelState.references",
"type": "Array",
"tags": [],
"label": "references",
"description": [
"\nReact embeddables are serialized and may pass references that are later used in factory's deserialize method."
],
"signature": [
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.Reference",
"text": "Reference"
},
"[] | undefined"
],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardSectionMap",
"type": "Interface",
"tags": [],
"label": "DashboardSectionMap",
"description": [],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardSectionMap.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[id: string]: DashboardSectionState",
"description": [],
"signature": [
"[id: string]: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardSectionState",
"text": "DashboardSectionState"
}
],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardSectionState",
"type": "Interface",
"tags": [],
"label": "DashboardSectionState",
"description": [],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardSectionState.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardSectionState.collapsed",
"type": "CompoundType",
"tags": [],
"label": "collapsed",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardSectionState.gridData",
"type": "Object",
"tags": [],
"label": "gridData",
"description": [],
"signature": [
"{ readonly i: string; readonly y: number; }"
],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardSectionState.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardState",
@ -2486,38 +2385,20 @@
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardState.panels",
"type": "Object",
"type": "Array",
"tags": [],
"label": "panels",
"description": [],
"signature": [
"(Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ version?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
{
"pluginId": "dashboard",
"scope": "common",
"scope": "server",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelMap",
"text": "DashboardPanelMap"
}
],
"path": "src/platform/plugins/shared/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardState.sections",
"type": "Object",
"tags": [],
"label": "sections",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardSectionMap",
"text": "DashboardSectionMap"
}
"section": "def-server.DashboardPanel",
"text": "DashboardPanel"
},
")[]"
],
"path": "src/platform/plugins/shared/dashboard/common/types.ts",
"deprecated": false,
@ -2571,49 +2452,6 @@
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.InjectExtractDeps",
"type": "Interface",
"tags": [],
"label": "InjectExtractDeps",
"description": [],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.InjectExtractDeps.embeddablePersistableStateService",
"type": "Object",
"tags": [],
"label": "embeddablePersistableStateService",
"description": [],
"signature": [
{
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PersistableStateService",
"text": "PersistableStateService"
},
"<",
{
"pluginId": "embeddable",
"scope": "server",
"docId": "kibEmbeddablePluginApi",
"section": "def-server.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
},
">"
],
"path": "src/platform/plugins/shared/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
@ -2626,31 +2464,7 @@
"label": "DashboardLocatorParams",
"description": [],
"signature": [
"{ tags?: string[] | undefined; title?: string | undefined; description?: string | undefined; viewMode?: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.ViewMode",
"text": "ViewMode"
},
" | undefined; timeRestore?: boolean | undefined; timeRange?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; refreshInterval?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" | undefined; query?: ",
"{ query?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
@ -2666,7 +2480,39 @@
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined; references?: (",
"[] | undefined; timeRange?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; refreshInterval?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" | undefined; viewMode?: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.ViewMode",
"text": "ViewMode"
},
" | undefined; panels?: (Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ version?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
{
"pluginId": "dashboard",
"scope": "server",
"docId": "kibDashboardPluginApi",
"section": "def-server.DashboardPanel",
"text": "DashboardPanel"
},
")[] | undefined; references?: (",
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
@ -2682,7 +2528,7 @@
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
") | undefined; hidePanelTitles?: boolean | undefined; useMargins?: boolean | undefined; syncColors?: boolean | undefined; syncTooltips?: boolean | undefined; syncCursor?: boolean | undefined; controlGroupInput?: (",
") | undefined; controlGroupInput?: (",
{
"pluginId": "controls",
"scope": "common",
@ -2698,15 +2544,7 @@
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
") | undefined; panels?: (Readonly<{ collapsed?: boolean | undefined; } & { title: string; panels: Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{} & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>[]; gridData: Readonly<{ i?: string | undefined; } & { y: number; }>; }> | ",
{
"pluginId": "dashboard",
"scope": "server",
"docId": "kibDashboardPluginApi",
"section": "def-server.DashboardPanel",
"text": "DashboardPanel"
},
")[] | undefined; dashboardId?: string | undefined; useHash?: boolean | undefined; preserveSavedFilters?: boolean | undefined; searchSessionId?: string | undefined; }"
") | undefined; hidePanelTitles?: boolean | undefined; useMargins?: boolean | undefined; syncColors?: boolean | undefined; syncTooltips?: boolean | undefined; syncCursor?: boolean | undefined; description?: string | undefined; tags?: string[] | undefined; timeRestore?: boolean | undefined; title?: string | undefined; dashboardId?: string | undefined; useHash?: boolean | undefined; preserveSavedFilters?: boolean | undefined; searchSessionId?: string | undefined; }"
],
"path": "src/platform/plugins/shared/dashboard/common/types.ts",
"deprecated": false,

4
api_docs/dashboard.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboard
title: "dashboard"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboard plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
---
import dashboardObj from './dashboard.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 100 | 0 | 95 | 12 |
| 89 | 0 | 86 | 12 |
## Client

2
api_docs/dashboard_enhanced.mdx
View file

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

4
api_docs/data.devdocs.json
View file

@ -9525,7 +9525,7 @@
},
"; history: ",
"SearchRequest",
"<Record<string, any>>[]; destroy: () => void; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: <K extends keyof ",
"<Record<string, any>>[]; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
@ -9703,7 +9703,7 @@
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
" | undefined) => Promise<unknown>) => void; getSearchRequestBody: () => any; loadDataViewFields: (dataView: ",
" | undefined) => Promise<unknown>) => void; getSearchRequestBody: () => any; destroy: () => void; loadDataViewFields: (dataView: ",
{
"pluginId": "dataViews",
"scope": "common",

2
api_docs/data.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data
title: "data"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
---
import dataObj from './data.devdocs.json';

2
api_docs/data_quality.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataQuality
title: "dataQuality"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataQuality plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataQuality']
---
import dataQualityObj from './data_quality.devdocs.json';

2
api_docs/data_query.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query
title: "data.query"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data.query plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
---
import dataQueryObj from './data_query.devdocs.json';

14
api_docs/data_search.devdocs.json
View file

@ -159,7 +159,7 @@
"\nCurrent session management\n{@link ISessionService}"
],
"signature": [
"{ start: () => string; clear: () => void; destroy: () => void; save: () => Promise<void>; readonly state$: ",
"{ start: () => string; clear: () => void; save: () => Promise<void>; destroy: () => void; readonly state$: ",
"Observable",
"<",
{
@ -631,7 +631,7 @@
"\nCurrent session management\n{@link ISessionService}"
],
"signature": [
"{ start: () => string; clear: () => void; destroy: () => void; save: () => Promise<void>; readonly state$: ",
"{ start: () => string; clear: () => void; save: () => Promise<void>; destroy: () => void; readonly state$: ",
"Observable",
"<",
{
@ -1133,7 +1133,7 @@
"label": "ISessionService",
"description": [],
"signature": [
"{ start: () => string; clear: () => void; destroy: () => void; save: () => Promise<void>; readonly state$: ",
"{ start: () => string; clear: () => void; save: () => Promise<void>; destroy: () => void; readonly state$: ",
"Observable",
"<",
{
@ -6660,7 +6660,7 @@
},
"; history: ",
"SearchRequest",
"<Record<string, any>>[]; destroy: () => void; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: <K extends keyof ",
"<Record<string, any>>[]; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
@ -6838,7 +6838,7 @@
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
" | undefined) => Promise<unknown>) => void; getSearchRequestBody: () => any; loadDataViewFields: (dataView: ",
" | undefined) => Promise<unknown>) => void; getSearchRequestBody: () => any; destroy: () => void; loadDataViewFields: (dataView: ",
{
"pluginId": "dataViews",
"scope": "common",
@ -33596,7 +33596,7 @@
},
"; history: ",
"SearchRequest",
"<Record<string, any>>[]; destroy: () => void; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: <K extends keyof ",
"<Record<string, any>>[]; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
@ -33774,7 +33774,7 @@
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
" | undefined) => Promise<unknown>) => void; getSearchRequestBody: () => any; loadDataViewFields: (dataView: ",
" | undefined) => Promise<unknown>) => void; getSearchRequestBody: () => any; destroy: () => void; loadDataViewFields: (dataView: ",
{
"pluginId": "dataViews",
"scope": "common",

2
api_docs/data_search.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search
title: "data.search"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data.search plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
---
import dataSearchObj from './data_search.devdocs.json';

2
api_docs/data_usage.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataUsage
title: "dataUsage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataUsage plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataUsage']
---
import dataUsageObj from './data_usage.devdocs.json';

2
api_docs/data_view_editor.mdx
View file

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

2
api_docs/data_view_field_editor.mdx
View file

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

2
api_docs/data_view_management.mdx
View file

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

8
api_docs/data_views.devdocs.json
View file

@ -13802,6 +13802,14 @@
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/public/sourcerer/containers/create_sourcerer_data_view.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/public/sourcerer/containers/create_sourcerer_data_view.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/public/sourcerer/containers/create_sourcerer_data_view.ts"
},
{
"plugin": "timelines",
"path": "x-pack/platform/plugins/shared/timelines/server/search_strategy/index_fields/index.ts"

2
api_docs/data_views.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews
title: "dataViews"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViews plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
---
import dataViewsObj from './data_views.devdocs.json';

2
api_docs/data_visualizer.mdx
View file

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

12
api_docs/dataset_quality.devdocs.json
View file

@ -89,7 +89,7 @@
"label": "getDataStreamsStats",
"description": [],
"signature": [
"(params?: (({ types: (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[]; } | { datasetQuery: string; }) & { includeCreationDate?: boolean | undefined; }) | undefined) => Promise<{ datasetUserPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }>"
"(params?: (({ types: (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[]; } | { datasetQuery: string; }) & { includeCreationDate?: boolean | undefined; }) | undefined) => Promise<{ datasetUserPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; hasFailureStore?: boolean | undefined; })[]; }>"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/types.ts",
"deprecated": false,
@ -273,7 +273,7 @@
"label": "DataStreamStatServiceResponse",
"description": [],
"signature": [
"{ datasetUserPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }"
"{ datasetUserPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; hasFailureStore?: boolean | undefined; })[]; }"
],
"path": "x-pack/platform/plugins/shared/dataset_quality/common/data_streams_stats/types.ts",
"deprecated": false,
@ -748,7 +748,7 @@
"Type",
"<number, string, unknown>; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { lastActivity?: number | undefined; degradedDocsCount?: number | undefined; failedDocsCount?: number | undefined; docsCount?: number | undefined; sizeBytes?: number | undefined; services?: { [x: string]: string[]; } | undefined; hosts?: { [x: string]: string[]; } | undefined; userPrivileges?: { canMonitor: boolean; canReadFailureStore: boolean; } | undefined; }, ",
", { hasFailureStore?: boolean | undefined; lastActivity?: number | undefined; degradedDocsCount?: number | undefined; failedDocsCount?: number | undefined; docsCount?: number | undefined; sizeBytes?: number | undefined; services?: { [x: string]: string[]; } | undefined; hosts?: { [x: string]: string[]; } | undefined; userPrivileges?: { canMonitor: boolean; canReadFailureStore: boolean; } | undefined; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_field/{degradedField}/values\": ",
{
@ -938,7 +938,7 @@
"Type",
"<boolean, boolean, unknown>; }>]>; }>, ",
"DatasetQualityRouteHandlerResources",
", { datasetUserPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }, ",
", { datasetUserPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; hasFailureStore?: boolean | undefined; })[]; }, ",
"DatasetQualityRouteCreateOptions",
">; }[TEndpoint] extends ",
{
@ -1243,7 +1243,7 @@
"Type",
"<number, string, unknown>; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { lastActivity?: number | undefined; degradedDocsCount?: number | undefined; failedDocsCount?: number | undefined; docsCount?: number | undefined; sizeBytes?: number | undefined; services?: { [x: string]: string[]; } | undefined; hosts?: { [x: string]: string[]; } | undefined; userPrivileges?: { canMonitor: boolean; canReadFailureStore: boolean; } | undefined; }, ",
", { hasFailureStore?: boolean | undefined; lastActivity?: number | undefined; degradedDocsCount?: number | undefined; failedDocsCount?: number | undefined; docsCount?: number | undefined; sizeBytes?: number | undefined; services?: { [x: string]: string[]; } | undefined; hosts?: { [x: string]: string[]; } | undefined; userPrivileges?: { canMonitor: boolean; canReadFailureStore: boolean; } | undefined; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_field/{degradedField}/values\": ",
{
@ -1433,7 +1433,7 @@
"Type",
"<boolean, boolean, unknown>; }>]>; }>, ",
"DatasetQualityRouteHandlerResources",
", { datasetUserPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }, ",
", { datasetUserPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; hasFailureStore?: boolean | undefined; })[]; }, ",
"DatasetQualityRouteCreateOptions",
">; }[TEndpoint] extends ",
{

2
api_docs/dataset_quality.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/datasetQuality
title: "datasetQuality"
image: https://source.unsplash.com/400x175/?github
description: API docs for the datasetQuality plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality']
---
import datasetQualityObj from './dataset_quality.devdocs.json';

15
api_docs/deprecations_by_api.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
slug: /kibana-dev-docs/api-meta/deprecated-api-list-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.
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -27,6 +27,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SimpleSavedObject" text="SimpleSavedObject"/> | @kbn/core, visualizations, dataVisualizer, ml, aiops, graph, dashboardEnhanced, lens, securitySolution, eventAnnotation | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | @kbn/core, savedObjects, visualizations, canvas, graph, ml | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.migrations" text="migrations"/> | @kbn/core, taskManager, ml, spaces, dataViews, data, fleet, share, actions, alerting, apmSourcesAccess, dashboard, savedSearch, canvas, graph, lens, cases, maps, lists, securitySolution, apm, @kbn/test-suites-xpack-platform, visualizations, infra, slo, synthetics, uptime, cloudSecurityPosture, eventAnnotation, links, savedObjectsManagement | - |
| <DocLink id="kibKbnMlAnomalyUtilsPluginApi" section="def-common.ML_SEVERITY_COLORS" text="ML_SEVERITY_COLORS"/> | ml | - |
| <DocLink id="kibKbnMlAnomalyUtilsPluginApi" section="def-common.getSeverityColor" text="getSeverityColor"/> | apm, ml, uptime | - |
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | stackAlerts, graph, inputControlVis, securitySolution | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | dataVisualizer, stackAlerts, expressionPartitionVis | - |
@ -42,8 +44,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.create" text="create"/> | alerting, securitySolution | - |
| <DocLink id="kibDataPluginApi" section="def-common.SavedObject.migrationVersion" text="migrationVersion"/> | @kbn/core, fleet, graph, osquery, lists, searchPlayground, securitySolution | - |
| <DocLink id="kibDiscoverPluginApi" section="def-public.DiscoverStart.DiscoverContainer" text="DiscoverContainer"/> | securitySolution | - |
| <DocLink id="kibFleetPluginApi" section="def-public.NewPackagePolicy.policy_id" text="policy_id"/> | securitySolution, synthetics, @kbn/test-suites-xpack-observability | - |
| <DocLink id="kibFleetPluginApi" section="def-common.NewPackagePolicy.policy_id" text="policy_id"/> | securitySolution, synthetics, @kbn/test-suites-xpack-observability | - |
| <DocLink id="kibFleetPluginApi" section="def-public.NewPackagePolicy.policy_id" text="policy_id"/> | synthetics, @kbn/test-suites-xpack-observability, securitySolution | - |
| <DocLink id="kibFleetPluginApi" section="def-common.NewPackagePolicy.policy_id" text="policy_id"/> | synthetics, @kbn/test-suites-xpack-observability, securitySolution | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.useDarkMode" text="useDarkMode"/> | securitySolution | - |
| <DocLink id="kibLensPluginApi" section="def-public.PieVisualizationState.palette" text="palette"/> | securitySolution | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginStart.authc" text="authc"/> | fleet, alerting, observabilityAIAssistant, transform, upgradeAssistant, entityManager, securitySolution, @kbn/test-suites-xpack-platform, synthetics, serverlessSearch, cloudSecurityPosture, security | - |
@ -73,7 +75,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_ID" text="ENDPOINT_BLOCKLISTS_LIST_ID"/> | securitySolution | - |
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_NAME" text="ENDPOINT_BLOCKLISTS_LIST_NAME"/> | securitySolution | - |
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION" text="ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION"/> | securitySolution | - |
| <DocLink id="kibKbnUnifiedDataTablePluginApi" section="def-public.UnifiedDataTableProps.externalControlColumns" text="externalControlColumns"/> | cloudSecurityPosture, securitySolution | - |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.ConcreteTaskInstance.interval" text="interval"/> | @kbn/test-suites-xpack-platform | - |
| <DocLink id="kibControlsPluginApi" section="def-public.serializeRuntimeState" text="serializeRuntimeState"/> | dashboard | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.schemas" text="schemas"/> | @kbn/core, spaces, data, dashboard, savedSearch, visualizations, cloudSecurityPosture | - |
@ -158,10 +159,11 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibExpressionsPluginApi" section="def-common.ExpressionsServiceSetup.getTypes" text="getTypes"/> | canvas | - |
| <DocLink id="kibExpressionsPluginApi" section="def-server.ExpressionFunctionDefinition.context" text="context"/> | canvas | - |
| <DocLink id="kibKbnTestJestHelpersPluginApi" section="def-common.findTestSubject" text="findTestSubject"/> | snapshotRestore, watcher, ingestPipelines, remoteClusters, upgradeAssistant, indexManagement, @kbn/security-ui-components, security, dataViewFieldEditor | - |
| <DocLink id="kibKbnTestJestHelpersPluginApi" section="def-common.registerTestBed" text="registerTestBed"/> | runtimeFields, indexLifecycleManagement, reporting, snapshotRestore, watcher, ingestPipelines, remoteClusters, upgradeAssistant, indexManagement, searchprofiler, dataViewEditor, dataViewFieldEditor, esUiShared | - |
| <DocLink id="kibKbnTestJestHelpersPluginApi" section="def-common.registerTestBed" text="registerTestBed"/> | runtimeFields, indexLifecycleManagement, snapshotRestore, watcher, ingestPipelines, remoteClusters, reporting, upgradeAssistant, indexManagement, searchprofiler, dataViewEditor, dataViewFieldEditor, esUiShared | - |
| <DocLink id="kibKbnTestJestHelpersPluginApi" section="def-common.shallowWithIntl" text="shallowWithIntl"/> | uptime, telemetry | - |
| <DocLink id="kibKbnTestJestHelpersPluginApi" section="def-common.mountWithIntl" text="mountWithIntl"/> | uptime | - |
| <DocLink id="kibKbnTestJestHelpersPluginApi" section="def-common.renderWithI18nProvider" text="renderWithI18nProvider"/> | uptime | - |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.type" text="type"/> | ux, synthetics | - |
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableSetup.registerEnhancement" text="registerEnhancement"/> | uiActionsEnhanced | - |
| <DocLink id="kibExpressionGaugePluginApi" section="def-common.GaugeState.percentageMode" text="percentageMode"/> | visTypeGauge | - |
| <DocLink id="kibExpressionPartitionVisPluginApi" section="def-common.LabelsParams.truncate" text="truncate"/> | visTypePie | - |
@ -265,7 +267,6 @@ Safe to remove.
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.setChecked.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.setInputFiles.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.tap.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.type" text="type"/> | @kbn/scout |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.type.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.uncheck.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout |
| <DocLink id="kibKbnScoutObltPluginApi" section="def-common.Locator.check.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-oblt |
@ -283,7 +284,6 @@ Safe to remove.
| <DocLink id="kibKbnScoutObltPluginApi" section="def-common.Locator.setChecked.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-oblt |
| <DocLink id="kibKbnScoutObltPluginApi" section="def-common.Locator.setInputFiles.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-oblt |
| <DocLink id="kibKbnScoutObltPluginApi" section="def-common.Locator.tap.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-oblt |
| <DocLink id="kibKbnScoutObltPluginApi" section="def-common.Locator.type" text="type"/> | @kbn/scout-oblt |
| <DocLink id="kibKbnScoutObltPluginApi" section="def-common.Locator.type.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-oblt |
| <DocLink id="kibKbnScoutObltPluginApi" section="def-common.Locator.uncheck.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-oblt |
| <DocLink id="kibKbnScoutSecurityPluginApi" section="def-common.Locator.check.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-security |
@ -301,7 +301,6 @@ Safe to remove.
| <DocLink id="kibKbnScoutSecurityPluginApi" section="def-common.Locator.setChecked.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-security |
| <DocLink id="kibKbnScoutSecurityPluginApi" section="def-common.Locator.setInputFiles.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-security |
| <DocLink id="kibKbnScoutSecurityPluginApi" section="def-common.Locator.tap.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-security |
| <DocLink id="kibKbnScoutSecurityPluginApi" section="def-common.Locator.type" text="type"/> | @kbn/scout-security |
| <DocLink id="kibKbnScoutSecurityPluginApi" section="def-common.Locator.type.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-security |
| <DocLink id="kibKbnScoutSecurityPluginApi" section="def-common.Locator.uncheck.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-security |
| <DocLink id="kibKbnTestJestHelpersPluginApi" section="def-common.renderWithIntl" text="renderWithIntl"/> | @kbn/test-jest-helpers |

12
api_docs/deprecations_by_plugin.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-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.
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -362,6 +362,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/common/license_check.test.ts#:~:text=mode), [license_check.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/common/license_check.test.ts#:~:text=mode)+ 2 more | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [add_api_keys_to_policies_if_missing.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/server/routes/fleet/api_keys/add_api_keys_to_policies_if_missing.ts#:~:text=license%24) | 8.8.0 |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.migrations" text="migrations"/> | [apm_service_groups.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/server/saved_objects/apm_service_groups.ts#:~:text=migrations) | - |
| <DocLink id="kibKbnMlAnomalyUtilsPluginApi" section="def-common.getSeverityColor" text="getSeverityColor"/> | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/common/anomaly_detection/index.ts#:~:text=getSeverityColor), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/common/anomaly_detection/index.ts#:~:text=getSeverityColor), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/apm/common/anomaly_detection/index.ts#:~:text=getSeverityColor) | - |
@ -438,7 +439,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginStart.authc" text="authc"/> | [setup_routes.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_security_posture/server/routes/setup_routes.ts#:~:text=authc), [setup_routes.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_security_posture/server/routes/setup_routes.ts#:~:text=authc) | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.migrations" text="migrations"/> | [csp_benchmark_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_security_posture/server/saved_objects/csp_benchmark_rule.ts#:~:text=migrations) | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.schemas" text="schemas"/> | [csp_benchmark_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_security_posture/server/saved_objects/csp_benchmark_rule.ts#:~:text=schemas), [csp_settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_security_posture/server/saved_objects/csp_settings.ts#:~:text=schemas) | - |
| <DocLink id="kibKbnUnifiedDataTablePluginApi" section="def-public.UnifiedDataTableProps.externalControlColumns" text="externalControlColumns"/> | [cloud_security_data_table.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_security_posture/public/components/cloud_security_data_table/cloud_security_data_table.tsx#:~:text=externalControlColumns) | - |
@ -970,6 +970,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SimpleSavedObject" text="SimpleSavedObject"/> | [kibana.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/common/types/kibana.ts#:~:text=SimpleSavedObject), [kibana.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/common/types/kibana.ts#:~:text=SimpleSavedObject) | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | [modules.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/common/types/modules.ts#:~:text=SavedObjectAttributes), [modules.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/common/types/modules.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.migrations" text="migrations"/> | [saved_objects.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/server/saved_objects/saved_objects.ts#:~:text=migrations), [saved_objects.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/server/saved_objects/saved_objects.ts#:~:text=migrations), [saved_objects.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/server/saved_objects/saved_objects.ts#:~:text=migrations) | - |
| <DocLink id="kibKbnMlAnomalyUtilsPluginApi" section="def-common.ML_SEVERITY_COLORS" text="ML_SEVERITY_COLORS"/> | [severity_control.tsx](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/public/application/components/severity_control/severity_control.tsx#:~:text=ML_SEVERITY_COLORS), [severity_control.tsx](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/public/application/components/severity_control/severity_control.tsx#:~:text=ML_SEVERITY_COLORS), [severity_control.tsx](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/public/application/components/severity_control/severity_control.tsx#:~:text=ML_SEVERITY_COLORS), [severity_control.tsx](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/public/application/components/severity_control/severity_control.tsx#:~:text=ML_SEVERITY_COLORS), [severity_control.tsx](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/public/application/components/severity_control/severity_control.tsx#:~:text=ML_SEVERITY_COLORS) | - |
| <DocLink id="kibKbnMlAnomalyUtilsPluginApi" section="def-common.getSeverityColor" text="getSeverityColor"/> | [render_cell_value.tsx](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/public/alerting/anomaly_detection_alerts_table/render_cell_value.tsx#:~:text=getSeverityColor), [render_cell_value.tsx](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/public/alerting/anomaly_detection_alerts_table/render_cell_value.tsx#:~:text=getSeverityColor), [anomaly_detection_alerts_state_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/public/application/explorer/alerts/anomaly_detection_alerts_state_service.ts#:~:text=getSeverityColor), [anomaly_detection_alerts_state_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/ml/public/application/explorer/alerts/anomaly_detection_alerts_state_service.ts#:~:text=getSeverityColor) | - |
@ -1233,7 +1235,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.create" text="create"/> | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/wrap_search_source_client.ts#:~:text=create) | - |
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/wrap_search_source_client.test.ts#:~:text=fetch) | - |
| <DocLink id="kibDataPluginApi" section="def-common.SavedObject.migrationVersion" text="migrationVersion"/> | [get_metrics.mocks.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/usage/detections/rules/get_metrics.mocks.ts#:~:text=migrationVersion), [get_metrics.mocks.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/usage/detections/rules/get_metrics.mocks.ts#:~:text=migrationVersion) | - |
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | [create_sourcerer_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/sourcerer/containers/create_sourcerer_data_view.ts#:~:text=title), [create_sourcerer_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/sourcerer/containers/create_sourcerer_data_view.ts#:~:text=title), [create_sourcerer_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/sourcerer/containers/create_sourcerer_data_view.ts#:~:text=title) | - |
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | [create_sourcerer_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/sourcerer/containers/create_sourcerer_data_view.ts#:~:text=title), [create_sourcerer_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/sourcerer/containers/create_sourcerer_data_view.ts#:~:text=title), [create_sourcerer_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/sourcerer/containers/create_sourcerer_data_view.ts#:~:text=title), [create_sourcerer_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/sourcerer/containers/create_sourcerer_data_view.ts#:~:text=title), [create_sourcerer_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/sourcerer/containers/create_sourcerer_data_view.ts#:~:text=title) | - |
| <DocLink id="kibDiscoverPluginApi" section="def-public.DiscoverStart.DiscoverContainer" text="DiscoverContainer"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/timelines/components/timeline/tabs/esql/index.tsx#:~:text=DiscoverContainer) | - |
| <DocLink id="kibFleetPluginApi" section="def-public.NewPackagePolicy.policy_id" text="policy_id"/> | [fleet_services.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts#:~:text=policy_id), [fleet_services.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts#:~:text=policy_id), [endpoint_metadata_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.test.ts#:~:text=policy_id), [endpoint_package_policies.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/endpoint/routes/metadata/support/endpoint_package_policies.test.ts#:~:text=policy_id), [index.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/management/pages/policy/store/policy_details/index.test.ts#:~:text=policy_id) | - |
| <DocLink id="kibFleetPluginApi" section="def-common.NewPackagePolicy.policy_id" text="policy_id"/> | [fleet_services.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts#:~:text=policy_id), [fleet_services.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts#:~:text=policy_id), [endpoint_metadata_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.test.ts#:~:text=policy_id), [endpoint_package_policies.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/endpoint/routes/metadata/support/endpoint_package_policies.test.ts#:~:text=policy_id), [index.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/management/pages/policy/store/policy_details/index.test.ts#:~:text=policy_id) | - |
@ -1278,7 +1280,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_ID" text="ENDPOINT_BLOCKLISTS_LIST_ID"/> | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/management/pages/blocklist/constants.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/management/pages/blocklist/constants.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [policy_hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/management/pages/policy/view/policy_hooks.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [policy_hooks.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/management/pages/policy/view/policy_hooks.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/scripts/endpoint/blocklists/index.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/scripts/endpoint/blocklists/index.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_ID) | - |
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_NAME" text="ENDPOINT_BLOCKLISTS_LIST_NAME"/> | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/management/pages/blocklist/constants.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_NAME), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/management/pages/blocklist/constants.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_NAME), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/scripts/endpoint/blocklists/index.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_NAME), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/scripts/endpoint/blocklists/index.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_NAME) | - |
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION" text="ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION"/> | [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/management/pages/blocklist/constants.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION), [constants.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/management/pages/blocklist/constants.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/scripts/endpoint/blocklists/index.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/scripts/endpoint/blocklists/index.ts#:~:text=ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION) | - |
| <DocLink id="kibKbnUnifiedDataTablePluginApi" section="def-public.UnifiedDataTableProps.externalControlColumns" text="externalControlColumns"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/timelines/components/timeline/unified_components/data_table/index.tsx#:~:text=externalControlColumns) | - |
@ -1364,6 +1365,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginStart.authc" text="authc"/> | [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [enablement.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/routes/synthetics_service/enablement.ts#:~:text=authc), [enablement.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/routes/synthetics_service/enablement.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc)+ 6 more | - |
| <DocLink id="kibTelemetryPluginApi" section="def-server.TelemetryPluginStart.getIsOptedIn" text="getIsOptedIn"/> | [sender.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/telemetry/sender.ts#:~:text=getIsOptedIn), [sender.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/telemetry/sender.test.ts#:~:text=getIsOptedIn), [sender.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/telemetry/sender.test.ts#:~:text=getIsOptedIn) | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.migrations" text="migrations"/> | [synthetics_monitor.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/saved_objects/synthetics_monitor.ts#:~:text=migrations) | - |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.type" text="type"/> | [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/e2e/synthetics/page_objects/utils.ts#:~:text=type), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/e2e/synthetics/page_objects/utils.ts#:~:text=type), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/e2e/synthetics/page_objects/utils.ts#:~:text=type) | - |
@ -1458,6 +1460,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| ---------------|-----------|-----------|
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | [filter_group.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/components/overview/filter_group/filter_group.tsx#:~:text=title), [filters_expression_select.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/components/overview/alerts/monitor_expressions/filters_expression_select.tsx#:~:text=title) | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.migrations" text="migrations"/> | [uptime_settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/server/legacy_uptime/lib/saved_objects/uptime_settings.ts#:~:text=migrations) | - |
| <DocLink id="kibKbnMlAnomalyUtilsPluginApi" section="def-common.getSeverityColor" text="getSeverityColor"/> | [duration_line_bar_list.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/components/common/charts/duration_line_bar_list.tsx#:~:text=getSeverityColor), [duration_line_bar_list.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/components/common/charts/duration_line_bar_list.tsx#:~:text=getSeverityColor), [duration_line_bar_list.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/components/common/charts/duration_line_bar_list.tsx#:~:text=getSeverityColor), [select_severity.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/components/overview/alerts/anomaly_alert/select_severity.tsx#:~:text=getSeverityColor), [select_severity.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/components/overview/alerts/anomaly_alert/select_severity.tsx#:~:text=getSeverityColor), [select_severity.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/components/overview/alerts/anomaly_alert/select_severity.tsx#:~:text=getSeverityColor), [select_severity.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/components/overview/alerts/anomaly_alert/select_severity.tsx#:~:text=getSeverityColor), [select_severity.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/components/overview/alerts/anomaly_alert/select_severity.tsx#:~:text=getSeverityColor), [anomaly_alert.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/components/overview/alerts/anomaly_alert/anomaly_alert.tsx#:~:text=getSeverityColor), [anomaly_alert.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/components/overview/alerts/anomaly_alert/anomaly_alert.tsx#:~:text=getSeverityColor) | - |
| <DocLink id="kibKbnTestJestHelpersPluginApi" section="def-common.shallowWithIntl" text="shallowWithIntl"/> | [enzyme_helpers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/lib/helper/enzyme_helpers.tsx#:~:text=shallowWithIntl), [enzyme_helpers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/lib/helper/enzyme_helpers.tsx#:~:text=shallowWithIntl), [enzyme_helpers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/lib/helper/enzyme_helpers.tsx#:~:text=shallowWithIntl) | - |
| <DocLink id="kibKbnTestJestHelpersPluginApi" section="def-common.mountWithIntl" text="mountWithIntl"/> | [enzyme_helpers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/lib/helper/enzyme_helpers.tsx#:~:text=mountWithIntl), [enzyme_helpers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/lib/helper/enzyme_helpers.tsx#:~:text=mountWithIntl), [enzyme_helpers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/lib/helper/enzyme_helpers.tsx#:~:text=mountWithIntl), [enzyme_helpers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/lib/helper/enzyme_helpers.tsx#:~:text=mountWithIntl) | - |
| <DocLink id="kibKbnTestJestHelpersPluginApi" section="def-common.renderWithI18nProvider" text="renderWithI18nProvider"/> | [enzyme_helpers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/lib/helper/enzyme_helpers.tsx#:~:text=renderWithI18nProvider), [enzyme_helpers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/lib/helper/enzyme_helpers.tsx#:~:text=renderWithI18nProvider), [enzyme_helpers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/lib/helper/enzyme_helpers.tsx#:~:text=renderWithI18nProvider), [enzyme_helpers.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/uptime/public/legacy_uptime/lib/helper/enzyme_helpers.tsx#:~:text=renderWithI18nProvider) | - |
@ -1477,6 +1480,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | [use_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/ux/public/components/app/rum_dashboard/local_uifilters/use_data_view.ts#:~:text=title) | - |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.type" text="type"/> | [date_picker.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/ux/e2e/page_objects/date_picker.ts#:~:text=type), [date_picker.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/ux/e2e/page_objects/date_picker.ts#:~:text=type), [date_picker.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/ux/e2e/page_objects/date_picker.ts#:~:text=type), [date_picker.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/ux/e2e/page_objects/date_picker.ts#:~:text=type), [date_picker.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/ux/e2e/page_objects/date_picker.ts#:~:text=type), [date_picker.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/ux/e2e/page_objects/date_picker.ts#:~:text=type) | - |

2
api_docs/deprecations_by_team.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-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.
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

2
api_docs/dev_tools.mdx
View file

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

52
api_docs/discover.devdocs.json
View file

@ -3059,9 +3059,9 @@
"OperatorFunction",
"<any, any>[]): ",
"Observable",
"<unknown>; }; operator: ",
"Operator",
"<any, ",
"<unknown>; }; observers: ",
"Observer",
"<",
{
"pluginId": "savedSearch",
"scope": "common",
@ -3069,7 +3069,7 @@
"section": "def-common.SavedSearch",
"text": "SavedSearch"
},
"> | undefined; lift: <R>(operator: ",
">[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
"Operator",
"<",
{
@ -3081,7 +3081,27 @@
},
", R>) => ",
"Observable",
"<R>; subscribe: { (observerOrNext?: Partial<",
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
"Observable",
"<",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
},
">; operator: ",
"Operator",
"<any, ",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
},
"> | undefined; subscribe: { (observerOrNext?: Partial<",
"Observer",
"<",
{
@ -3135,27 +3155,7 @@
"section": "def-common.SavedSearch",
"text": "SavedSearch"
},
" | undefined>; }; observers: ",
"Observer",
"<",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
},
">[]; isStopped: boolean; hasError: boolean; thrownError: any; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
"Observable",
"<",
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.SavedSearch",
"text": "SavedSearch"
},
">; }"
" | undefined>; }; }"
],
"path": "src/platform/plugins/shared/discover/public/embeddable/types.ts",
"deprecated": false,

2
api_docs/discover.mdx
View file

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

2
api_docs/discover_enhanced.mdx
View file

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

2
api_docs/discover_shared.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverShared
title: "discoverShared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discoverShared plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverShared']
---
import discoverSharedObj from './discover_shared.devdocs.json';

2
api_docs/ecs_data_quality_dashboard.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ecsDataQualityDashboard
title: "ecsDataQualityDashboard"
image: https://source.unsplash.com/400x175/?github
description: API docs for the ecsDataQualityDashboard plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
---
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';

2
api_docs/elastic_assistant.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/elasticAssistant
title: "elasticAssistant"
image: https://source.unsplash.com/400x175/?github
description: API docs for the elasticAssistant plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistant']
---
import elasticAssistantObj from './elastic_assistant.devdocs.json';

105
api_docs/elastic_assistant_shared_state.devdocs.json Normal file
View file

@ -0,0 +1,105 @@
{
"id": "elasticAssistantSharedState",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"start": {
"parentPluginId": "elasticAssistantSharedState",
"id": "def-public.ElasticAssistantSharedStatePublicPluginStart",
"type": "Type",
"tags": [],
"label": "ElasticAssistantSharedStatePublicPluginStart",
"description": [],
"signature": [
"{ comments: { registerActions: (actions: ",
{
"pluginId": "@kbn/elastic-assistant-shared-state",
"scope": "public",
"docId": "kibKbnElasticAssistantSharedStatePluginApi",
"section": "def-public.CommentServiceActions",
"text": "CommentServiceActions"
},
") => () => void; getActions$: () => ",
"Observable",
"<",
{
"pluginId": "@kbn/elastic-assistant-shared-state",
"scope": "public",
"docId": "kibKbnElasticAssistantSharedStatePluginApi",
"section": "def-public.CommentServiceActions",
"text": "CommentServiceActions"
},
"[]>; }; promptContexts: { setPromptContext: (promptContext: Record<string, ",
{
"pluginId": "@kbn/elastic-assistant",
"scope": "public",
"docId": "kibKbnElasticAssistantPluginApi",
"section": "def-public.PromptContextTemplate",
"text": "PromptContextTemplate"
},
">) => () => void; getPromptContext$: () => ",
"Observable",
"<Record<string, ",
{
"pluginId": "@kbn/elastic-assistant",
"scope": "public",
"docId": "kibKbnElasticAssistantPluginApi",
"section": "def-public.PromptContextTemplate",
"text": "PromptContextTemplate"
},
">>; }; assistantContextValue: { setAssistantContextValue: (assistantContextValue: ",
"UseAssistantContext",
") => () => void; getAssistantContextValue$: () => ",
"Observable",
"<",
"UseAssistantContext",
" | undefined>; }; augmentMessageCodeBlocks: { registerAugmentMessageCodeBlocks: (augmentMessageCodeBlocks: ",
{
"pluginId": "@kbn/elastic-assistant-shared-state",
"scope": "public",
"docId": "kibKbnElasticAssistantSharedStatePluginApi",
"section": "def-public.AugmentMessageCodeBlocks",
"text": "AugmentMessageCodeBlocks"
},
") => () => void; getAugmentMessageCodeBlocks$: () => ",
"Observable",
"<",
{
"pluginId": "@kbn/elastic-assistant-shared-state",
"scope": "public",
"docId": "kibKbnElasticAssistantSharedStatePluginApi",
"section": "def-public.AugmentMessageCodeBlocks",
"text": "AugmentMessageCodeBlocks"
},
">; }; signalIndex: { setSignalIndex: (signalIndex: string | undefined) => () => void; getSignalIndex$: () => ",
"Observable",
"<string | undefined>; }; }"
],
"path": "x-pack/solutions/security/plugins/elastic_assistant_shared_state/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

30
api_docs/elastic_assistant_shared_state.mdx Normal file
View file

@ -0,0 +1,30 @@
---
####
#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
#### Reach out in #docs-engineering for more info.
####
id: kibElasticAssistantSharedStatePluginApi
slug: /kibana-dev-docs/api/elasticAssistantSharedState
title: "elasticAssistantSharedState"
image: https://source.unsplash.com/400x175/?github
description: API docs for the elasticAssistantSharedState plugin
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistantSharedState']
---
import elasticAssistantSharedStateObj from './elastic_assistant_shared_state.devdocs.json';
Provides client side context for the Elastic AI Assistant
Contact [@elastic/security-generative-ai](https://github.com/orgs/elastic/teams/security-generative-ai) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 1 | 0 | 1 | 0 |
## Client
### Start
<DocDefinitionList data={[elasticAssistantSharedStateObj.client.start]}/>

2
api_docs/embeddable.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable
title: "embeddable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddable plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
---
import embeddableObj from './embeddable.devdocs.json';

2
api_docs/embeddable_alerts_table.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddableAlertsTable
title: "embeddableAlertsTable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddableAlertsTable plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableAlertsTable']
---
import embeddableAlertsTableObj from './embeddable_alerts_table.devdocs.json';

2
api_docs/embeddable_enhanced.mdx
View file

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

2
api_docs/encrypted_saved_objects.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects
title: "encryptedSavedObjects"
image: https://source.unsplash.com/400x175/?github
description: API docs for the encryptedSavedObjects plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
---
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';

2
api_docs/enterprise_search.mdx
View file

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

1404
api_docs/entity_manager.devdocs.json
View file

File diff suppressed because one or more lines are too long

18
api_docs/entity_manager.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/entityManager
title: "entityManager"
image: https://source.unsplash.com/400x175/?github
description: API docs for the entityManager plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'entityManager']
---
import entityManagerObj from './entity_manager.devdocs.json';
@ -21,21 +21,7 @@ Contact [@elastic/obs-entities](https://github.com/orgs/elastic/teams/obs-entiti
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 45 | 0 | 45 | 4 |
## Client
### Setup
<DocDefinitionList data={[entityManagerObj.client.setup]}/>
### Start
<DocDefinitionList data={[entityManagerObj.client.start]}/>
### Classes
<DocDefinitionList data={entityManagerObj.client.classes}/>
### Consts, variables and types
<DocDefinitionList data={entityManagerObj.client.misc}/>
| 7 | 0 | 7 | 2 |
## Server

2
api_docs/es_ui_shared.mdx
View file

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

2
api_docs/esql.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esql
title: "esql"
image: https://source.unsplash.com/400x175/?github
description: API docs for the esql plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esql']
---
import esqlObj from './esql.devdocs.json';

2
api_docs/esql_data_grid.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esqlDataGrid
title: "esqlDataGrid"
image: https://source.unsplash.com/400x175/?github
description: API docs for the esqlDataGrid plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esqlDataGrid']
---
import esqlDataGridObj from './esql_data_grid.devdocs.json';

2
api_docs/event_annotation.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation
title: "eventAnnotation"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventAnnotation plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
---
import eventAnnotationObj from './event_annotation.devdocs.json';

2
api_docs/event_annotation_listing.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotationListing
title: "eventAnnotationListing"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventAnnotationListing plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotationListing']
---
import eventAnnotationListingObj from './event_annotation_listing.devdocs.json';

8
api_docs/event_log.devdocs.json
View file

File diff suppressed because one or more lines are too long

2
api_docs/event_log.mdx
View file

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

2
api_docs/exploratory_view.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/exploratoryView
title: "exploratoryView"
image: https://source.unsplash.com/400x175/?github
description: API docs for the exploratoryView plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
---
import exploratoryViewObj from './exploratory_view.devdocs.json';

2
api_docs/expression_gauge.mdx
View file

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

2
api_docs/expression_heatmap.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap
title: "expressionHeatmap"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionHeatmap plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
---
import expressionHeatmapObj from './expression_heatmap.devdocs.json';

2
api_docs/expression_legacy_metric_vis.mdx
View file

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

2
api_docs/expression_metric_vis.mdx
View file

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

2
api_docs/expression_partition_vis.mdx
View file

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

2
api_docs/expression_tagcloud.mdx
View file

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

2
api_docs/expression_x_y.mdx
View file

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

2
api_docs/expressions.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions
title: "expressions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressions plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
---
import expressionsObj from './expressions.devdocs.json';

2
api_docs/features.mdx
View file

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

2
api_docs/field_formats.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats
title: "fieldFormats"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fieldFormats plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
---
import fieldFormatsObj from './field_formats.devdocs.json';

2
api_docs/fields_metadata.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldsMetadata
title: "fieldsMetadata"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fieldsMetadata plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldsMetadata']
---
import fieldsMetadataObj from './fields_metadata.devdocs.json';

2
api_docs/file_upload.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fileUpload
title: "fileUpload"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fileUpload plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
---
import fileUploadObj from './file_upload.devdocs.json';

2
api_docs/files.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/files
title: "files"
image: https://source.unsplash.com/400x175/?github
description: API docs for the files plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
---
import filesObj from './files.devdocs.json';

2
api_docs/files_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/filesManagement
title: "filesManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the filesManagement plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
---
import filesManagementObj from './files_management.devdocs.json';

32
api_docs/fleet.devdocs.json
View file

@ -2236,14 +2236,6 @@
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts"
},
{
"plugin": "synthetics",
"path": "x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/private_location/synthetics_private_location.ts"
@ -2260,6 +2252,14 @@
"plugin": "@kbn/test-suites-xpack-observability",
"path": "x-pack/solutions/observability/test/api_integration/apis/synthetics/sample_data/test_policy.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.test.ts"
@ -25650,14 +25650,6 @@
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts"
},
{
"plugin": "synthetics",
"path": "x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/private_location/synthetics_private_location.ts"
@ -25674,6 +25666,14 @@
"plugin": "@kbn/test-suites-xpack-observability",
"path": "x-pack/solutions/observability/test/api_integration/apis/synthetics/sample_data/test_policy.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.test.ts"

2
api_docs/fleet.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet
title: "fleet"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fleet plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
---
import fleetObj from './fleet.devdocs.json';

2
api_docs/global_search.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/globalSearch
title: "globalSearch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the globalSearch plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
---
import globalSearchObj from './global_search.devdocs.json';

2
api_docs/guided_onboarding.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/guidedOnboarding
title: "guidedOnboarding"
image: https://source.unsplash.com/400x175/?github
description: API docs for the guidedOnboarding plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
---
import guidedOnboardingObj from './guided_onboarding.devdocs.json';

2
api_docs/home.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/home
title: "home"
image: https://source.unsplash.com/400x175/?github
description: API docs for the home plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
---
import homeObj from './home.devdocs.json';

2
api_docs/image_embeddable.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/imageEmbeddable
title: "imageEmbeddable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the imageEmbeddable plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
---
import imageEmbeddableObj from './image_embeddable.devdocs.json';

2
api_docs/index_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexManagement
title: "indexManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexManagement plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
---
import indexManagementObj from './index_management.devdocs.json';

2
api_docs/inference.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inference
title: "inference"
image: https://source.unsplash.com/400x175/?github
description: API docs for the inference plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inference']
---
import inferenceObj from './inference.devdocs.json';

2
api_docs/inference_endpoint.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inferenceEndpoint
title: "inferenceEndpoint"
image: https://source.unsplash.com/400x175/?github
description: API docs for the inferenceEndpoint plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inferenceEndpoint']
---
import inferenceEndpointObj from './inference_endpoint.devdocs.json';

20
api_docs/infra.devdocs.json
View file

@ -260,26 +260,6 @@
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "infra",
"id": "def-server.InfraRequestHandlerContext.entityManager",
"type": "Object",
"tags": [],
"label": "entityManager",
"description": [],
"signature": [
{
"pluginId": "entityManager",
"scope": "server",
"docId": "kibEntityManagerPluginApi",
"section": "def-server.EntityManagerServerPluginStart",
"text": "EntityManagerServerPluginStart"
}
],
"path": "x-pack/solutions/observability/plugins/infra/server/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false

4
api_docs/infra.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/infra
title: "infra"
image: https://source.unsplash.com/400x175/?github
description: API docs for the infra plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
---
import infraObj from './infra.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 24 | 0 | 24 | 5 |
| 23 | 0 | 23 | 5 |
## Client

2
api_docs/ingest_pipelines.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ingestPipelines
title: "ingestPipelines"
image: https://source.unsplash.com/400x175/?github
description: API docs for the ingestPipelines plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ingestPipelines']
---
import ingestPipelinesObj from './ingest_pipelines.devdocs.json';

2
api_docs/inspector.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inspector
title: "inspector"
image: https://source.unsplash.com/400x175/?github
description: API docs for the inspector plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
---
import inspectorObj from './inspector.devdocs.json';

2
api_docs/interactive_setup.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/interactiveSetup
title: "interactiveSetup"
image: https://source.unsplash.com/400x175/?github
description: API docs for the interactiveSetup plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
---
import interactiveSetupObj from './interactive_setup.devdocs.json';

2
api_docs/intercepts.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/intercepts
title: "intercepts"
image: https://source.unsplash.com/400x175/?github
description: API docs for the intercepts plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'intercepts']
---
import interceptsObj from './intercepts.devdocs.json';

2
api_docs/kbn_actions_types.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-actions-types
title: "@kbn/actions-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/actions-types plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/actions-types']
---
import kbnActionsTypesObj from './kbn_actions_types.devdocs.json';

2
api_docs/kbn_ai_assistant.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ai-assistant
title: "@kbn/ai-assistant"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ai-assistant plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ai-assistant']
---
import kbnAiAssistantObj from './kbn_ai_assistant.devdocs.json';

2
api_docs/kbn_ai_assistant_common.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ai-assistant-common
title: "@kbn/ai-assistant-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ai-assistant-common plugin
date: 2025-06-24
date: 2025-06-25
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ai-assistant-common']
---
import kbnAiAssistantCommonObj from './kbn_ai_assistant_common.devdocs.json';

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