github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[api-docs] 2024-11-10 Daily api_docs build (#199581)

Browse source 
Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/887
This commit is contained in:
Kibana Machine 2024-11-10 18:24:01 +11:00 • committed by GitHub
parent 9fdc04254d
commit 54b137052a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
767 changed files with 1233 additions and 1452 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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';

2
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.devdocs.json';

2
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.devdocs.json';

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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
---
import apmDataAccessObj from './apm_data_access.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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
---
import bannersObj from './banners.devdocs.json';

2
api_docs/bfetch.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/bfetch
title: "bfetch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the bfetch plugin
date: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
---
import bfetchObj from './bfetch.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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
---
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';

2
api_docs/cloud_defend.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDefend
title: "cloudDefend"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDefend plugin
date: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
---
import cloudDefendObj from './cloud_defend.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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
---
import consoleObj from './console.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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
---
import contentManagementObj from './content_management.devdocs.json';

284
api_docs/controls.devdocs.json
View file

@ -571,7 +571,7 @@
"label": "labelPosition",
"description": [],
"signature": [
"\"twoLine\" | \"oneLine\""
"\"oneLine\" | \"twoLine\""
],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,
@ -669,7 +669,7 @@
"section": "def-common.ControlGroupSerializedState",
"text": "ControlGroupSerializedState"
},
" extends Pick<",
" extends Omit<",
{
"pluginId": "controls",
"scope": "common",
@ -685,7 +685,7 @@
"section": "def-common.DefaultControlState",
"text": "DefaultControlState"
},
">, \"chainingSystem\" | \"editorConfig\">"
">, \"initialChildControlState\">"
],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,
@ -693,49 +693,21 @@
"children": [
{
"parentPluginId": "controls",
"id": "def-public.ControlGroupSerializedState.panelsJSON",
"type": "string",
"id": "def-public.ControlGroupSerializedState.controls",
"type": "Array",
"tags": [],
"label": "panelsJSON",
"description": [],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "controls",
"id": "def-public.ControlGroupSerializedState.ignoreParentSettingsJSON",
"type": "string",
"tags": [],
"label": "ignoreParentSettingsJSON",
"description": [],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "controls",
"id": "def-public.ControlGroupSerializedState.controlStyle",
"type": "CompoundType",
"tags": [],
"label": "controlStyle",
"label": "controls",
"description": [],
"signature": [
"\"twoLine\" | \"oneLine\""
],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "controls",
"id": "def-public.ControlGroupSerializedState.showApplySelections",
"type": "CompoundType",
"tags": [],
"label": "showApplySelections",
"description": [],
"signature": [
"boolean | undefined"
"(",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.DefaultControlState",
"text": "DefaultControlState"
},
" & { type: string; order: number; } & { id?: string | undefined; })[]"
],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,
@ -2438,20 +2410,14 @@
"functions": [
{
"parentPluginId": "controls",
"id": "def-server.controlGroupSerializedStateToSerializableRuntimeState",
"id": "def-server.controlGroupSavedObjectStateToSerializableRuntimeState",
"type": "Function",
"tags": [],
"label": "controlGroupSerializedStateToSerializableRuntimeState",
"label": "controlGroupSavedObjectStateToSerializableRuntimeState",
"description": [],
"signature": [
"(serializedState: ",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.ControlGroupSerializedState",
"text": "ControlGroupSerializedState"
},
"(savedObjectState: ",
"ControlGroupSavedObjectState",
") => ",
"SerializableControlGroupState"
],
@ -2461,19 +2427,13 @@
"children": [
{
"parentPluginId": "controls",
"id": "def-server.controlGroupSerializedStateToSerializableRuntimeState.$1",
"type": "Object",
"id": "def-server.controlGroupSavedObjectStateToSerializableRuntimeState.$1",
"type": "CompoundType",
"tags": [],
"label": "serializedState",
"label": "savedObjectState",
"description": [],
"signature": [
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.ControlGroupSerializedState",
"text": "ControlGroupSerializedState"
}
"ControlGroupSavedObjectState"
],
"path": "src/plugins/controls/server/control_group/control_group_persistence.ts",
"deprecated": false,
@ -2526,10 +2486,10 @@
},
{
"parentPluginId": "controls",
"id": "def-server.serializableRuntimeStateToControlGroupSerializedState",
"id": "def-server.serializableRuntimeStateToControlGroupSavedObjectState",
"type": "Function",
"tags": [],
"label": "serializableRuntimeStateToControlGroupSerializedState",
"label": "serializableRuntimeStateToControlGroupSavedObjectState",
"description": [],
"signature": [
"(serializable: ",
@ -2541,13 +2501,7 @@
"text": "SerializableRecord"
},
") => ",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.ControlGroupSerializedState",
"text": "ControlGroupSerializedState"
}
"ControlGroupSavedObjectState"
],
"path": "src/plugins/controls/server/control_group/control_group_persistence.ts",
"deprecated": false,
@ -2555,7 +2509,7 @@
"children": [
{
"parentPluginId": "controls",
"id": "def-server.serializableRuntimeStateToControlGroupSerializedState.$1",
"id": "def-server.serializableRuntimeStateToControlGroupSavedObjectState.$1",
"type": "Object",
"tags": [],
"label": "serializable",
@ -2587,7 +2541,7 @@
"tags": [],
"label": "ControlGroupTelemetry",
"description": [],
"path": "src/plugins/controls/server/control_group/control_group_telemetry.ts",
"path": "src/plugins/controls/server/control_group/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
@ -2598,7 +2552,7 @@
"tags": [],
"label": "total",
"description": [],
"path": "src/plugins/controls/server/control_group/control_group_telemetry.ts",
"path": "src/plugins/controls/server/control_group/types.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2612,7 +2566,7 @@
"signature": [
"{ [key: string]: number; }"
],
"path": "src/plugins/controls/server/control_group/control_group_telemetry.ts",
"path": "src/plugins/controls/server/control_group/types.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2626,7 +2580,7 @@
"signature": [
"{ [key: string]: number; }"
],
"path": "src/plugins/controls/server/control_group/control_group_telemetry.ts",
"path": "src/plugins/controls/server/control_group/types.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2640,7 +2594,7 @@
"signature": [
"{ [key: string]: number; }"
],
"path": "src/plugins/controls/server/control_group/control_group_telemetry.ts",
"path": "src/plugins/controls/server/control_group/types.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2654,7 +2608,7 @@
"signature": [
"{ [key: string]: { total: number; details: { [key: string]: number; }; }; }"
],
"path": "src/plugins/controls/server/control_group/control_group_telemetry.ts",
"path": "src/plugins/controls/server/control_group/types.ts",
"deprecated": false,
"trackAdoption": false
}
@ -2786,7 +2740,7 @@
"label": "labelPosition",
"description": [],
"signature": [
"\"twoLine\" | \"oneLine\""
"\"oneLine\" | \"twoLine\""
],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,
@ -2884,7 +2838,7 @@
"section": "def-common.ControlGroupSerializedState",
"text": "ControlGroupSerializedState"
},
" extends Pick<",
" extends Omit<",
{
"pluginId": "controls",
"scope": "common",
@ -2900,7 +2854,7 @@
"section": "def-common.DefaultControlState",
"text": "DefaultControlState"
},
">, \"chainingSystem\" | \"editorConfig\">"
">, \"initialChildControlState\">"
],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,
@ -2908,49 +2862,21 @@
"children": [
{
"parentPluginId": "controls",
"id": "def-common.ControlGroupSerializedState.panelsJSON",
"type": "string",
"id": "def-common.ControlGroupSerializedState.controls",
"type": "Array",
"tags": [],
"label": "panelsJSON",
"description": [],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "controls",
"id": "def-common.ControlGroupSerializedState.ignoreParentSettingsJSON",
"type": "string",
"tags": [],
"label": "ignoreParentSettingsJSON",
"description": [],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "controls",
"id": "def-common.ControlGroupSerializedState.controlStyle",
"type": "CompoundType",
"tags": [],
"label": "controlStyle",
"label": "controls",
"description": [],
"signature": [
"\"twoLine\" | \"oneLine\""
],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "controls",
"id": "def-common.ControlGroupSerializedState.showApplySelections",
"type": "CompoundType",
"tags": [],
"label": "showApplySelections",
"description": [],
"signature": [
"boolean | undefined"
"(",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.DefaultControlState",
"text": "DefaultControlState"
},
" & { type: string; order: number; } & { id?: string | undefined; })[]"
],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,
@ -3130,6 +3056,23 @@
"tags": [],
"label": "ParentIgnoreSettings",
"description": [],
"signature": [
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.ParentIgnoreSettings",
"text": "ParentIgnoreSettings"
},
" extends ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "src/plugins/controls/common/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -3290,7 +3233,7 @@
"label": "ControlLabelPosition",
"description": [],
"signature": [
"\"twoLine\" | \"oneLine\""
"\"oneLine\" | \"twoLine\""
],
"path": "src/plugins/controls/common/types.ts",
"deprecated": false,
@ -3327,6 +3270,36 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-common.DEFAULT_AUTO_APPLY_SELECTIONS",
"type": "boolean",
"tags": [],
"label": "DEFAULT_AUTO_APPLY_SELECTIONS",
"description": [],
"signature": [
"true"
],
"path": "src/plugins/controls/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-common.DEFAULT_CONTROL_CHAINING",
"type": "CompoundType",
"tags": [],
"label": "DEFAULT_CONTROL_CHAINING",
"description": [],
"signature": [
"\"NONE\" | \"HIERARCHICAL\""
],
"path": "src/plugins/controls/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-common.DEFAULT_CONTROL_GROW",
@ -3347,7 +3320,7 @@
"label": "DEFAULT_CONTROL_LABEL_POSITION",
"description": [],
"signature": [
"\"twoLine\" | \"oneLine\""
"\"oneLine\" | \"twoLine\""
],
"path": "src/plugins/controls/common/constants.ts",
"deprecated": false,
@ -3415,6 +3388,67 @@
"initialIsOpen": false
}
],
"objects": []
"objects": [
{
"parentPluginId": "controls",
"id": "def-common.CONTROL_CHAINING_OPTIONS",
"type": "Object",
"tags": [],
"label": "CONTROL_CHAINING_OPTIONS",
"description": [],
"signature": [
"{ readonly NONE: \"NONE\"; readonly HIERARCHICAL: \"HIERARCHICAL\"; }"
],
"path": "src/plugins/controls/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-common.CONTROL_LABEL_POSITION_OPTIONS",
"type": "Object",
"tags": [],
"label": "CONTROL_LABEL_POSITION_OPTIONS",
"description": [],
"signature": [
"{ readonly ONE_LINE: \"oneLine\"; readonly TWO_LINE: \"twoLine\"; }"
],
"path": "src/plugins/controls/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-common.CONTROL_WIDTH_OPTIONS",
"type": "Object",
"tags": [],
"label": "CONTROL_WIDTH_OPTIONS",
"description": [],
"signature": [
"{ readonly SMALL: \"small\"; readonly MEDIUM: \"medium\"; readonly LARGE: \"large\"; }"
],
"path": "src/plugins/controls/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-common.DEFAULT_IGNORE_PARENT_SETTINGS",
"type": "Object",
"tags": [],
"label": "DEFAULT_IGNORE_PARENT_SETTINGS",
"description": [],
"signature": [
"{ readonly ignoreFilters: false; readonly ignoreQuery: false; readonly ignoreTimerange: false; readonly ignoreValidations: false; }"
],
"path": "src/plugins/controls/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}

7
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
---
import controlsObj from './controls.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 |
|-------------------|-----------|------------------------|-----------------|
| 135 | 0 | 131 | 14 |
| 135 | 0 | 131 | 15 |
## Client
@ -47,6 +47,9 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
## Common
### Objects
<DocDefinitionList data={controlsObj.common.objects}/>
### Interfaces
<DocDefinitionList data={controlsObj.common.interfaces}/>

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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
---
import customIntegrationsObj from './custom_integrations.devdocs.json';

583
api_docs/dashboard.devdocs.json
View file

@ -763,22 +763,7 @@
"label": "hits",
"description": [],
"signature": [
{
"pluginId": "@kbn/content-management-utils",
"scope": "server",
"docId": "kibKbnContentManagementUtilsPluginApi",
"section": "def-server.SOWithMetadata",
"text": "SOWithMetadata"
},
"<",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardAttributes",
"text": "DashboardAttributes"
},
">[]"
"Readonly<{ error?: Readonly<{ metadata?: Readonly<{} & {}> | undefined; } & { error: string; message: string; statusCode: number; }> | undefined; version?: string | undefined; namespaces?: string[] | undefined; createdBy?: string | undefined; updatedBy?: string | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; managed?: boolean | undefined; originId?: string | undefined; } & { id: string; type: string; attributes: Readonly<{} & { title: string; description: string; timeRestore: boolean; }>; references: Readonly<{} & { id: string; type: string; name: string; }>[]; }>[]"
],
"path": "src/plugins/dashboard/public/services/dashboard_content_management_service/lib/find_dashboards.ts",
"deprecated": false,
@ -1300,15 +1285,7 @@
"section": "def-common.DashboardContainerInput",
"text": "DashboardContainerInput"
},
", \"executionContext\" | \"panels\" | \"controlGroupInput\">> & { dashboardId?: string | undefined; useHash?: boolean | undefined; preserveSavedFilters?: boolean | undefined; searchSessionId?: string | undefined; panels?: (",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
},
" & ",
", \"executionContext\" | \"panels\" | \"controlGroupInput\">> & { dashboardId?: string | undefined; useHash?: boolean | undefined; preserveSavedFilters?: boolean | undefined; searchSessionId?: string | undefined; panels?: (Omit<Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; } & { type: string; panelConfig: Readonly<{ version?: string | undefined; title?: string | undefined; description?: string | undefined; hidePanelTitles?: boolean | undefined; enhancements?: Record<string, any> | undefined; savedObjectId?: string | undefined; } & {}>; gridData: Readonly<{} & { i: string; y: number; w: number; h: number; x: number; }>; panelIndex: string; }>, \"panelConfig\"> & { panelConfig: Readonly<{ version?: string | undefined; title?: string | undefined; description?: string | undefined; hidePanelTitles?: boolean | undefined; enhancements?: Record<string, any> | undefined; savedObjectId?: string | undefined; } & {}> & { [key: string]: any; }; } & ",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
@ -1530,7 +1507,111 @@
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"misc": [
{
"parentPluginId": "dashboard",
"id": "def-server.DashboardAttributes",
"type": "Type",
"tags": [],
"label": "DashboardAttributes",
"description": [],
"signature": [
"Omit<Readonly<{ version?: number | undefined; refreshInterval?: Readonly<{ section?: number | undefined; display?: string | undefined; } & { value: number; pause: boolean; }> | undefined; timeFrom?: string | undefined; timeTo?: string | undefined; controlGroupInput?: Readonly<{ enhancements?: Record<string, any> | undefined; } & { chainingSystem: ",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.ControlGroupChainingSystem",
"text": "ControlGroupChainingSystem"
},
"; labelPosition: ",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.ControlLabelPosition",
"text": "ControlLabelPosition"
},
"; autoApplySelections: boolean; ignoreParentSettings: Readonly<{} & { ignoreFilters: boolean; ignoreQuery: boolean; ignoreTimerange: boolean; ignoreValidations: boolean; }>; controls: Readonly<{ controlConfig?: Record<string, any> | undefined; } & { id: string; type: string; order: number; grow: boolean; width: ",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.ControlWidth",
"text": "ControlWidth"
},
"; }>[]; }> | undefined; } & { options: Readonly<{} & { hidePanelTitles: boolean; syncTooltips: boolean; useMargins: boolean; syncColors: boolean; syncCursor: boolean; }>; title: string; description: string; kibanaSavedObjectMeta: Readonly<{ searchSource?: Readonly<{ type?: string | undefined; sort?: Record<string, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SortDirection",
"text": "SortDirection"
},
" | Readonly<{ format?: string | undefined; } & { order: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SortDirection",
"text": "SortDirection"
},
"; }> | Readonly<{ numeric_type?: \"date\" | \"date_nanos\" | \"long\" | \"double\" | undefined; } & { order: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SortDirection",
"text": "SortDirection"
},
"; }>>[] | undefined; filter?: Readonly<{ query?: Record<string, any> | undefined; $state?: Readonly<{} & { store: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"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; } & { type: string; panelConfig: Readonly<{ version?: string | undefined; title?: string | undefined; description?: string | undefined; hidePanelTitles?: boolean | undefined; enhancements?: Record<string, any> | undefined; savedObjectId?: string | undefined; } & {}>; gridData: Readonly<{} & { i: string; y: number; w: number; h: number; x: number; }>; panelIndex: string; }>[]; }>, \"panels\"> & { panels: ",
"DashboardPanel",
"[]; }"
],
"path": "src/plugins/dashboard/server/content_management/v3/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-server.DashboardAttributes",
"type": "Type",
"tags": [],
"label": "DashboardAttributes",
"description": [],
"signature": [
"{ readonly version?: number | undefined; readonly timeRestore?: boolean | undefined; readonly refreshInterval?: Readonly<{ section?: number | undefined; display?: string | undefined; } & { value: number; pause: boolean; }> | undefined; readonly hits?: number | undefined; readonly timeFrom?: string | undefined; readonly timeTo?: string | undefined; readonly controlGroupInput?: Readonly<{ chainingSystem?: string | undefined; panelsJSON?: string | undefined; controlStyle?: string | undefined; ignoreParentSettingsJSON?: string | undefined; showApplySelections?: boolean | undefined; } & {}> | undefined; readonly optionsJSON?: string | undefined; readonly title: string; readonly description: string; readonly kibanaSavedObjectMeta: Readonly<{ searchSourceJSON?: string | undefined; } & {}>; readonly panelsJSON: string; }"
],
"path": "src/plugins/dashboard/server/dashboard_saved_object/schema/v2/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-server.PUBLIC_API_PATH",
"type": "string",
"tags": [],
"label": "PUBLIC_API_PATH",
"description": [],
"signature": [
"\"/api/dashboards/dashboard\""
],
"path": "src/plugins/dashboard/server/api/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "dashboard",
@ -1566,10 +1647,10 @@
"functions": [
{
"parentPluginId": "dashboard",
"id": "def-common.convertPanelMapToSavedPanels",
"id": "def-common.convertPanelMapToPanelsArray",
"type": "Function",
"tags": [],
"label": "convertPanelMapToSavedPanels",
"label": "convertPanelMapToPanelsArray",
"description": [],
"signature": [
"(panels: ",
@ -1580,15 +1661,15 @@
"section": "def-common.DashboardPanelMap",
"text": "DashboardPanelMap"
},
", removeLegacyVersion?: boolean | undefined) => ",
", removeLegacyVersion?: boolean | undefined) => { panelRefName?: string | undefined; id?: string | undefined; title?: string | undefined; type: string; gridData: Readonly<{} & { i: string; y: number; w: number; h: number; x: number; }>; panelIndex: string; panelConfig: _.Omit<Partial<",
{
"pluginId": "dashboard",
"pluginId": "embeddable",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
"docId": "kibEmbeddablePluginApi",
"section": "def-common.SavedObjectEmbeddableInput",
"text": "SavedObjectEmbeddableInput"
},
"[]"
"> & { id: string; }, \"id\" | \"title\" | \"savedObjectId\">; version?: string | undefined; }[]"
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
@ -1596,7 +1677,7 @@
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.convertPanelMapToSavedPanels.$1",
"id": "def-common.convertPanelMapToPanelsArray.$1",
"type": "Object",
"tags": [],
"label": "panels",
@ -1617,7 +1698,7 @@
},
{
"parentPluginId": "dashboard",
"id": "def-common.convertPanelMapToSavedPanels.$2",
"id": "def-common.convertPanelMapToPanelsArray.$2",
"type": "CompoundType",
"tags": [],
"label": "removeLegacyVersion",
@ -1636,161 +1717,14 @@
},
{
"parentPluginId": "dashboard",
"id": "def-common.convertPanelStateToSavedDashboardPanel",
"id": "def-common.convertPanelsArrayToPanelMap",
"type": "Function",
"tags": [],
"label": "convertPanelStateToSavedDashboardPanel",
"description": [],
"signature": [
"(panelState: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "DashboardPanelState"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.SavedObjectEmbeddableInput",
"text": "SavedObjectEmbeddableInput"
},
">, removeLegacyVersion: boolean | undefined) => ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
}
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.convertPanelStateToSavedDashboardPanel.$1",
"type": "Object",
"tags": [],
"label": "panelState",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "DashboardPanelState"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.SavedObjectEmbeddableInput",
"text": "SavedObjectEmbeddableInput"
},
">"
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "dashboard",
"id": "def-common.convertPanelStateToSavedDashboardPanel.$2",
"type": "CompoundType",
"tags": [],
"label": "removeLegacyVersion",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.convertSavedDashboardPanelToPanelState",
"type": "Function",
"tags": [],
"label": "convertSavedDashboardPanelToPanelState",
"description": [],
"signature": [
"(savedDashboardPanel: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
},
") => ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelState",
"text": "DashboardPanelState"
},
"<TEmbeddableInput>"
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.convertSavedDashboardPanelToPanelState.$1",
"type": "Object",
"tags": [],
"label": "savedDashboardPanel",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
}
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.convertSavedPanelsToPanelMap",
"type": "Function",
"tags": [],
"label": "convertSavedPanelsToPanelMap",
"label": "convertPanelsArrayToPanelMap",
"description": [],
"signature": [
"(panels?: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
},
"DashboardPanel",
"[] | undefined) => ",
{
"pluginId": "dashboard",
@ -1806,19 +1740,13 @@
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.convertSavedPanelsToPanelMap.$1",
"id": "def-common.convertPanelsArrayToPanelMap.$1",
"type": "Array",
"tags": [],
"label": "panels",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
},
"DashboardPanel",
"[] | undefined"
],
"path": "src/plugins/dashboard/common/lib/dashboard_panel_converters.ts",
@ -1982,7 +1910,13 @@
"({ attributes, references = [] }: ",
"DashboardAttributesAndReferences",
", deps: ",
"InjectExtractDeps",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.InjectExtractDeps",
"text": "InjectExtractDeps"
},
") => ",
"DashboardAttributesAndReferences"
],
@ -2013,7 +1947,13 @@
"label": "deps",
"description": [],
"signature": [
"InjectExtractDeps"
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.InjectExtractDeps",
"text": "InjectExtractDeps"
}
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts",
"deprecated": false,
@ -2035,13 +1975,19 @@
"({ attributes, references = [] }: ",
"DashboardAttributesAndReferences",
", deps: ",
"InjectExtractDeps",
") => ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardAttributes",
"section": "def-common.InjectExtractDeps",
"text": "InjectExtractDeps"
},
") => ",
{
"pluginId": "dashboard",
"scope": "server",
"docId": "kibDashboardPluginApi",
"section": "def-server.DashboardAttributes",
"text": "DashboardAttributes"
}
],
@ -2072,7 +2018,13 @@
"label": "deps",
"description": [],
"signature": [
"InjectExtractDeps"
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.InjectExtractDeps",
"text": "InjectExtractDeps"
}
],
"path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts",
"deprecated": false,
@ -2517,75 +2469,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardOptions",
"type": "Interface",
"tags": [],
"label": "DashboardOptions",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardOptions.hidePanelTitles",
"type": "boolean",
"tags": [],
"label": "hidePanelTitles",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardOptions.useMargins",
"type": "boolean",
"tags": [],
"label": "useMargins",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardOptions.syncColors",
"type": "boolean",
"tags": [],
"label": "syncColors",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardOptions.syncTooltips",
"type": "boolean",
"tags": [],
"label": "syncTooltips",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardOptions.syncCursor",
"type": "boolean",
"tags": [],
"label": "syncCursor",
"description": [],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardPanelMap",
@ -2667,7 +2550,7 @@
"label": "gridData",
"description": [],
"signature": [
"GridData"
"{ readonly i: string; readonly y: number; readonly w: number; readonly h: number; readonly x: number; }"
],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
"deprecated": false,
@ -2731,130 +2614,41 @@
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel",
"id": "def-common.InjectExtractDeps",
"type": "Interface",
"tags": [],
"label": "SavedDashboardPanel",
"description": [
"\nA saved dashboard panel parsed directly from the Dashboard Attributes panels JSON"
],
"path": "src/plugins/dashboard/common/content_management/v1/types.ts",
"label": "InjectExtractDeps",
"description": [],
"path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.embeddableConfig",
"id": "def-common.InjectExtractDeps.embeddablePersistableStateService",
"type": "Object",
"tags": [],
"label": "embeddableConfig",
"label": "embeddablePersistableStateService",
"description": [],
"signature": [
"{ [key: string]: ",
{
"pluginId": "@kbn/utility-types",
"pluginId": "kibanaUtils",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.Serializable",
"text": "Serializable"
"docId": "kibKibanaUtilsPluginApi",
"section": "def-common.PersistableStateService",
"text": "PersistableStateService"
},
"; }"
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableStateWithType",
"text": "EmbeddableStateWithType"
},
">"
],
"path": "src/plugins/dashboard/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "src/plugins/dashboard/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.panelRefName",
"type": "string",
"tags": [],
"label": "panelRefName",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.gridData",
"type": "Object",
"tags": [],
"label": "gridData",
"description": [],
"signature": [
"GridData"
],
"path": "src/plugins/dashboard/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.panelIndex",
"type": "string",
"tags": [],
"label": "panelIndex",
"description": [],
"path": "src/plugins/dashboard/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/content_management/v1/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.SavedDashboardPanel.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. (embeddableConfig in this type)."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/dashboard/common/content_management/v1/types.ts",
"path": "src/plugins/dashboard/common/dashboard_saved_object/persistable_state/dashboard_saved_object_references.ts",
"deprecated": false,
"trackAdoption": false
}
@ -2864,29 +2658,6 @@
],
"enums": [],
"misc": [
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardAttributes",
"type": "Type",
"tags": [],
"label": "DashboardAttributes",
"description": [],
"signature": [
"Omit<",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardAttributes",
"text": "DashboardAttributes"
},
", \"controlGroupInput\"> & { controlGroupInput?: ControlGroupAttributesV2 | undefined; }"
],
"path": "src/plugins/dashboard/common/content_management/v2/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-common.DashboardContainerByReferenceInput",
@ -2975,13 +2746,7 @@
"text": "SerializableRecord"
},
" | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; panels?: ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.SavedDashboardPanel",
"text": "SavedDashboardPanel"
},
"DashboardPanel",
"[] | undefined; }"
],
"path": "src/plugins/dashboard/common/types.ts",

