[api-docs] 2025-06-24 Daily api_docs build (#224989)

Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/1113
This commit is contained in:
Kibana Machine 2025-06-24 08:10:32 +02:00 committed by GitHub
parent 9b5cf91062
commit 8771e7f18b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
876 changed files with 2368 additions and 2676 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-06-23
date: 2025-06-24
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-06-23
date: 2025-06-24
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-06-23
date: 2025-06-24
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-06-23
date: 2025-06-24
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';

View file

@ -1220,6 +1220,39 @@
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-server.shouldCreateAlertsInAllSpaces",
"type": "Function",
"tags": [],
"label": "shouldCreateAlertsInAllSpaces",
"description": [],
"signature": [
"({ ruleTypeId, ruleTypeAlertDef, logger, }: ShouldCreateAlertsInAllSpacesOpts) => boolean"
],
"path": "x-pack/platform/plugins/shared/alerting/server/alerts_client/lib/should_create_alerts_in_all_spaces.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-server.shouldCreateAlertsInAllSpaces.$1",
"type": "Object",
"tags": [],
"label": "{\n ruleTypeId,\n ruleTypeAlertDef,\n logger,\n}",
"description": [],
"signature": [
"ShouldCreateAlertsInAllSpacesOpts"
],
"path": "x-pack/platform/plugins/shared/alerting/server/alerts_client/lib/should_create_alerts_in_all_spaces.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
@ -2641,6 +2674,22 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.IRuleTypeAlerts.dangerouslyCreateAlertsInAllSpaces",
"type": "CompoundType",
"tags": [],
"label": "dangerouslyCreateAlertsInAllSpaces",
"description": [
"\nOptional flag to indicate that these alerts should not be space aware. When set\nto true, alerts for this rule type will be created with the `*` space id."
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/plugins/shared/alerting/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.IRuleTypeAlerts.secondaryAlias",
@ -4986,7 +5035,7 @@
"BulkFillGapsByRuleIdsOptions",
") => Promise<",
"BulkFillGapsByRuleIdsResult",
">; getRuleIdsWithGaps: (params: Readonly<{ statuses?: string[] | undefined; } & { start: string; end: string; }>) => Promise<Readonly<{} & { ruleIds: string[]; total: number; }>>; getGapsSummaryByRuleIds: (params: Readonly<{} & { start: string; end: string; ruleIds: string[]; }>) => Promise<Readonly<{} & { data: Readonly<{} & { ruleId: string; totalUnfilledDurationMs: number; totalInProgressDurationMs: number; totalFilledDurationMs: number; }>[]; }>>; }"
">; getRuleIdsWithGaps: (params: Readonly<{ statuses?: string[] | undefined; hasUnfilledIntervals?: boolean | undefined; hasInProgressIntervals?: boolean | undefined; hasFilledIntervals?: boolean | undefined; } & { start: string; end: string; }>) => Promise<Readonly<{ latestGapTimestamp?: number | undefined; } & { ruleIds: string[]; total: number; }>>; getGapsSummaryByRuleIds: (params: Readonly<{} & { start: string; end: string; ruleIds: string[]; }>) => Promise<Readonly<{} & { data: Readonly<{} & { ruleId: string; totalUnfilledDurationMs: number; totalInProgressDurationMs: number; totalFilledDurationMs: number; }>[]; }>>; }"
],
"path": "x-pack/platform/plugins/shared/alerting/server/index.ts",
"deprecated": 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-06-23
date: 2025-06-24
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 |
|-------------------|-----------|------------------------|-----------------|
| 912 | 1 | 877 | 57 |
| 915 | 1 | 879 | 57 |
## Client

View file

@ -8577,7 +8577,9 @@
"Type",
"<number, number, unknown>; durationMax: ",
"Type",
"<number, number, unknown>; }>, ",
"<number, number, unknown>; isOtel: ",
"BooleanC",
"; }>, ",
"TypeC",
"<{ environment: ",
"UnionC",

View file

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

View file

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

View file

@ -3403,21 +3403,6 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "charts",
"id": "def-common.LEGACY_TIME_AXIS",
"type": "string",
"tags": [],
"label": "LEGACY_TIME_AXIS",
"description": [],
"signature": [
"\"visualization:useLegacyTimeAxis\""
],
"path": "src/platform/plugins/shared/charts/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "charts",
"id": "def-common.paletteIds",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts
title: "charts"
image: https://source.unsplash.com/400x175/?github
description: API docs for the charts plugin
date: 2025-06-23
date: 2025-06-24
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
import chartsObj from './charts.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 |
|-------------------|-----------|------------------------|-----------------|
| 247 | 2 | 231 | 9 |
| 246 | 2 | 230 | 9 |
## Client

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -11597,10 +11597,6 @@
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "graph",
"path": "x-pack/platform/plugins/private/graph/public/plugin.ts"
},
{
"plugin": "stackAlerts",
"path": "x-pack/platform/plugins/shared/stack_alerts/public/rule_types/geo_containment/rule_form/data_view_select.tsx"
@ -11621,6 +11617,10 @@
"plugin": "stackAlerts",
"path": "x-pack/platform/plugins/shared/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx"
},
{
"plugin": "graph",
"path": "x-pack/platform/plugins/private/graph/public/plugin.ts"
},
{
"plugin": "inputControlVis",
"path": "src/platform/plugins/private/input_control_vis/public/control/list_control_factory.ts"

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data
title: "data"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data plugin
date: 2025-06-23
date: 2025-06-24
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
---
import dataObj from './data.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 |
|-------------------|-----------|------------------------|-----------------|
| 3260 | 31 | 2635 | 29 |
| 3258 | 31 | 2635 | 29 |
## Client

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataQuality
title: "dataQuality"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataQuality plugin
date: 2025-06-23
date: 2025-06-24
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-06-23
date: 2025-06-24
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
---
import dataQueryObj from './data_query.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 |
|-------------------|-----------|------------------------|-----------------|
| 3260 | 31 | 2635 | 29 |
| 3258 | 31 | 2635 | 29 |
## Client

View file

@ -7228,60 +7228,6 @@
"trackAdoption": false
}
]
},
{
"parentPluginId": "data",
"id": "def-common.AggType.Unnamed",
"type": "Function",
"tags": [
"class",
"private"
],
"label": "Constructor",
"description": [
"\nGeneric AggType Constructor\n\nUsed to create the values exposed by the agg_types module.\n"
],
"signature": [
"any"
],
"path": "src/platform/plugins/shared/data/common/search/aggs/agg_type.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.AggType.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "config",
"description": [
"- used to set the properties of the AggType"
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggTypeConfig",
"text": "AggTypeConfig"
},
"<TAggConfig, ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.AggParamType",
"text": "AggParamType"
},
"<TAggConfig>>"
],
"path": "src/platform/plugins/shared/data/common/search/aggs/agg_type.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": 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-06-23
date: 2025-06-24
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
---
import dataSearchObj from './data_search.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 |
|-------------------|-----------|------------------------|-----------------|
| 3260 | 31 | 2635 | 29 |
| 3258 | 31 | 2635 | 29 |
## Client

