[api-docs] 2025-01-28 Daily api_docs build (#208478)

Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/966
This commit is contained in:
Kibana Machine 2025-01-28 18:10:28 +11:00 committed by GitHub
parent a1a0f1820a
commit 56d508fe33
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
820 changed files with 3667 additions and 1544 deletions

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
import actionsObj from './actions.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
---
import advancedSettingsObj from './advanced_settings.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection']
---
import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';

View file

@ -3002,7 +3002,7 @@
"label": "monitoring",
"description": [],
"signature": [
"Readonly<{} & { run: Readonly<{} & { history: Readonly<{ outcome?: \"warning\" | \"succeeded\" | \"failed\" | undefined; duration?: number | undefined; } & { timestamp: number; success: boolean; }>[]; calculated_metrics: Readonly<{ p50?: number | undefined; p95?: number | undefined; p99?: number | undefined; } & { success_ratio: number; }>; last_run: Readonly<{} & { timestamp: string; metrics: Readonly<{ duration?: number | undefined; total_search_duration_ms?: number | null | undefined; total_indexing_duration_ms?: number | null | undefined; total_alerts_detected?: number | null | undefined; total_alerts_created?: number | null | undefined; gap_duration_s?: number | null | undefined; } & {}>; }>; }>; }> | undefined"
"Readonly<{} & { run: Readonly<{} & { history: Readonly<{ outcome?: \"warning\" | \"succeeded\" | \"failed\" | undefined; duration?: number | undefined; } & { timestamp: number; success: boolean; }>[]; calculated_metrics: Readonly<{ p50?: number | undefined; p95?: number | undefined; p99?: number | undefined; } & { success_ratio: number; }>; last_run: Readonly<{} & { timestamp: string; metrics: Readonly<{ duration?: number | undefined; total_search_duration_ms?: number | null | undefined; total_indexing_duration_ms?: number | null | undefined; total_alerts_detected?: number | null | undefined; total_alerts_created?: number | null | undefined; gap_duration_s?: number | null | undefined; gap_range?: Readonly<{} & { gte: string; lte: string; }> | null | undefined; } & {}>; }>; }>; }> | undefined"
],
"path": "x-pack/platform/plugins/shared/alerting/server/application/rule/types/rule.ts",
"deprecated": false,
@ -8995,6 +8995,20 @@
"path": "x-pack/platform/plugins/shared/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleMonitoringLastRunMetrics.gap_range",
"type": "CompoundType",
"tags": [],
"label": "gap_range",
"description": [],
"signature": [
"{ lte: string; gte: string; } | null | undefined"
],
"path": "x-pack/platform/plugins/shared/alerting/common/rule.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false

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-01-27
date: 2025-01-28
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 |
|-------------------|-----------|------------------------|-----------------|
| 874 | 1 | 841 | 50 |
| 875 | 1 | 842 | 50 |
## Client

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
---
import apmDataAccessObj from './apm_data_access.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
---
import bannersObj from './banners.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
---
import canvasObj from './canvas.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
---
import casesObj from './cases.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
import chartsObj from './charts.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
---
import cloudObj from './cloud.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
---
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';

View file