7
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: 2024-11-08
date: 2024-11-10
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 |
|-------------------|-----------|------------------------|-----------------|
| 130 | 0 | 125 | 14 |
| 114 | 0 | 111 | 13 |
## Client
@ -51,6 +51,9 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
### Start
<DocDefinitionList data={[dashboardObj.server.start]}/>
### Consts, variables and types
<DocDefinitionList data={dashboardObj.server.misc}/>
## Common
### Objects

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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
---
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';

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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
---
import dataQueryObj from './data_query.devdocs.json';

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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
---
import dataViewManagementObj from './data_view_management.devdocs.json';

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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
---
import dataVisualizerObj from './data_visualizer.devdocs.json';

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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality']
---
import datasetQualityObj from './dataset_quality.devdocs.json';

10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -22,7 +22,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | actions, savedObjectsTagging, ml, enterpriseSearch | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SimpleSavedObject" text="SimpleSavedObject"/> | @kbn/core-saved-objects-browser-internal, @kbn/core, savedObjects, visualizations, aiops, dataVisualizer, ml, dashboardEnhanced, graph, lens, securitySolution, eventAnnotation, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | @kbn/core, embeddable, savedObjects, visualizations, canvas, graph, ml | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.migrations" text="migrations"/> | @kbn/core-saved-objects-base-server-internal, @kbn/core-saved-objects-migration-server-internal, @kbn/core-saved-objects-server-internal, @kbn/core-ui-settings-server-internal, @kbn/core-usage-data-server-internal, taskManager, dataViews, spaces, share, actions, data, alerting, @kbn/core-saved-objects-migration-server-mocks, lens, cases, savedSearch, canvas, fleet, cloudSecurityPosture, ml, logsShared, graph, lists, maps, infra, visualizations, apmDataAccess, securitySolution, apm, slo, synthetics, uptime, dashboard, eventAnnotation, links, savedObjectsManagement, @kbn/core-test-helpers-so-type-serializer, @kbn/core-saved-objects-api-server-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.migrations" text="migrations"/> | @kbn/core-saved-objects-base-server-internal, @kbn/core-saved-objects-migration-server-internal, @kbn/core-saved-objects-server-internal, @kbn/core-ui-settings-server-internal, @kbn/core-usage-data-server-internal, taskManager, dataViews, spaces, share, actions, data, alerting, dashboard, @kbn/core-saved-objects-migration-server-mocks, lens, cases, savedSearch, canvas, fleet, cloudSecurityPosture, ml, logsShared, graph, lists, maps, infra, visualizations, apmDataAccess, securitySolution, apm, slo, synthetics, uptime, eventAnnotation, links, savedObjectsManagement, @kbn/core-test-helpers-so-type-serializer, @kbn/core-saved-objects-api-server-internal | - |
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | graph, stackAlerts, inputControlVis, securitySolution | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | dataVisualizer, stackAlerts, expressionPartitionVis | - |
@ -49,7 +49,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnCoreSavedObjectsApiServerPluginApi" section="def-server.SavedObject.migrationVersion" text="migrationVersion"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server-internal, @kbn/core-saved-objects-import-export-server-internal, @kbn/core-saved-objects-server-internal, @kbn/core-saved-objects-browser-mocks, fleet, graph, lists, osquery, securitySolution, alerting | - |
| <DocLink id="kibKbnCoreSavedObjectsApiServerPluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | @kbn/core-saved-objects-common, @kbn/core-saved-objects-server, @kbn/core, @kbn/alerting-types, alerting, actions, savedSearch, canvas, enterpriseSearch, securitySolution, taskManager, @kbn/core-saved-objects-server-internal, @kbn/core-saved-objects-api-server | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObject" text="SavedObject"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, @kbn/core, savedObjectsTagging, home, canvas, savedObjects, savedObjectsTaggingOss, lists, securitySolution, upgradeAssistant, savedObjectsManagement, @kbn/core-saved-objects-import-export-server-internal, @kbn/core-saved-objects-browser-mocks, @kbn/core-ui-settings-server-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.convertToMultiNamespaceTypeVersion" text="convertToMultiNamespaceTypeVersion"/> | @kbn/core-saved-objects-migration-server-internal, dataViews, actions, data, alerting, lens, cases, savedSearch, canvas, savedObjectsTagging, graph, lists, maps, visualizations, securitySolution, dashboard, @kbn/core-test-helpers-so-type-serializer | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.convertToMultiNamespaceTypeVersion" text="convertToMultiNamespaceTypeVersion"/> | @kbn/core-saved-objects-migration-server-internal, dataViews, actions, data, alerting, dashboard, lens, cases, savedSearch, canvas, savedObjectsTagging, graph, lists, maps, visualizations, securitySolution, @kbn/core-test-helpers-so-type-serializer | - |
| <DocLink id="kibKbnEsqlAstPluginApi" section="def-common.ParseResult.ast" text="ast"/> | @kbn/esql-utils, @kbn/securitysolution-utils, securitySolution | - |
| <DocLink id="kibKbnSecurityPluginTypesPublicPluginApi" section="def-public.SecurityPluginStart.authc" text="authc"/> | security, securitySolution, cloudLinks, cases | - |
| <DocLink id="kibKbnSecurityPluginTypesPublicPluginApi" section="def-public.SecurityPluginStart.userProfiles" text="userProfiles"/> | security, cases, searchPlayground, securitySolution | - |
@ -70,7 +70,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginStart.authc" text="authc"/> | alerting, observabilityAIAssistant, fleet, cloudSecurityPosture, entityManager, apm, serverlessSearch, transform, upgradeAssistant, synthetics, security | - |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | actions, alerting | - |
| <DocLink id="kibDataPluginApi" section="def-public.syncQueryStateWithUrl" text="syncQueryStateWithUrl"/> | monitoring | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | @kbn/core-saved-objects-api-browser, @kbn/core, savedObjectsManagement, savedObjects, visualizations, savedObjectsTagging, eventAnnotation, lens, maps, graph, dashboard, kibanaUtils, expressions, data, savedObjectsTaggingOss, embeddable, uiActionsEnhanced, canvas, dashboardEnhanced, globalSearchProviders, controls | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | @kbn/core-saved-objects-api-browser, @kbn/core, savedObjectsManagement, savedObjects, visualizations, savedObjectsTagging, eventAnnotation, lens, maps, graph, dashboard, kibanaUtils, expressions, data, savedObjectsTaggingOss, embeddable, uiActionsEnhanced, controls, canvas, dashboardEnhanced, globalSearchProviders | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract" text="SavedObjectsClientContract"/> | @kbn/core-saved-objects-browser, @kbn/core-saved-objects-browser-internal, @kbn/core, home, savedObjects, visualizations, lens, visTypeTimeseries, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.create" text="create"/> | @kbn/core-saved-objects-browser-internal, savedObjects, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.bulkCreate" text="bulkCreate"/> | home, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-browser-internal | - |
@ -102,7 +102,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnCoreSavedObjectsApiServerPluginApi" section="def-server.SavedObjectsIncrementCounterOptions.migrationVersion" text="migrationVersion"/> | @kbn/core-saved-objects-api-server-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsApiServerPluginApi" section="def-server.SavedObjectsBulkCreateObject.migrationVersion" text="migrationVersion"/> | @kbn/core-saved-objects-api-server-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsApiServerPluginApi" section="def-server.SavedObjectsCreateOptions.migrationVersion" text="migrationVersion"/> | @kbn/core-saved-objects-api-server-internal, canvas | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.schemas" text="schemas"/> | @kbn/core-saved-objects-api-server-internal, @kbn/core-saved-objects-migration-server-internal, spaces, data, savedSearch, cloudSecurityPosture, visualizations, dashboard, @kbn/core-test-helpers-so-type-serializer | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.schemas" text="schemas"/> | @kbn/core-saved-objects-api-server-internal, @kbn/core-saved-objects-migration-server-internal, spaces, data, dashboard, savedSearch, cloudSecurityPosture, visualizations, @kbn/core-test-helpers-so-type-serializer | - |
| <DocLink id="kibKbnCoreSavedObjectsBrowserInternalPluginApi" section="def-public.SavedObjectsService" text="SavedObjectsService"/> | @kbn/core-root-browser-internal, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibDiscoverPluginApi" section="def-common.DiscoverAppLocatorParams.indexPatternId" text="indexPatternId"/> | fleet, exploratoryView, osquery, synthetics | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.ApiActions.get" text="get"/> | @kbn/security-plugin-types-server, telemetry, fleet, profiling, @kbn/security-authorization-core, security | - |