View file

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

View file

@ -13742,6 +13742,22 @@
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/public/applications/fleet/sections/agents/agent_details_page/components/agent_logs/query_bar.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/platform/plugins/shared/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/platform/plugins/shared/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/platform/plugins/shared/stack_alerts/public/rule_types/components/data_view_select_popover.tsx"
},
{
"plugin": "datasetQuality",
"path": "x-pack/platform/plugins/shared/dataset_quality/public/rule_types/degraded_docs/rule_form/rule_form.tsx"
},
{
"plugin": "graph",
"path": "x-pack/platform/plugins/private/graph/public/state_management/datasource.sagas.ts"
@ -13806,18 +13822,6 @@
"plugin": "exploratoryView",
"path": "x-pack/solutions/observability/plugins/exploratory_view/public/components/shared/exploratory_view/series_editor/columns/filter_value_btn.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/platform/plugins/shared/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/platform/plugins/shared/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/platform/plugins/shared/stack_alerts/public/rule_types/components/data_view_select_popover.tsx"
},
{
"plugin": "graph",
"path": "x-pack/platform/plugins/private/graph/public/state_management/datasource.test.ts"

View file

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

View file

@ -492,7 +492,33 @@
"label": "APIClientRequestParamsOf",
"description": [],
"signature": [
"{ \"GET /internal/dataset_quality/integrations/{integration}/dashboards\": ",
"{ \"GET /internal/dataset_quality/rule_types/degraded_docs/chart_preview\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/rule_types/degraded_docs/chart_preview\", ",
"TypeC",
"<{ query: ",
"TypeC",
"<{ index: ",
"StringC",
"; groupBy: ",
"Type",
"<string[], string, unknown>; start: ",
"StringC",
"; end: ",
"StringC",
"; interval: ",
"StringC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { series: { name: string; data: { x: number; y: number | null; }[]; }[]; totalGroups: number; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/integrations/{integration}/dashboards\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
@ -961,7 +987,33 @@
"label": "APIReturnType",
"description": [],
"signature": [
"{ \"GET /internal/dataset_quality/integrations/{integration}/dashboards\": ",
"{ \"GET /internal/dataset_quality/rule_types/degraded_docs/chart_preview\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /internal/dataset_quality/rule_types/degraded_docs/chart_preview\", ",
"TypeC",
"<{ query: ",
"TypeC",
"<{ index: ",
"StringC",
"; groupBy: ",
"Type",
"<string[], string, unknown>; start: ",
"StringC",
"; end: ",
"StringC",
"; interval: ",
"StringC",
"; }>; }>, ",
"DatasetQualityRouteHandlerResources",
", { series: { name: string; data: { x: number; y: number | null; }[]; }[]; totalGroups: number; }, ",
"DatasetQualityRouteCreateOptions",
">; \"GET /internal/dataset_quality/integrations/{integration}/dashboards\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/datasetQuality
title: "datasetQuality"
image: https://source.unsplash.com/400x175/?github
description: API docs for the datasetQuality plugin
date: 2025-06-23
date: 2025-06-24
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-06-23
date: 2025-06-24
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -18,7 +18,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| ---------------|-----------|-----------|
| <DocLink id="kibAlertingPluginApi" section="def-public.PluginSetupContract.registerNavigation" text="registerNavigation"/> | ml, stackAlerts | - |
| <DocLink id="kibCasesPluginApi" section="def-common.FEATURE_ID" text="FEATURE_ID"/> | ml | - |
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | data, @kbn/search-errors, savedObjectsManagement, unifiedSearch, @kbn/unified-field-list, controls, lens, @kbn/lens-embeddable-utils, triggersActionsUi, dataVisualizer, ml, canvas, fleet, graph, transform, @kbn/ml-data-view-utils, upgradeAssistant, securitySolution, timelines, exploratoryView, stackAlerts, maps, visTypeTimeseries, uptime, ux, enterpriseSearch, @kbn/cloud-security-posture-graph, eventAnnotationListing, inputControlVis, visDefaultEditor, dataViewManagement, visTypeTimelion, visTypeVega | - |
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | data, @kbn/search-errors, savedObjectsManagement, unifiedSearch, @kbn/unified-field-list, controls, lens, @kbn/lens-embeddable-utils, triggersActionsUi, dataVisualizer, ml, canvas, fleet, stackAlerts, datasetQuality, graph, transform, @kbn/ml-data-view-utils, upgradeAssistant, securitySolution, timelines, exploratoryView, maps, visTypeTimeseries, uptime, ux, enterpriseSearch, @kbn/cloud-security-posture-graph, eventAnnotationListing, inputControlVis, visDefaultEditor, dataViewManagement, visTypeTimelion, visTypeVega | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | ml, securitySolution | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | ml, savedObjectsTagging, actions | - |
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.registerAction" text="registerAction"/> | uiActionsEnhanced, ml, discover, imageEmbeddable, securitySolution | - |
@ -28,10 +28,10 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | @kbn/core, savedObjects, visualizations, canvas, graph, ml | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.migrations" text="migrations"/> | @kbn/core, taskManager, ml, spaces, dataViews, data, fleet, share, actions, alerting, apmSourcesAccess, dashboard, savedSearch, canvas, graph, lens, cases, maps, lists, securitySolution, apm, @kbn/test-suites-xpack-platform, visualizations, infra, slo, synthetics, uptime, cloudSecurityPosture, eventAnnotation, links, savedObjectsManagement | - |
| <DocLink id="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.indexPatterns" text="indexPatterns"/> | stackAlerts, graph, inputControlVis, securitySolution | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | dataVisualizer, stackAlerts, expressionPartitionVis | - |
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | - |
| <DocLink id="kibKbnEsqlAstPluginApi" section="def-common.parse" text="parse"/> | @kbn/esql-validation-autocomplete, @kbn/monaco, @kbn/esql-utils, inference, triggersActionsUi, discover, @kbn/securitysolution-utils, securitySolution, stackAlerts | - |
| <DocLink id="kibKbnEsqlAstPluginApi" section="def-common.parse" text="parse"/> | @kbn/esql-validation-autocomplete, @kbn/monaco, @kbn/esql-utils, inference, triggersActionsUi, discover, stackAlerts, @kbn/securitysolution-utils, securitySolution | - |
| <DocLink id="kibAlertingPluginApi" section="def-common.MaintenanceWindow" text="MaintenanceWindow"/> | @kbn/response-ops-alerts-table, triggersActionsUi | - |
| <DocLink id="kibManagementPluginApi" section="def-public.ManagementAppMountParams.theme$" text="theme$"/> | triggersActionsUi | - |
| <DocLink id="kibAlertingPluginApi" section="def-server.RuleExecutorServices.alertFactory" text="alertFactory"/> | ruleRegistry, securitySolution, @kbn/test-suites-xpack-platform, slo | - |
@ -83,7 +83,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | monitoring, observabilityShared | - |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | @kbn/core, management, fleet, security, kibanaOverview, @kbn/test-suites-src | - |
| <DocLink id="kibKbnCoreElasticsearchServerPluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | @kbn/core, observabilityOnboarding, enterpriseSearch, console | - |
| <DocLink id="kibKbnCoreLifecycleBrowserPluginApi" section="def-public.CoreStart.savedObjects" text="savedObjects"/> | @kbn/core, unifiedSearch, fileUpload, visualizations, transform, dashboardEnhanced, discover, dataVisualizer | - |
| <DocLink id="kibKbnCoreLifecycleBrowserPluginApi" section="def-public.CoreStart.savedObjects" text="savedObjects"/> | @kbn/core, unifiedSearch, fileUpload, visualizations, transform, dashboardEnhanced, dataVisualizer | - |
| <DocLink id="kibKbnCoreLoggingServerPluginApi" section="def-server.NumericRollingStrategyConfig.max" text="max"/> | @kbn/core, security | - |
| <DocLink id="kibKbnCorePluginsServerPluginApi" section="def-server.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> | @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract" text="SavedObjectsClientContract"/> | @kbn/core, visualizations, lens, visTypeTimeseries | - |
@ -94,7 +94,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.find" text="find"/> | @kbn/core, dashboardEnhanced | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.get" text="get"/> | @kbn/core, dashboardEnhanced | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.bulkGet" text="bulkGet"/> | @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.resolve" text="resolve"/> | @kbn/core, discover | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.resolve" text="resolve"/> | @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.bulkResolve" text="bulkResolve"/> | @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.update" text="update"/> | @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.bulkUpdate" text="bulkUpdate"/> | @kbn/core | - |
@ -107,7 +107,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsBatchResponse" text="SavedObjectsBatchResponse"/> | @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsFindOptions" text="SavedObjectsFindOptions"/> | @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsUpdateOptions" text="SavedObjectsUpdateOptions"/> | @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.ResolvedSimpleSavedObject" text="ResolvedSimpleSavedObject"/> | @kbn/core, spaces, savedSearch, visualizations, lens, maps, cases, canvas, graph | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.ResolvedSimpleSavedObject" text="ResolvedSimpleSavedObject"/> | @kbn/core, spaces, visualizations, lens, maps, cases, canvas, graph | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsBulkUpdateObject" text="SavedObjectsBulkUpdateObject"/> | @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsFindResponse" text="SavedObjectsFindResponse"/> | @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsBulkCreateOptions" text="SavedObjectsBulkCreateOptions"/> | @kbn/core | - |
@ -162,7 +162,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnTestJestHelpersPluginApi" section="def-common.shallowWithIntl" text="shallowWithIntl"/> | uptime, telemetry | - |
| <DocLink id="kibKbnTestJestHelpersPluginApi" section="def-common.mountWithIntl" text="mountWithIntl"/> | uptime | - |
| <DocLink id="kibKbnTestJestHelpersPluginApi" section="def-common.renderWithI18nProvider" text="renderWithI18nProvider"/> | uptime | - |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.type" text="type"/> | ux, synthetics | - |
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableSetup.registerEnhancement" text="registerEnhancement"/> | uiActionsEnhanced | - |
| <DocLink id="kibExpressionGaugePluginApi" section="def-common.GaugeState.percentageMode" text="percentageMode"/> | visTypeGauge | - |
| <DocLink id="kibExpressionPartitionVisPluginApi" section="def-common.LabelsParams.truncate" text="truncate"/> | visTypePie | - |
@ -266,6 +265,7 @@ Safe to remove.
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.setChecked.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.setInputFiles.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.tap.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.type" text="type"/> | @kbn/scout |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.type.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.uncheck.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout |
| <DocLink id="kibKbnScoutObltPluginApi" section="def-common.Locator.check.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-oblt |
@ -283,6 +283,7 @@ Safe to remove.
| <DocLink id="kibKbnScoutObltPluginApi" section="def-common.Locator.setChecked.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-oblt |
| <DocLink id="kibKbnScoutObltPluginApi" section="def-common.Locator.setInputFiles.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-oblt |
| <DocLink id="kibKbnScoutObltPluginApi" section="def-common.Locator.tap.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-oblt |
| <DocLink id="kibKbnScoutObltPluginApi" section="def-common.Locator.type" text="type"/> | @kbn/scout-oblt |
| <DocLink id="kibKbnScoutObltPluginApi" section="def-common.Locator.type.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-oblt |
| <DocLink id="kibKbnScoutObltPluginApi" section="def-common.Locator.uncheck.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-oblt |
| <DocLink id="kibKbnScoutSecurityPluginApi" section="def-common.Locator.check.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-security |
@ -300,6 +301,7 @@ Safe to remove.
| <DocLink id="kibKbnScoutSecurityPluginApi" section="def-common.Locator.setChecked.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-security |
| <DocLink id="kibKbnScoutSecurityPluginApi" section="def-common.Locator.setInputFiles.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-security |
| <DocLink id="kibKbnScoutSecurityPluginApi" section="def-common.Locator.tap.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-security |
| <DocLink id="kibKbnScoutSecurityPluginApi" section="def-common.Locator.type" text="type"/> | @kbn/scout-security |
| <DocLink id="kibKbnScoutSecurityPluginApi" section="def-common.Locator.type.$2.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-security |
| <DocLink id="kibKbnScoutSecurityPluginApi" section="def-common.Locator.uncheck.$1.noWaitAfter" text="noWaitAfter"/> | @kbn/scout-security |
| <DocLink id="kibKbnTestJestHelpersPluginApi" section="def-common.renderWithIntl" text="renderWithIntl"/> | @kbn/test-jest-helpers |

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
title: Deprecated API usage by plugin
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2025-06-23
date: 2025-06-24
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -580,6 +580,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | [rule_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/dataset_quality/public/rule_types/degraded_docs/rule_form/rule_form.tsx#:~:text=title) | - |
| <DocLink id="kibTelemetryPluginApi" section="def-server.TelemetryPluginStart.getIsOptedIn" text="getIsOptedIn"/> | [data_telemetry_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/dataset_quality/server/services/data_telemetry/data_telemetry_service.ts#:~:text=getIsOptedIn) | - |
@ -591,8 +592,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibSharePluginApi" section="def-public.ShareContext.shareableUrlForSavedObject" text="shareableUrlForSavedObject"/> | [get_share.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/discover/public/application/main/components/top_nav/app_menu_actions/get_share.tsx#:~:text=shareableUrlForSavedObject) | - |
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.registerAction" text="registerAction"/> | [use_additional_cell_actions.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/discover/public/context_awareness/hooks/use_additional_cell_actions.ts#:~:text=registerAction) | - |
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.executeTriggerActions" text="executeTriggerActions"/> | [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/discover/public/plugin.tsx#:~:text=executeTriggerActions) | - |
| <DocLink id="kibKbnCoreLifecycleBrowserPluginApi" section="def-public.CoreStart.savedObjects" text="savedObjects"/> | [discover_state.test.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/discover/public/application/main/state_management/discover_state.test.ts#:~:text=savedObjects) | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.resolve" text="resolve"/> | [discover_state.test.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/discover/public/application/main/state_management/discover_state.test.ts#:~:text=resolve) | - |
| <DocLink id="kibKbnCoreUiSettingsCommonPluginApi" section="def-common.UiSettingsParams.metric" text="metric"/> | [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/discover/server/ui_settings.ts#:~:text=metric), [ui_settings.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/discover/server/ui_settings.ts#:~:text=metric) | - |
| <DocLink id="kibKbnEsqlAstPluginApi" section="def-common.parse" text="parse"/> | [get_row_additional_leading_controls.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/discover/public/context_awareness/profile_providers/observability/logs_data_source_profile/accessors/get_row_additional_leading_controls.ts#:~:text=parse), [get_row_additional_leading_controls.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/discover/public/context_awareness/profile_providers/observability/logs_data_source_profile/accessors/get_row_additional_leading_controls.ts#:~:text=parse) | - |
@ -1161,7 +1160,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.ResolvedSimpleSavedObject" text="ResolvedSimpleSavedObject"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/saved_search/public/services/saved_searches/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/saved_search/public/services/saved_searches/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/saved_search/public/services/saved_searches/types.ts#:~:text=ResolvedSimpleSavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/saved_search/public/services/saved_searches/types.ts#:~:text=ResolvedSimpleSavedObject) | - |
| <DocLink id="kibKbnCoreSavedObjectsApiServerPluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes), [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes), [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes), [search_migrations.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/saved_search/server/saved_objects/search_migrations.ts#:~:text=SavedObjectAttributes) | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.migrations" text="migrations"/> | [search.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/saved_search/server/saved_objects/search.ts#:~:text=migrations) | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.schemas" text="schemas"/> | [search.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/saved_search/server/saved_objects/search.ts#:~:text=schemas) | - |
@ -1366,7 +1364,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginStart.authc" text="authc"/> | [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [enablement.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/routes/synthetics_service/enablement.ts#:~:text=authc), [enablement.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/routes/synthetics_service/enablement.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc), [get_api_key.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts#:~:text=authc)+ 6 more | - |
| <DocLink id="kibTelemetryPluginApi" section="def-server.TelemetryPluginStart.getIsOptedIn" text="getIsOptedIn"/> | [sender.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/telemetry/sender.ts#:~:text=getIsOptedIn), [sender.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/telemetry/sender.test.ts#:~:text=getIsOptedIn), [sender.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/telemetry/sender.test.ts#:~:text=getIsOptedIn) | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.migrations" text="migrations"/> | [synthetics_monitor.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/server/saved_objects/synthetics_monitor.ts#:~:text=migrations) | - |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.type" text="type"/> | [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/e2e/synthetics/page_objects/utils.ts#:~:text=type), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/e2e/synthetics/page_objects/utils.ts#:~:text=type), [utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/synthetics/e2e/synthetics/page_objects/utils.ts#:~:text=type) | - |
@ -1480,7 +1477,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | [use_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/ux/public/components/app/rum_dashboard/local_uifilters/use_data_view.ts#:~:text=title) | - |
| <DocLink id="kibKbnScoutPluginApi" section="def-common.Locator.type" text="type"/> | [date_picker.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/ux/e2e/page_objects/date_picker.ts#:~:text=type), [date_picker.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/ux/e2e/page_objects/date_picker.ts#:~:text=type), [date_picker.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/ux/e2e/page_objects/date_picker.ts#:~:text=type), [date_picker.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/ux/e2e/page_objects/date_picker.ts#:~:text=type), [date_picker.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/ux/e2e/page_objects/date_picker.ts#:~:text=type), [date_picker.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/observability/plugins/ux/e2e/page_objects/date_picker.ts#:~:text=type) | - |

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
title: Deprecated APIs due to be removed, by team
description: Lists the teams that are referencing deprecated APIs with a remove by date.
date: 2025-06-23
date: 2025-06-24
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-06-23
date: 2025-06-24
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
---
import devToolsObj from './dev_tools.devdocs.json';

View file

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

View file

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

View file

@ -1499,13 +1499,9 @@
"label": "createLlmInstance",
"description": [],
"signature": [
"(() => ",
"ActionsClientChatBedrockConverse",
" | ",
"ActionsClientChatOpenAI",
" | ",
"ActionsClientChatVertexAI",
") | undefined"
"(() => Promise<",
"AssistantToolLlm",
">) | undefined"
],
"path": "x-pack/solutions/security/plugins/elastic_assistant/server/types.ts",
"deprecated": false,

View file

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

View file

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

View file

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

View file

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

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventLog
title: "eventLog"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventLog plugin
date: 2025-06-23
date: 2025-06-24
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-06-23
date: 2025-06-24
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
---
import exploratoryViewObj from './exploratory_view.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-06-23
date: 2025-06-24
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-06-23
date: 2025-06-24
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
---
import expressionHeatmapObj from './expression_heatmap.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-06-23
date: 2025-06-24
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/expressionMetricVis
title: "expressionMetricVis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetricVis plugin
date: 2025-06-23
date: 2025-06-24
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-06-23
date: 2025-06-24
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/expressionTagcloud
title: "expressionTagcloud"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionTagcloud plugin
date: 2025-06-23
date: 2025-06-24
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-06-23
date: 2025-06-24
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
---
import expressionXYObj from './expression_x_y.devdocs.json';

View file

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

View file

@ -890,24 +890,6 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "features",
"id": "def-public.KibanaFeatureConfig.reserved",
"type": "Object",
"tags": [
"private"
],
"label": "reserved",
"description": [],
"signature": [
"{ description: string; privileges: readonly ",
"ReservedKibanaPrivilege",
"[]; } | undefined"
],
"path": "x-pack/platform/plugins/shared/features/common/kibana_feature.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "features",
"id": "def-public.KibanaFeatureConfig.hidden",
@ -3156,24 +3138,6 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "features",
"id": "def-server.KibanaFeatureConfig.reserved",
"type": "Object",
"tags": [
"private"
],
"label": "reserved",
"description": [],
"signature": [
"{ description: string; privileges: readonly ",
"ReservedKibanaPrivilege",
"[]; } | undefined"
],
"path": "x-pack/platform/plugins/shared/features/common/kibana_feature.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "features",
"id": "def-server.KibanaFeatureConfig.hidden",
@ -4775,24 +4739,6 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "features",
"id": "def-common.KibanaFeatureConfig.reserved",
"type": "Object",
"tags": [
"private"
],
"label": "reserved",
"description": [],
"signature": [
"{ description: string; privileges: readonly ",
"ReservedKibanaPrivilege",
"[]; } | undefined"
],
"path": "x-pack/platform/plugins/shared/features/common/kibana_feature.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "features",
"id": "def-common.KibanaFeatureConfig.hidden",

View file

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

View file

@ -1559,47 +1559,6 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fieldFormats",
"id": "def-common.FieldFormat.fieldType",
"type": "CompoundType",
"tags": [
"property",
"private"
],
"label": "fieldType",
"description": [],
"signature": [
"string | string[]"
],
"path": "src/platform/plugins/shared/field_formats/common/field_format.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fieldFormats",
"id": "def-common.FieldFormat.convertObject",
"type": "Object",
"tags": [
"property",
"private"
],
"label": "convertObject",
"description": [],
"signature": [
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FieldFormatConvert",
"text": "FieldFormatConvert"
},
" | undefined"
],
"path": "src/platform/plugins/shared/field_formats/common/field_format.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fieldFormats",
"id": "def-common.FieldFormat.htmlConvert",
@ -1648,30 +1607,6 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fieldFormats",
"id": "def-common.FieldFormat.type",
"type": "Object",
"tags": [
"property",
"private"
],
"label": "type",
"description": [],
"signature": [
"typeof ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FieldFormat",
"text": "FieldFormat"
}
],
"path": "src/platform/plugins/shared/field_formats/common/field_format.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fieldFormats",
"id": "def-common.FieldFormat.allowsNumericalAggregations",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats
title: "fieldFormats"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fieldFormats plugin
date: 2025-06-23
date: 2025-06-24
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
---
import fieldFormatsObj from './field_formats.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 |
|-------------------|-----------|------------------------|-----------------|
| 293 | 5 | 254 | 3 |
| 290 | 5 | 251 | 3 |
## Client

View file

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

View file

@ -11423,7 +11423,9 @@
"label": "getInstallation",
"description": [],
"signature": [
"(pkgName: string) => Promise<",
"(pkgName: string, savedObjectsClient?: ",
"SavedObjectsClientContract",
" | undefined) => Promise<",
{
"pluginId": "fleet",
"scope": "common",
@ -11451,6 +11453,22 @@
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fleet",
"id": "def-server.PackageClient.getInstallation.$2",
"type": "Object",
"tags": [],
"label": "savedObjectsClient",
"description": [],
"signature": [
"SavedObjectsClientContract",
" | undefined"
],
"path": "x-pack/platform/plugins/shared/fleet/server/services/epm/package_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
@ -31600,6 +31618,22 @@
}
],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-common.agentRouteService.postBulkMigrateAgents",
"type": "Function",
"tags": [],
"label": "postBulkMigrateAgents",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/platform/plugins/shared/fleet/common/services/routes.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet
title: "fleet"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fleet plugin
date: 2025-06-23
date: 2025-06-24
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
---
import fleetObj from './fleet.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) for questi
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 1558 | 5 | 1429 | 97 |
| 1560 | 5 | 1431 | 97 |
## Client

View file

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

View file

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

View file

@ -29,9 +29,15 @@
"label": "InterceptsStart",
"description": [],
"signature": [
"{ registerIntercept: ((intercept: ",
"InterceptWithoutRunId",
") => ",
"{ registerIntercept: ((intercept: { id: string; config: () => Promise<Omit<",
{
"pluginId": "intercepts",
"scope": "public",
"docId": "kibInterceptsPluginApi",
"section": "def-public.InterceptWithoutRunId",
"text": "InterceptWithoutRunId"
},
", \"id\">>; }) => ",
"Observable",
"<{ lastInteractedInterceptId: number; }>) | undefined; }"
],
@ -39,6 +45,21 @@
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "intercepts",
"id": "def-public.InterceptWithoutRunId",
"type": "Type",
"tags": [],
"label": "InterceptWithoutRunId",
"description": [],
"signature": [
"{ id: string; onProgress?: ((evt: InterceptProgressEvent) => void) | undefined; steps: [StartingInterceptStep, ...InterceptSteps[], CompletionInterceptStep]; onFinish: (evt: InterceptCompletionEvent) => void; onDismiss?: ((evt: InterceptDismissalEvent) => void) | undefined; }"
],
"path": "x-pack/platform/plugins/private/intercepts/public/prompter/service/intercept_dialog_api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []

View file

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

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

View file

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

View file

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

View file

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

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