@ -13,17 +13,7 @@
"\nGets the cloud_defend link properties of a Cloud Defend page for navigation in the security solution."
],
"signature": [
"<TId extends string = ",
{
"pluginId": "cloudDefend",
"scope": "public",
"docId": "kibCloudDefendPluginApi",
"section": "def-public.CloudDefendPageId",
"text": "CloudDefendPageId"
},
">(cloudDefendPage: ",
"CloudDefendPage",
") => CloudDefendLinkItem<TId>"
"<TId extends string = \"cloud_defend-policies\">(cloudDefendPage: \"policies\") => CloudDefendLinkItem<TId>"
],
"path": "x-pack/solutions/security/plugins/cloud_defend/public/common/navigation/security_solution_links.ts",
"deprecated": false,
@ -32,14 +22,14 @@
{
"parentPluginId": "cloudDefend",
"id": "def-public.getSecuritySolutionLink.$1",
"type": "CompoundType",
"type": "string",
"tags": [],
"label": "cloudDefendPage",
"description": [
"the name of the cloud defend page."
],
"signature": [
"CloudDefendPage"
"\"policies\""
],
"path": "x-pack/solutions/security/plugins/cloud_defend/public/common/navigation/security_solution_links.ts",
"deprecated": false,
@ -91,15 +81,7 @@
"Gets the `SpyRoute` component for navigation highlighting and breadcrumbs."
],
"signature": [
"() => React.ComponentType<{ pageName: ",
{
"pluginId": "cloudDefend",
"scope": "public",
"docId": "kibCloudDefendPluginApi",
"section": "def-public.CloudDefendPageId",
"text": "CloudDefendPageId"
},
"; state?: Record<string, string | undefined> | undefined; }>"
"() => React.ComponentType<{ pageName: \"cloud_defend-policies\"; state?: Record<string, string | undefined> | undefined; }>"
],
"path": "x-pack/solutions/security/plugins/cloud_defend/public/types.ts",
"deprecated": false,
@ -140,7 +122,7 @@
"\nAll the IDs for the cloud defend pages.\nThis needs to match the cloud defend page entries in `SecurityPageName` in `x-pack/solutions/security/plugins/security_solution/common/constants.ts`."
],
"signature": [
"\"cloud_defend-policies\" | \"kubernetes_security-dashboard\""
"\"cloud_defend-policies\""
],
"path": "x-pack/solutions/security/plugins/cloud_defend/public/common/navigation/types.ts",
"deprecated": false,

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: 2025-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
---
import cloudDefendObj from './cloud_defend.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-cloud-security-posture](https://github.com/orgs/elastic
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 52 | 0 | 43 | 2 |
| 52 | 0 | 43 | 1 |
## Client

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
---
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
---
import consoleObj from './console.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
---
import contentManagementObj from './content_management.devdocs.json';

View file

@ -1176,6 +1176,14 @@
"text": "PublishesDataViews"
},
" & ",
{
"pluginId": "@kbn/esql-variables-types",
"scope": "public",
"docId": "kibKbnEsqlVariablesTypesPluginApi",
"section": "def-public.PublishesESQLVariables",
"text": "PublishesESQLVariables"
},
" & ",
{
"pluginId": "@kbn/presentation-containers",
"scope": "public",
@ -1434,6 +1442,14 @@
"text": "PublishesDataViews"
},
" & ",
{
"pluginId": "@kbn/esql-variables-types",
"scope": "public",
"docId": "kibKbnEsqlVariablesTypesPluginApi",
"section": "def-public.PublishesESQLVariables",
"text": "PublishesESQLVariables"
},
" & ",
{
"pluginId": "@kbn/presentation-containers",
"scope": "public",
@ -1975,6 +1991,21 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-public.ESQL_CONTROL",
"type": "string",
"tags": [],
"label": "ESQL_CONTROL",
"description": [],
"signature": [
"\"esqlControl\""
],
"path": "src/platform/plugins/shared/controls/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-public.OPTIONS_LIST_CONTROL",
@ -3354,6 +3385,21 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-common.ESQL_CONTROL",
"type": "string",
"tags": [],
"label": "ESQL_CONTROL",
"description": [],
"signature": [
"\"esqlControl\""
],
"path": "src/platform/plugins/shared/controls/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-common.OPTIONS_LIST_CONTROL",

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-01-27
date: 2025-01-28
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 | 15 |
| 137 | 0 | 133 | 15 |
## Client

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
---
import customIntegrationsObj from './custom_integrations.devdocs.json';

View file

@ -840,6 +840,14 @@
"text": "PublishesSavedObjectId"
},
" & ",
{
"pluginId": "@kbn/esql-variables-types",
"scope": "public",
"docId": "kibKbnEsqlVariablesTypesPluginApi",
"section": "def-public.PublishesESQLVariables",
"text": "PublishesESQLVariables"
},
" & ",
"PublishesSearchSession",
" & ",
{

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
---
import dashboardObj from './dashboard.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
---
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
---
import dataObj from './data.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataQuality']
---
import dataQualityObj from './data_quality.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
---
import dataQueryObj from './data_query.devdocs.json';

View file