2
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
---
import devToolsObj from './dev_tools.devdocs.json';

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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistant']
---
import elasticAssistantObj from './elastic_assistant.devdocs.json';

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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
---
import embeddableObj from './embeddable.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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
---
import enterpriseSearchObj from './enterprise_search.devdocs.json';

2
api_docs/entities_data_access.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/entitiesDataAccess
title: "entitiesDataAccess"
image: https://source.unsplash.com/400x175/?github
description: API docs for the entitiesDataAccess plugin
date: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'entitiesDataAccess']
---
import entitiesDataAccessObj from './entities_data_access.devdocs.json';

2
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'entityManager']
---
import entityManagerObj from './entity_manager.devdocs.json';

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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotationListing']
---
import eventAnnotationListingObj from './event_annotation_listing.devdocs.json';

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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
---
import exploratoryViewObj from './exploratory_view.devdocs.json';

2
api_docs/expression_error.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionError
title: "expressionError"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionError plugin
date: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
---
import expressionErrorObj from './expression_error.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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
---
import expressionHeatmapObj from './expression_heatmap.devdocs.json';

2
api_docs/expression_image.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionImage
title: "expressionImage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionImage plugin
date: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
---
import expressionImageObj from './expression_image.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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
---
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';

2
api_docs/expression_metric.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetric
title: "expressionMetric"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetric plugin
date: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
---
import expressionMetricObj from './expression_metric.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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
---
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';

2
api_docs/expression_repeat_image.mdx
View file

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

2
api_docs/expression_reveal_image.mdx
View file

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

2
api_docs/expression_shape.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionShape
title: "expressionShape"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionShape plugin
date: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
---
import expressionShapeObj from './expression_shape.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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
---
import filesManagementObj from './files_management.devdocs.json';

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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
---
import imageEmbeddableObj from './image_embeddable.devdocs.json';

2
api_docs/index_lifecycle_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement
title: "indexLifecycleManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexLifecycleManagement plugin
date: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
---
import indexLifecycleManagementObj from './index_lifecycle_management.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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inference']
---
import inferenceObj from './inference.devdocs.json';

2
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
---
import infraObj from './infra.devdocs.json';

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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
---
import inspectorObj from './inspector.devdocs.json';

2
api_docs/integration_assistant.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/integrationAssistant
title: "integrationAssistant"
image: https://source.unsplash.com/400x175/?github
description: API docs for the integrationAssistant plugin
date: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'integrationAssistant']
---
import integrationAssistantObj from './integration_assistant.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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
---
import interactiveSetupObj from './interactive_setup.devdocs.json';

4
api_docs/inventory.devdocs.json
View file

@ -128,7 +128,9 @@
"LiteralC",
"<\"entity.type\">, ",
"LiteralC",
"<\"alertsCount\">]>; sortDirection: ",
"<\"alertsCount\">, ",
"LiteralC",
"<\"actions\">]>; sortDirection: ",
"UnionC",
"<[",
"LiteralC",