@ -39759,7 +39759,15 @@
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; disableWarningToasts?: boolean | undefined; }"
" | undefined; disableWarningToasts?: boolean | undefined; esqlVariables?: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLControlVariable",
"text": "ESQLControlVariable"
},
"[] | undefined; }"
],
"path": "src/platform/plugins/shared/data/common/search/expressions/remove_filter.ts",
"deprecated": false,
@ -40102,7 +40110,15 @@
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; disableWarningToasts?: boolean | undefined; }"
" | undefined; disableWarningToasts?: boolean | undefined; esqlVariables?: ",
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLControlVariable",
"text": "ESQLControlVariable"
},
"[] | undefined; }"
],
"path": "src/platform/plugins/shared/data/common/search/expressions/select_filter.ts",
"deprecated": false,

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
---
import dataSearchObj from './data_search.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataUsage']
---
import dataUsageObj from './data_usage.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
---
import dataViewEditorObj from './data_view_editor.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
---
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
---
import dataViewManagementObj from './data_view_management.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
---
import dataViewsObj from './data_views.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
---
import dataVisualizerObj from './data_visualizer.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality']
---
import datasetQualityObj from './dataset_quality.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -127,7 +127,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibSavedObjectsFinderPluginApi" section="def-public.SavedObjectMetaData.includeFields" text="includeFields"/> | visualizations, graph | - |
| <DocLink id="kibDiscoverPluginApi" section="def-common.DiscoverAppLocatorParams.indexPatternId" text="indexPatternId"/> | fleet, osquery, exploratoryView, synthetics | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.ApiActions.get" text="get"/> | @kbn/security-plugin-types-server, telemetry, fleet, profiling, @kbn/security-authorization-core, security | - |
| <DocLink id="kibTimelinesPluginApi" section="def-public.TimelinesUIStart.getHoverActions" text="getHoverActions"/> | kubernetesSecurity, osquery, threatIntelligence | - |
| <DocLink id="kibTimelinesPluginApi" section="def-public.TimelinesUIStart.getHoverActions" text="getHoverActions"/> | osquery, threatIntelligence | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.flattenHit" text="flattenHit"/> | dataViews, maps | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.removeScriptedField" text="removeScriptedField"/> | dataViews, dataViewManagement | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.getScriptedFields" text="getScriptedFields"/> | dataViews, dataViewManagement | - |

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -483,7 +483,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | [options_list_fetch_cache.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/public/controls/data_controls/options_list_control/options_list_fetch_cache.ts#:~:text=title) | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | [control_group_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/control_group/control_group_persistable_state.ts#:~:text=SavedObjectReference), [control_group_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/control_group/control_group_persistable_state.ts#:~:text=SavedObjectReference), [control_group_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/control_group/control_group_persistable_state.ts#:~:text=SavedObjectReference), [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [time_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/time_slider/time_slider_persistable_state.ts#:~:text=SavedObjectReference)+ 2 more | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | [control_group_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/control_group/control_group_persistable_state.ts#:~:text=SavedObjectReference), [control_group_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/control_group/control_group_persistable_state.ts#:~:text=SavedObjectReference), [control_group_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/control_group/control_group_persistable_state.ts#:~:text=SavedObjectReference), [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [time_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/time_slider/time_slider_persistable_state.ts#:~:text=SavedObjectReference)+ 5 more | - |
| <DocLink id="kibKbnPresentationPublishingPluginApi" section="def-public.apiHasSnapshottableState" text="apiHasSnapshottableState"/> | [init_controls_manager.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/public/control_group/init_controls_manager.ts#:~:text=apiHasSnapshottableState), [init_controls_manager.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/public/control_group/init_controls_manager.ts#:~:text=apiHasSnapshottableState) | - |
@ -663,7 +663,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.addTriggerAction" text="addTriggerAction"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/esql/public/plugin.ts#:~:text=addTriggerAction) | - |
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.addTriggerAction" text="addTriggerAction"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/esql/public/plugin.ts#:~:text=addTriggerAction), [plugin.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/esql/public/plugin.ts#:~:text=addTriggerAction) | - |
@ -871,14 +871,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
## kubernetesSecurity
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibTimelinesPluginApi" section="def-public.TimelinesUIStart.getHoverActions" text="getHoverActions"/> | [use_filter.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/kubernetes_security/public/hooks/use_filter.ts#:~:text=getHoverActions) | - |
## lens
| Deprecated API | Reference location(s) | Remove By |
@ -1013,7 +1005,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginStart.authc" text="authc"/> | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/observability_solution/observability_ai_assistant/server/service/index.ts#:~:text=authc), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/observability_solution/observability_ai_assistant/server/service/index.ts#:~:text=authc) | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginStart.authc" text="authc"/> | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/observability_ai_assistant/server/service/index.ts#:~:text=authc), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/observability_ai_assistant/server/service/index.ts#:~:text=authc) | - |

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
---
import devToolsObj from './dev_tools.devdocs.json';

View file

@ -3672,69 +3672,6 @@
"path": "src/platform/plugins/shared/discover/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverSetup.showInlineTopNav",
"type": "Function",
"tags": [],
"label": "showInlineTopNav",
"description": [],
"signature": [
"() => void"
],
"path": "src/platform/plugins/shared/discover/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverSetup.configureInlineTopNav",
"type": "Function",
"tags": [],
"label": "configureInlineTopNav",
"description": [],
"signature": [
"(projectNavId: string, options: { enabled: boolean; showLogsExplorerTabs: boolean; }) => void"
],
"path": "src/platform/plugins/shared/discover/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.DiscoverSetup.configureInlineTopNav.$1",
"type": "string",
"tags": [],
"label": "projectNavId",
"description": [],
"signature": [
"string"
],
"path": "src/platform/plugins/shared/discover/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverSetup.configureInlineTopNav.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ enabled: boolean; showLogsExplorerTabs: boolean; }"
],
"path": "src/platform/plugins/shared/discover/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "setup",

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
---
import discoverObj from './discover.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 211 | 0 | 164 | 30 |
| 207 | 0 | 160 | 30 |
## Client

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
---
import discoverEnhancedObj from './discover_enhanced.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverShared']
---
import discoverSharedObj from './discover_shared.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
---
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistant']
---
import elasticAssistantObj from './elastic_assistant.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
---
import embeddableObj from './embeddable.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
---
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
---
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
---
import enterpriseSearchObj from './enterprise_search.devdocs.json';

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: 2025-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'entitiesDataAccess']
---
import entitiesDataAccessObj from './entities_data_access.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'entityManager']
---
import entityManagerObj from './entity_manager.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
---
import esUiSharedObj from './es_ui_shared.devdocs.json';