2
api_docs/inventory.mdx
View file

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

2
api_docs/investigate.mdx
View file

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

2
api_docs/investigate_app.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/investigateApp
title: "investigateApp"
image: https://source.unsplash.com/400x175/?github
description: API docs for the investigateApp plugin
date: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'investigateApp']
---
import investigateAppObj from './investigate_app.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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
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: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ai-assistant-common']
---
import kbnAiAssistantCommonObj from './kbn_ai_assistant_common.devdocs.json';

2
api_docs/kbn_aiops_components.mdx
View file

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

2
api_docs/kbn_aiops_log_pattern_analysis.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-log-pattern-analysis
title: "@kbn/aiops-log-pattern-analysis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/aiops-log-pattern-analysis plugin
date: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-log-pattern-analysis']
---
import kbnAiopsLogPatternAnalysisObj from './kbn_aiops_log_pattern_analysis.devdocs.json';

2
api_docs/kbn_aiops_log_rate_analysis.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-log-rate-analysis
title: "@kbn/aiops-log-rate-analysis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/aiops-log-rate-analysis plugin
date: 2024-11-08
date: 2024-11-10
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-log-rate-analysis']
---
import kbnAiopsLogRateAnalysisObj from './kbn_aiops_log_rate_analysis.devdocs.json';

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