View file

@ -52,6 +52,150 @@
}
],
"interfaces": [
{
"parentPluginId": "esql",
"id": "def-public.ESQLControlState",
"type": "Interface",
"tags": [],
"label": "ESQLControlState",
"description": [],
"path": "src/platform/plugins/shared/esql/public/triggers/esql_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "esql",
"id": "def-public.ESQLControlState.grow",
"type": "CompoundType",
"tags": [],
"label": "grow",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/platform/plugins/shared/esql/public/triggers/esql_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "esql",
"id": "def-public.ESQLControlState.width",
"type": "CompoundType",
"tags": [],
"label": "width",
"description": [],
"signature": [
"ControlWidthOptions",
" | undefined"
],
"path": "src/platform/plugins/shared/esql/public/triggers/esql_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "esql",
"id": "def-public.ESQLControlState.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/platform/plugins/shared/esql/public/triggers/esql_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "esql",
"id": "def-public.ESQLControlState.availableOptions",
"type": "Array",
"tags": [],
"label": "availableOptions",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/plugins/shared/esql/public/triggers/esql_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "esql",
"id": "def-public.ESQLControlState.selectedOptions",
"type": "Array",
"tags": [],
"label": "selectedOptions",
"description": [],
"signature": [
"string[]"
],
"path": "src/platform/plugins/shared/esql/public/triggers/esql_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "esql",
"id": "def-public.ESQLControlState.variableName",
"type": "string",
"tags": [],
"label": "variableName",
"description": [],
"path": "src/platform/plugins/shared/esql/public/triggers/esql_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "esql",
"id": "def-public.ESQLControlState.variableType",
"type": "Enum",
"tags": [],
"label": "variableType",
"description": [],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLVariableType",
"text": "ESQLVariableType"
}
],
"path": "src/platform/plugins/shared/esql/public/triggers/esql_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "esql",
"id": "def-public.ESQLControlState.esqlQuery",
"type": "string",
"tags": [],
"label": "esqlQuery",
"description": [],
"path": "src/platform/plugins/shared/esql/public/triggers/esql_controls/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "esql",
"id": "def-public.ESQLControlState.controlType",
"type": "Enum",
"tags": [],
"label": "controlType",
"description": [],
"signature": [
{
"pluginId": "esql",
"scope": "public",
"docId": "kibEsqlPluginApi",
"section": "def-public.EsqlControlType",
"text": "EsqlControlType"
}
],
"path": "src/platform/plugins/shared/esql/public/triggers/esql_controls/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "esql",
"id": "def-public.ESQLEditorProps",
@ -428,12 +572,131 @@
"path": "src/platform/packages/private/kbn-esql-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "esql",
"id": "def-public.ESQLEditorProps.supportsControls",
"type": "CompoundType",
"tags": [],
"label": "supportsControls",
"description": [
"The editor supports the creation of controls,\nThis flag should be set to true to display the \"Create control\" suggestion"
],
"signature": [
"boolean | undefined"
],
"path": "src/platform/packages/private/kbn-esql-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "esql",
"id": "def-public.ESQLEditorProps.onSaveControl",
"type": "Function",
"tags": [],
"label": "onSaveControl",
"description": [
"Function to be called after the control creation"
],
"signature": [
"((controlState: Record<string, unknown>, updatedQuery: string) => Promise<void>) | undefined"
],
"path": "src/platform/packages/private/kbn-esql-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "esql",
"id": "def-public.ESQLEditorProps.onSaveControl.$1",
"type": "Object",
"tags": [],
"label": "controlState",
"description": [],
"signature": [
"Record<string, unknown>"
],
"path": "src/platform/packages/private/kbn-esql-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "esql",
"id": "def-public.ESQLEditorProps.onSaveControl.$2",
"type": "string",
"tags": [],
"label": "updatedQuery",
"description": [],
"signature": [
"string"
],
"path": "src/platform/packages/private/kbn-esql-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "esql",
"id": "def-public.ESQLEditorProps.onCancelControl",
"type": "Function",
"tags": [],
"label": "onCancelControl",
"description": [
"Function to be called after cancelling the control creation"
],
"signature": [
"(() => void) | undefined"
],
"path": "src/platform/packages/private/kbn-esql-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "esql",
"id": "def-public.ESQLEditorProps.esqlVariables",
"type": "Array",
"tags": [],
"label": "esqlVariables",
"description": [
"The available ESQL variables from the page context this editor was opened in"
],
"signature": [
{
"pluginId": "@kbn/esql-validation-autocomplete",
"scope": "common",
"docId": "kibKbnEsqlValidationAutocompletePluginApi",
"section": "def-common.ESQLControlVariable",
"text": "ESQLControlVariable"
},
"[] | undefined"
],
"path": "src/platform/packages/private/kbn-esql-editor/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"enums": [
{
"parentPluginId": "esql",
"id": "def-public.EsqlControlType",
"type": "Enum",
"tags": [],
"label": "EsqlControlType",
"description": [],
"path": "src/platform/plugins/shared/esql/public/triggers/esql_controls/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"misc": [],
"objects": [],
"start": {
@ -470,6 +733,20 @@
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "esql",
"id": "def-public.EsqlPluginStart.variablesService",
"type": "Object",
"tags": [],
"label": "variablesService",
"description": [],
"signature": [
"EsqlVariablesService"
],
"path": "src/platform/plugins/shared/esql/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "start",

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esql']
---
import esqlObj from './esql.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 32 | 0 | 15 | 0 |
| 50 | 0 | 29 | 2 |
## Client
@ -34,6 +34,9 @@ Contact [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql
### Interfaces
<DocDefinitionList data={esqlObj.client.interfaces}/>
### Enums
<DocDefinitionList data={esqlObj.client.enums}/>
## Common
### Interfaces

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esqlDataGrid']
---
import esqlDataGridObj from './esql_data_grid.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
---
import eventAnnotationObj from './event_annotation.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotationListing']
---
import eventAnnotationListingObj from './event_annotation_listing.devdocs.json';

File diff suppressed because one or more lines are too long

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
---
import eventLogObj from './event_log.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
---
import exploratoryViewObj from './exploratory_view.devdocs.json';

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: 2025-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
---
import expressionErrorObj from './expression_error.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
---
import expressionGaugeObj from './expression_gauge.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
---
import expressionHeatmapObj from './expression_heatmap.devdocs.json';

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: 2025-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
---
import expressionImageObj from './expression_image.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
---
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';

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: 2025-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
---
import expressionMetricObj from './expression_metric.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
---
import expressionMetricVisObj from './expression_metric_vis.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
---
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';

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: 2025-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
---
import expressionRepeatImageObj from './expression_repeat_image.devdocs.json';

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: 2025-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
---
import expressionRevealImageObj from './expression_reveal_image.devdocs.json';

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: 2025-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
---
import expressionShapeObj from './expression_shape.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
---
import expressionTagcloudObj from './expression_tagcloud.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
---
import expressionXYObj from './expression_x_y.devdocs.json';

View file

@ -7050,6 +7050,20 @@
"path": "src/platform/plugins/shared/expressions/common/expression_types/specs/datatable.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressions",
"id": "def-public.DatatableColumn.variable",
"type": "string",
"tags": [],
"label": "variable",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/expressions/common/expression_types/specs/datatable.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -18444,6 +18458,20 @@
"path": "src/platform/plugins/shared/expressions/common/expression_types/specs/datatable.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressions",
"id": "def-server.DatatableColumn.variable",
"type": "string",
"tags": [],
"label": "variable",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/expressions/common/expression_types/specs/datatable.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -30297,6 +30325,20 @@
"path": "src/platform/plugins/shared/expressions/common/expression_types/specs/datatable.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressions",
"id": "def-common.DatatableColumn.variable",
"type": "string",
"tags": [],
"label": "variable",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/platform/plugins/shared/expressions/common/expression_types/specs/datatable.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
---
import expressionsObj from './expressions.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2241 | 17 | 1769 | 6 |
| 2244 | 17 | 1772 | 6 |
## Client

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
---
import featuresObj from './features.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
---
import fieldFormatsObj from './field_formats.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldsMetadata']
---
import fieldsMetadataObj from './fields_metadata.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
---
import fileUploadObj from './file_upload.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
---
import filesObj from './files.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
---
import filesManagementObj from './files_management.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
---
import fleetObj from './fleet.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
---
import globalSearchObj from './global_search.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
---
import guidedOnboardingObj from './guided_onboarding.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
---
import homeObj from './home.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
---
import imageEmbeddableObj from './image_embeddable.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
---
import indexManagementObj from './index_management.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inference']
---
import inferenceObj from './inference.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inferenceEndpoint']
---
import inferenceEndpointObj from './inference_endpoint.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
---
import infraObj from './infra.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ingestPipelines']
---
import ingestPipelinesObj from './ingest_pipelines.devdocs.json';

View file

@ -898,6 +898,20 @@
"path": "src/platform/plugins/shared/inspector/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "inspector",
"id": "def-public.InspectorOptions.flyoutType",
"type": "CompoundType",
"tags": [],
"label": "flyoutType",
"description": [],
"signature": [
"\"push\" | \"overlay\" | undefined"
],
"path": "src/platform/plugins/shared/inspector/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
---
import inspectorObj from './inspector.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 |
|-------------------|-----------|------------------------|-----------------|
| 127 | 2 | 100 | 4 |
| 128 | 2 | 101 | 4 |
## Client

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: 2025-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'integrationAssistant']
---
import integrationAssistantObj from './integration_assistant.devdocs.json';

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-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
---
import interactiveSetupObj from './interactive_setup.devdocs.json';

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: 2025-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inventory']
---
import inventoryObj from './inventory.devdocs.json';

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: 2025-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'investigate']
---
import investigateObj from './investigate.devdocs.json';

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: 2025-01-27
date: 2025-01-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'investigateApp']
---
import investigateAppObj from './investigate_app.devdocs.json';

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