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

[api-docs] 2025-03-12 Daily api_docs build (#214044)

Browse source 
Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/1009
This commit is contained in:
Kibana Machine 2025-03-12 17:09:30 +11:00 • committed by GitHub
parent 40dd061823
commit 727313938b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
833 changed files with 3158 additions and 2561 deletions
Download patch file Download diff file Expand all files Collapse all files

2
api_docs/actions.mdx
View file

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

2
api_docs/advanced_settings.mdx
View file

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

2
api_docs/ai_assistant_management_selection.mdx
View file

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

2
api_docs/aiops.mdx
View file

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

2
api_docs/alerting.mdx
View file

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

22
api_docs/apm.devdocs.json
View file

@ -34,7 +34,7 @@
"label": "ui",
"description": [],
"signature": [
"{ enabled: boolean; }"
"{ serviceMapApiV2Enabled: boolean; enabled: boolean; }"
],
"path": "x-pack/solutions/observability/plugins/apm/public/index.ts",
"deprecated": false,
@ -255,7 +255,7 @@
"APMPluginSetupDependencies",
") => { config$: ",
"Observable",
"<Readonly<{} & { enabled: boolean; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapMaxAllowableBytes: number; serviceMapTraceIdBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; serviceMapTerminateAfter: number; serviceMapMaxTraces: number; ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; searchAggregatedTransactions: ",
"<Readonly<{} & { enabled: boolean; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapMaxAllowableBytes: number; serviceMapTraceIdBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; serviceMapTerminateAfter: number; serviceMapMaxTraces: number; ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; serviceMapApiV2Enabled: boolean; }>; searchAggregatedTransactions: ",
"SearchAggregatedTransactionSetting",
"; telemetryCollectionEnabled: boolean; metricsInterval: number; forceSyntheticSource: boolean; latestAgentVersionsUrl: string; serverless: Readonly<{} & { enabled: true; }>; serverlessOnboarding: boolean; managedServiceUrl: string; featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; profilingIntegrationAvailable: boolean; ruleFormV2Enabled: boolean; }>; }>>; }"
],
@ -412,7 +412,7 @@
"label": "APMConfig",
"description": [],
"signature": [
"{ readonly enabled: boolean; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapMaxAllowableBytes: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly serviceMapTerminateAfter: number; readonly serviceMapMaxTraces: number; readonly ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; readonly searchAggregatedTransactions: ",
"{ readonly enabled: boolean; readonly agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; readonly autoCreateApmDataView: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapMaxAllowableBytes: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly serviceMapTerminateAfter: number; readonly serviceMapMaxTraces: number; readonly ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; serviceMapApiV2Enabled: boolean; }>; readonly searchAggregatedTransactions: ",
"SearchAggregatedTransactionSetting",
"; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly forceSyntheticSource: boolean; readonly latestAgentVersionsUrl: string; readonly serverless: Readonly<{} & { enabled: true; }>; readonly serverlessOnboarding: boolean; readonly managedServiceUrl: string; readonly featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; profilingIntegrationAvailable: boolean; ruleFormV2Enabled: boolean; }>; }"
],
@ -7879,7 +7879,9 @@
"StringC",
"; kuery: ",
"StringC",
"; }>, ",
"; useV2: ",
"Type",
"<boolean, boolean, unknown>; }>, ",
"TypeC",
"<{ environment: ",
"UnionC",
@ -7907,9 +7909,13 @@
"Type",
"<number, string, unknown>; }>]>; }>, ",
"APMRouteHandlerResources",
", ",
"ServiceMapResponse",
", ",
", Pick<",
"ServiceMapTelemetry",
", \"tracesCount\"> & (",
"ServiceMapRawResponse",
" | ",
"GroupResourceNodesResponse",
"), ",
"APMRouteCreateOptions",
">; \"GET /internal/apm/observability_overview/has_data\": ",
{
@ -8972,7 +8978,7 @@
"description": [],
"signature": [
"Observable",
"<Readonly<{} & { enabled: boolean; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapMaxAllowableBytes: number; serviceMapTraceIdBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; serviceMapTerminateAfter: number; serviceMapMaxTraces: number; ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; }>; searchAggregatedTransactions: ",
"<Readonly<{} & { enabled: boolean; agent: Readonly<{} & { migrations: Readonly<{} & { enabled: boolean; }>; }>; autoCreateApmDataView: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapMaxAllowableBytes: number; serviceMapTraceIdBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; serviceMapTerminateAfter: number; serviceMapMaxTraces: number; ui: Readonly<{} & { enabled: boolean; maxTraceItems: number; serviceMapApiV2Enabled: boolean; }>; searchAggregatedTransactions: ",
"SearchAggregatedTransactionSetting",
"; telemetryCollectionEnabled: boolean; metricsInterval: number; forceSyntheticSource: boolean; latestAgentVersionsUrl: string; serverless: Readonly<{} & { enabled: true; }>; serverlessOnboarding: boolean; managedServiceUrl: string; featureFlags: Readonly<{} & { agentConfigurationAvailable: boolean; configurableIndicesAvailable: boolean; infrastructureTabAvailable: boolean; infraUiAvailable: boolean; migrationToFleetAvailable: boolean; sourcemapApiAvailable: boolean; storageExplorerAvailable: boolean; profilingIntegrationAvailable: boolean; ruleFormV2Enabled: boolean; }>; }>>"
],

4
api_docs/apm.mdx
View file

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

2
api_docs/apm_data_access.mdx
View file

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

2
api_docs/automatic_import.mdx
View file

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

2
api_docs/banners.mdx
View file

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

2
api_docs/canvas.mdx
View file

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

2
api_docs/cases.mdx
View file

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

2
api_docs/charts.mdx
View file

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

2
api_docs/cloud.mdx
View file

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

2
api_docs/cloud_data_migration.mdx
View file

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

2
api_docs/cloud_security_posture.mdx
View file

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

2
api_docs/console.mdx
View file

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

2
api_docs/content_management.mdx
View file

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

2
api_docs/controls.mdx
View file

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

2
api_docs/custom_integrations.mdx
View file

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

2
api_docs/dashboard.mdx
View file

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

2
api_docs/dashboard_enhanced.mdx
View file

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

2
api_docs/data.mdx
View file

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

2
api_docs/data_quality.mdx
View file

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

2
api_docs/data_query.mdx
View file

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

2
api_docs/data_search.mdx
View file

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

2
api_docs/data_usage.mdx
View file

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

2
api_docs/data_view_editor.mdx
View file

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

2
api_docs/data_view_field_editor.mdx
View file

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

2
api_docs/data_view_management.mdx
View file

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

2
api_docs/data_views.mdx
View file

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

2
api_docs/data_visualizer.mdx
View file

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

2
api_docs/dataset_quality.mdx
View file

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

9
api_docs/deprecations_by_api.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
title: Deprecated API usage by API
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2025-03-11
date: 2025-03-12
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -23,7 +23,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | ml, securitySolution | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | actions, ml, savedObjectsTagging | - |
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.registerAction" text="registerAction"/> | unifiedSearch, uiActionsEnhanced, ml, discover, imageEmbeddable, securitySolution | - |
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.addTriggerAction" text="addTriggerAction"/> | data, lens, cases, ml, aiops, discover, reporting, discoverEnhanced, dashboardEnhanced, securitySolution, inputControlVis | - |
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.addTriggerAction" text="addTriggerAction"/> | data, lens, cases, ml, aiops, reporting, discoverEnhanced, dashboardEnhanced, securitySolution, inputControlVis | - |
| <DocLink id="kibKbnCoreHttpServerPluginApi" section="def-server.RouteConfigOptions.authRequired" text="authRequired"/> | @kbn/core, usageCollection, taskManager, security, monitoringCollection, files, banners, telemetry, securitySolution, @kbn/test-suites-xpack, cloudFullStory, customBranding, enterpriseSearch, interactiveSetup, mockIdpPlugin, spaces, ml | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SimpleSavedObject" text="SimpleSavedObject"/> | @kbn/core, visualizations, dataVisualizer, ml, aiops, graph, dashboardEnhanced, lens, securitySolution, eventAnnotation | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | @kbn/core, savedObjects, visualizations, canvas, graph, ml | - |
@ -41,8 +41,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibDataPluginApi" section="def-common.EqlSearchStrategyRequest.options" text="options"/> | securitySolution | - |
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.create" text="create"/> | alerting, securitySolution | - |
| <DocLink id="kibDataPluginApi" section="def-common.SavedObject.migrationVersion" text="migrationVersion"/> | @kbn/core, graph, fleet, osquery, alerting, lists, securitySolution | - |
| <DocLink id="kibFleetPluginApi" section="def-public.NewPackagePolicy.policy_id" text="policy_id"/> | securitySolution, synthetics, cloudDefend | - |
| <DocLink id="kibFleetPluginApi" section="def-common.NewPackagePolicy.policy_id" text="policy_id"/> | securitySolution, synthetics, cloudDefend | - |
| <DocLink id="kibDiscoverPluginApi" section="def-public.DiscoverStart.DiscoverContainer" text="DiscoverContainer"/> | securitySolution | - |
| <DocLink id="kibFleetPluginApi" section="def-public.NewPackagePolicy.policy_id" text="policy_id"/> | securitySolution, synthetics | - |
| <DocLink id="kibFleetPluginApi" section="def-common.NewPackagePolicy.policy_id" text="policy_id"/> | securitySolution, synthetics | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginStart.userProfiles" text="userProfiles"/> | cases, securitySolution, security | - |
| <DocLink id="kibTelemetryPluginApi" section="def-server.TelemetryPluginStart.getIsOptedIn" text="getIsOptedIn"/> | datasetQuality, fleet, securitySolution, synthetics | - |
| <DocLink id="kibTimelinesPluginApi" section="def-common.DeprecatedCellValueElementProps" text="DeprecatedCellValueElementProps"/> | @kbn/securitysolution-data-table, securitySolution | - |

13
api_docs/deprecations_by_plugin.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
title: Deprecated API usage by plugin
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2025-03-11
date: 2025-03-12
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -392,15 +392,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
## cloudDefend
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibFleetPluginApi" section="def-public.NewPackagePolicy.policy_id" text="policy_id"/> | [mocks.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_defend/public/test/mocks.ts#:~:text=policy_id), [mocks.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_defend/public/test/mocks.ts#:~:text=policy_id) | - |
| <DocLink id="kibFleetPluginApi" section="def-common.NewPackagePolicy.policy_id" text="policy_id"/> | [mocks.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_defend/public/test/mocks.ts#:~:text=policy_id), [mocks.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_defend/public/test/mocks.ts#:~:text=policy_id) | - |
## cloudFullStory
| Deprecated API | Reference location(s) | Remove By |
@ -565,7 +556,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="kibSharePluginApi" section="def-public.ShareContext.showPublicUrlSwitch" text="showPublicUrlSwitch"/> | [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=showPublicUrlSwitch) | - |
| <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.addTriggerAction" text="addTriggerAction"/> | [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/discover/public/plugin.tsx#:~:text=addTriggerAction) | - |
| <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) | - |
@ -1172,6 +1162,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/wrap_search_source_client.test.ts#:~:text=fetch) | - |
| <DocLink id="kibDataPluginApi" section="def-common.SavedObject.migrationVersion" text="migrationVersion"/> | [get_metrics.mocks.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/usage/detections/rules/get_metrics.mocks.ts#:~:text=migrationVersion), [get_metrics.mocks.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/usage/detections/rules/get_metrics.mocks.ts#:~:text=migrationVersion) | - |
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | [create_sourcerer_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/sourcerer/containers/create_sourcerer_data_view.ts#:~:text=title), [create_sourcerer_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/sourcerer/containers/create_sourcerer_data_view.ts#:~:text=title), [create_sourcerer_data_view.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/sourcerer/containers/create_sourcerer_data_view.ts#:~:text=title) | - |
| <DocLink id="kibDiscoverPluginApi" section="def-public.DiscoverStart.DiscoverContainer" text="DiscoverContainer"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/timelines/components/timeline/tabs/esql/index.tsx#:~:text=DiscoverContainer) | - |
| <DocLink id="kibFleetPluginApi" section="def-public.NewPackagePolicy.policy_id" text="policy_id"/> | [fleet_services.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts#:~:text=policy_id), [fleet_services.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts#:~:text=policy_id), [endpoint_metadata_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.test.ts#:~:text=policy_id), [endpoint_package_policies.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/endpoint/routes/metadata/support/endpoint_package_policies.test.ts#:~:text=policy_id), [index.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/management/pages/policy/store/policy_details/index.test.ts#:~:text=policy_id) | - |
| <DocLink id="kibFleetPluginApi" section="def-common.NewPackagePolicy.policy_id" text="policy_id"/> | [fleet_services.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts#:~:text=policy_id), [fleet_services.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/scripts/endpoint/common/fleet_services.ts#:~:text=policy_id), [endpoint_metadata_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.test.ts#:~:text=policy_id), [endpoint_package_policies.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/endpoint/routes/metadata/support/endpoint_package_policies.test.ts#:~:text=policy_id), [index.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/public/management/pages/policy/store/policy_details/index.test.ts#:~:text=policy_id) | - |
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode)+ 7 more | 8.8.0 |

2
api_docs/deprecations_by_team.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
title: Deprecated APIs due to be removed, by team
description: Lists the teams that are referencing deprecated APIs with a remove by date.
date: 2025-03-11
date: 2025-03-12
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

2
api_docs/dev_tools.mdx
View file

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

263
api_docs/discover.devdocs.json
View file

@ -55,7 +55,7 @@
"src/platform/plugins/shared/discover/public/utils/get_sharing_data",
">"
],
"path": "src/platform/plugins/shared/discover/public/utils/index.ts",
"path": "src/platform/plugins/shared/discover/public/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
@ -3819,7 +3819,9 @@
"parentPluginId": "discover",
"id": "def-public.DiscoverStart.DiscoverContainer",
"type": "CompoundType",
"tags": [],
"tags": [
"deprecated"
],
"label": "DiscoverContainer",
"description": [],
"signature": [
@ -3842,8 +3844,14 @@
">"
],
"path": "src/platform/plugins/shared/discover/public/types.ts",
"deprecated": false,
"trackAdoption": false
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/public/timelines/components/timeline/tabs/esql/index.tsx"
}
]
}
],
"lifecycle": "start",
@ -4257,252 +4265,7 @@
}
},
"common": {
"classes": [
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorDefinition",
"type": "Class",
"tags": [],
"label": "DiscoverAppLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorDefinition",
"text": "DiscoverAppLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
},
">"
],
"path": "src/platform/plugins/shared/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"DISCOVER_APP_LOCATOR\""
],
"path": "src/platform/plugins/shared/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorDefinition.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/plugins/shared/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorDefinition.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"DiscoverAppLocatorDependencies"
],
"path": "src/platform/plugins/shared/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
},
") => Promise<{ app: string; path: string; state: ",
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.MainHistoryLocationState",
"text": "MainHistoryLocationState"
},
"; }>"
],
"path": "src/platform/plugins/shared/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorDefinition.getLocation.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverAppLocatorParams",
"text": "DiscoverAppLocatorParams"
}
],
"path": "src/platform/plugins/shared/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverESQLLocatorDefinition",
"type": "Class",
"tags": [],
"label": "DiscoverESQLLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverESQLLocatorDefinition",
"text": "DiscoverESQLLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
">"
],
"path": "src/platform/plugins/shared/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-common.DiscoverESQLLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"DISCOVER_ESQL_LOCATOR\""
],
"path": "src/platform/plugins/shared/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverESQLLocatorDefinition.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/platform/plugins/shared/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-common.DiscoverESQLLocatorDefinition.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"DiscoverESQLLocatorDependencies"
],
"path": "src/platform/plugins/shared/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverESQLLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"() => Promise<",
"KibanaLocation",
"<object>>"
],
"path": "src/platform/plugins/shared/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"classes": [],
"functions": [],
"interfaces": [
{

7
api_docs/discover.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover
title: "discover"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discover plugin
date: 2025-03-11
date: 2025-03-12
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 |
|-------------------|-----------|------------------------|-----------------|
| 209 | 0 | 161 | 29 |
| 198 | 0 | 150 | 27 |
## Client
@ -50,9 +50,6 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k
## Common
### Classes
<DocDefinitionList data={discoverObj.common.classes}/>
### Interfaces
<DocDefinitionList data={discoverObj.common.interfaces}/>

2
api_docs/discover_enhanced.mdx
View file

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

2
api_docs/discover_shared.mdx
View file

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

2
api_docs/ecs_data_quality_dashboard.mdx
View file

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

2
api_docs/elastic_assistant.devdocs.json
View file

@ -1530,7 +1530,7 @@
"SavedObjectsClientContract",
", request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>): { preview: (args_0: Readonly<{} & { timeRange: string; sampleSize: number; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; }>) => Promise<any>; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>, spaceId: string, state?: ",
"<unknown, unknown, unknown, any>): { preview: (args_0: Readonly<{} & { timeRange: string; sampleSize: number; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"record\" | \"bucket\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; }>) => Promise<any>; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"record\" | \"bucket\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>, spaceId: string, state?: ",
"AnomalyDetectionRuleState",
" | undefined) => Promise<{ payload: ",
"AnomalyDetectionAlertPayload",

2
api_docs/elastic_assistant.mdx
View file

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

2
api_docs/embeddable.mdx
View file

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

2
api_docs/embeddable_enhanced.mdx
View file

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

2
api_docs/encrypted_saved_objects.mdx
View file

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

2
api_docs/enterprise_search.mdx
View file

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

2
api_docs/entities_data_access.mdx
View file

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

2
api_docs/entity_manager.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/entityManager
title: "entityManager"
image: https://source.unsplash.com/400x175/?github
description: API docs for the entityManager plugin
date: 2025-03-11
date: 2025-03-12
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'entityManager']
---
import entityManagerObj from './entity_manager.devdocs.json';

2
api_docs/es_ui_shared.mdx
View file

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

2
api_docs/esql.mdx
View file

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

2
api_docs/esql_data_grid.mdx
View file

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

2
api_docs/event_annotation.mdx
View file

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

2
api_docs/event_annotation_listing.mdx
View file

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

8
api_docs/event_log.devdocs.json
View file

File diff suppressed because one or more lines are too long

2
api_docs/event_log.mdx
View file

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

2
api_docs/exploratory_view.mdx
View file

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

2
api_docs/expression_error.mdx
View file

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

2
api_docs/expression_gauge.mdx
View file

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

2
api_docs/expression_heatmap.mdx
View file

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

2
api_docs/expression_image.mdx
View file

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

2
api_docs/expression_legacy_metric_vis.mdx
View file

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

2
api_docs/expression_metric.mdx
View file

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

2
api_docs/expression_metric_vis.mdx
View file

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

2
api_docs/expression_partition_vis.mdx
View file

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

2
api_docs/expression_repeat_image.mdx
View file

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

2
api_docs/expression_reveal_image.mdx
View file

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

2
api_docs/expression_shape.mdx
View file

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

2
api_docs/expression_tagcloud.mdx
View file

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

2
api_docs/expression_x_y.mdx
View file

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

2
api_docs/expressions.mdx
View file

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

2
api_docs/features.mdx
View file

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

2
api_docs/field_formats.mdx
View file

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

2
api_docs/fields_metadata.mdx
View file

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

2
api_docs/file_upload.mdx
View file

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

2
api_docs/files.mdx
View file

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

2
api_docs/files_management.mdx
View file

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

33
api_docs/fleet.devdocs.json
View file

@ -1666,14 +1666,6 @@
"plugin": "synthetics",
"path": "x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/private_location/synthetics_private_location.ts"
},
{
"plugin": "cloudDefend",
"path": "x-pack/solutions/security/plugins/cloud_defend/public/test/mocks.ts"
},
{
"plugin": "cloudDefend",
"path": "x-pack/solutions/security/plugins/cloud_defend/public/test/mocks.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.test.ts"
@ -21678,7 +21670,7 @@
"label": "integrations",
"description": [],
"signature": [
"{ readPackageInfo: boolean; readInstalledPackages: boolean; installPackages: boolean; upgradePackages: boolean; removePackages: boolean; uploadPackages: boolean; readPackageSettings: boolean; writePackageSettings: boolean; readIntegrationPolicies: boolean; writeIntegrationPolicies: boolean; }"
"{ all: boolean; readPackageInfo: boolean; readInstalledPackages: boolean; installPackages: boolean; upgradePackages: boolean; removePackages: boolean; uploadPackages: boolean; readPackageSettings: boolean; writePackageSettings: boolean; readIntegrationPolicies: boolean; writeIntegrationPolicies: boolean; }"
],
"path": "x-pack/platform/plugins/shared/fleet/common/authz.ts",
"deprecated": false,
@ -24602,14 +24594,6 @@
"plugin": "synthetics",
"path": "x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/private_location/synthetics_private_location.ts"
},
{
"plugin": "cloudDefend",
"path": "x-pack/solutions/security/plugins/cloud_defend/public/test/mocks.ts"
},
{
"plugin": "cloudDefend",
"path": "x-pack/solutions/security/plugins/cloud_defend/public/test/mocks.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/server/endpoint/services/metadata/endpoint_metadata_service.test.ts"
@ -27850,21 +27834,6 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.FLEET_CLOUD_DEFEND_PACKAGE",
"type": "string",
"tags": [],
"label": "FLEET_CLOUD_DEFEND_PACKAGE",
"description": [],
"signature": [
"\"cloud_defend\""
],
"path": "x-pack/platform/plugins/shared/fleet/common/constants/epm.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.FLEET_CLOUD_SECURITY_POSTURE_CNVM_POLICY_TEMPLATE",

4
api_docs/fleet.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet
title: "fleet"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fleet plugin
date: 2025-03-11
date: 2025-03-12
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 |
|-------------------|-----------|------------------------|-----------------|
| 1467 | 5 | 1339 | 86 |
| 1466 | 5 | 1338 | 86 |
## Client

2
api_docs/global_search.mdx
View file

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

2
api_docs/guided_onboarding.mdx
View file

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

2
api_docs/home.mdx
View file

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

2
api_docs/image_embeddable.mdx
View file

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

2
api_docs/index_management.mdx
View file

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

34
api_docs/inference.devdocs.json
View file

@ -133,6 +133,14 @@
"section": "def-common.ChatCompleteMetadata",
"text": "ChatCompleteMetadata"
},
" | undefined; maxRetries?: number | undefined; retryConfiguration?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteRetryConfiguration",
"text": "ChatCompleteRetryConfiguration"
},
" | undefined; } & TToolOptions"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
@ -239,7 +247,7 @@
"label": "naturalLanguageToEsql",
"description": [],
"signature": [
"({\n client,\n connectorId,\n tools,\n toolChoice,\n logger,\n functionCalling,\n system,\n metadata,\n ...rest\n}: ",
"({\n client,\n connectorId,\n tools,\n toolChoice,\n logger,\n functionCalling,\n maxRetries,\n retryConfiguration,\n system,\n metadata,\n ...rest\n}: ",
"NlToEsqlTaskParams",
"<TToolOptions>) => ",
"Observable",
@ -256,7 +264,7 @@
"id": "def-server.naturalLanguageToEsql.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n client,\n connectorId,\n tools,\n toolChoice,\n logger,\n functionCalling,\n system,\n metadata,\n ...rest\n}",
"label": "{\n client,\n connectorId,\n tools,\n toolChoice,\n logger,\n functionCalling,\n maxRetries,\n retryConfiguration,\n system,\n metadata,\n ...rest\n}",
"description": [],
"signature": [
"NlToEsqlTaskParams",
@ -343,7 +351,7 @@
"label": "options",
"description": [],
"signature": [
"{ [P in \"abortSignal\" | \"metadata\" | \"temperature\" | \"system\" | \"stream\" | \"messages\" | \"modelName\" | Exclude<keyof TToolOptions, \"connectorId\" | \"functionCalling\">]: ",
"{ [P in \"abortSignal\" | \"metadata\" | \"temperature\" | \"system\" | \"stream\" | \"messages\" | \"modelName\" | \"maxRetries\" | \"retryConfiguration\" | Exclude<keyof TToolOptions, \"connectorId\" | \"functionCalling\">]: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
@ -412,7 +420,15 @@
"section": "def-common.ChatCompleteMetadata",
"text": "ChatCompleteMetadata"
},
" | undefined; schema?: TOutputSchema | undefined; retry?: { onValidationError?: number | boolean | undefined; } | undefined; system?: string | undefined; stream?: TStream | undefined; modelName?: string | undefined; previousMessages?: ",
" | undefined; schema?: TOutputSchema | undefined; retry?: { onValidationError?: number | boolean | undefined; } | undefined; system?: string | undefined; stream?: TStream | undefined; modelName?: string | undefined; maxRetries?: number | undefined; retryConfiguration?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteRetryConfiguration",
"text": "ChatCompleteRetryConfiguration"
},
" | undefined; previousMessages?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
@ -567,6 +583,14 @@
"section": "def-common.ChatCompleteMetadata",
"text": "ChatCompleteMetadata"
},
" | undefined; maxRetries?: number | undefined; retryConfiguration?: ",
{
"pluginId": "@kbn/inference-common",
"scope": "common",
"docId": "kibKbnInferenceCommonPluginApi",
"section": "def-common.ChatCompleteRetryConfiguration",
"text": "ChatCompleteRetryConfiguration"
},
" | undefined; } & TToolOptions"
],
"path": "x-pack/platform/packages/shared/ai-infra/inference-common/src/chat_complete/api.ts",
@ -923,7 +947,7 @@
"section": "def-common.ChatCompleteAPI",
"text": "ChatCompleteAPI"
},
") => ({ id, connectorId, input, schema, system, previousMessages, modelName, functionCalling, stream, abortSignal, metadata, retry, }: DefaultOutputOptions) => Promise<",
") => ({ id, connectorId, input, schema, system, previousMessages, modelName, functionCalling, stream, abortSignal, maxRetries, retryConfiguration, metadata, retry, }: DefaultOutputOptions) => Promise<",
{
"pluginId": "@kbn/inference-common",
"scope": "common",

2
api_docs/inference.mdx
View file

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

2
api_docs/inference_endpoint.mdx
View file

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

2
api_docs/infra.mdx
View file

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

2
api_docs/ingest_pipelines.mdx
View file

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

2
api_docs/inspector.mdx
View file

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

2
api_docs/interactive_setup.mdx
View file

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

2
api_docs/inventory.mdx
View file

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

2
api_docs/investigate.mdx
View file

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

2
api_docs/investigate_app.devdocs.json
View file

@ -100,7 +100,7 @@
},
"<\"GET /api/observability/investigation/entities 2023-10-31\", Zod.ZodObject<{ query: Zod.ZodOptional<Zod.ZodObject<{ 'service.name': Zod.ZodOptional<Zod.ZodString>; 'service.environment': Zod.ZodOptional<Zod.ZodString>; 'host.name': Zod.ZodOptional<Zod.ZodString>; 'container.id': Zod.ZodOptional<Zod.ZodString>; }, \"strip\", Zod.ZodTypeAny, { 'container.id'?: string | undefined; 'host.name'?: string | undefined; 'service.environment'?: string | undefined; 'service.name'?: string | undefined; }, { 'container.id'?: string | undefined; 'host.name'?: string | undefined; 'service.environment'?: string | undefined; 'service.name'?: string | undefined; }>>; }, \"strip\", Zod.ZodTypeAny, { query?: { 'container.id'?: string | undefined; 'host.name'?: string | undefined; 'service.environment'?: string | undefined; 'service.name'?: string | undefined; } | undefined; }, { query?: { 'container.id'?: string | undefined; 'host.name'?: string | undefined; 'service.environment'?: string | undefined; 'service.name'?: string | undefined; } | undefined; }>, ",
"InvestigateAppRouteHandlerResources",
", { entities: ({ id: string; type: string; metrics: { latency?: number | undefined; throughput?: number | undefined; failedTransactionRate?: number | undefined; logErrorRate?: number | undefined; logRate?: number | undefined; }; schema_version: string; identity_fields: string[]; display_name: string; definition_id: string; definition_version: string; last_seen_timestamp: string; } & { sources: { dataStream?: string | undefined; }[]; })[]; }, ",
", { entities: ({ id: string; type: string; metrics: { latency?: number | undefined; throughput?: number | undefined; failedTransactionRate?: number | undefined; logErrorRate?: number | undefined; logRate?: number | undefined; }; identity_fields: string[]; display_name: string; schema_version: string; definition_id: string; definition_version: string; last_seen_timestamp: string; } & { sources: { dataStream?: string | undefined; }[]; })[]; }, ",
"InvestigateAppRouteCreateOptions",
">; \"GET /api/observability/events 2023-10-31\": ",
{

2
api_docs/investigate_app.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/investigateApp
title: "investigateApp"
image: https://source.unsplash.com/400x175/?github
description: API docs for the investigateApp plugin
date: 2025-03-11
date: 2025-03-12
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'investigateApp']
---
import investigateAppObj from './investigate_app.devdocs.json';

2
api_docs/kbn_actions_types.mdx
View file

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

495
api_docs/kbn_ai_assistant.devdocs.json
View file

@ -11,7 +11,7 @@
"label": "ChatBody",
"description": [],
"signature": [
"({\n connectors,\n currentUser,\n flyoutPositionMode,\n initialConversationId,\n initialMessages,\n initialTitle,\n knowledgeBase,\n showLinkToConversationsApp,\n onConversationUpdate,\n onToggleFlyoutPositionMode,\n navigateToConversation,\n onConversationDuplicate,\n}: { connectors: ",
"({\n connectors,\n currentUser,\n flyoutPositionMode,\n initialConversationId,\n initialMessages,\n initialTitle,\n knowledgeBase,\n showLinkToConversationsApp,\n onConversationUpdate,\n onToggleFlyoutPositionMode,\n navigateToConversation,\n setIsUpdatingConversationList,\n refreshConversations,\n updateDisplayedConversation,\n onConversationDuplicate,\n}: { connectors: ",
"UseGenAIConnectorsResult",
"; currentUser?: Pick<",
"AuthenticatedUser",
@ -55,7 +55,7 @@
"section": "def-public.FlyoutPositionMode",
"text": "FlyoutPositionMode"
},
") => void) | undefined; navigateToConversation?: ((conversationId?: string | undefined) => void) | undefined; }) => React.JSX.Element"
") => void) | undefined; navigateToConversation?: ((conversationId?: string | undefined) => void) | undefined; setIsUpdatingConversationList: (isUpdating: boolean) => void; refreshConversations: () => void; updateDisplayedConversation: (id?: string | undefined) => void; }) => React.JSX.Element"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/chat_body.tsx",
"deprecated": false,
@ -66,7 +66,7 @@
"id": "def-public.ChatBody.$1",
"type": "Object",
"tags": [],
"label": "{\n connectors,\n currentUser,\n flyoutPositionMode,\n initialConversationId,\n initialMessages,\n initialTitle,\n knowledgeBase,\n showLinkToConversationsApp,\n onConversationUpdate,\n onToggleFlyoutPositionMode,\n navigateToConversation,\n onConversationDuplicate,\n}",
"label": "{\n connectors,\n currentUser,\n flyoutPositionMode,\n initialConversationId,\n initialMessages,\n initialTitle,\n knowledgeBase,\n showLinkToConversationsApp,\n onConversationUpdate,\n onToggleFlyoutPositionMode,\n navigateToConversation,\n setIsUpdatingConversationList,\n refreshConversations,\n updateDisplayedConversation,\n onConversationDuplicate,\n}",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/chat_body.tsx",
"deprecated": false,
@ -370,6 +370,86 @@
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ChatBody.$1.setIsUpdatingConversationList",
"type": "Function",
"tags": [],
"label": "setIsUpdatingConversationList",
"description": [],
"signature": [
"(isUpdating: boolean) => void"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/chat_body.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ChatBody.$1.setIsUpdatingConversationList.$1",
"type": "boolean",
"tags": [],
"label": "isUpdating",
"description": [],
"signature": [
"boolean"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/chat_body.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ChatBody.$1.refreshConversations",
"type": "Function",
"tags": [],
"label": "refreshConversations",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/chat_body.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ChatBody.$1.updateDisplayedConversation",
"type": "Function",
"tags": [],
"label": "updateDisplayedConversation",
"description": [],
"signature": [
"(id?: string | undefined) => void"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/chat_body.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ChatBody.$1.updateDisplayedConversation.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/chat_body.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
]
}
@ -703,7 +783,7 @@
"label": "ConversationList",
"description": [],
"signature": [
"({\n conversations,\n isLoading,\n selectedConversationId,\n onConversationSelect,\n onConversationDeleteClick,\n newConversationHref,\n getConversationHref,\n}: { conversations: ",
"({\n conversations,\n isLoading,\n selectedConversationId,\n currentUser,\n onConversationSelect,\n newConversationHref,\n getConversationHref,\n setIsUpdatingConversationList,\n refreshConversations,\n updateDisplayedConversation,\n}: { conversations: ",
{
"pluginId": "observabilityAIAssistant",
"scope": "public",
@ -719,7 +799,9 @@
"section": "def-common.Conversation",
"text": "Conversation"
},
"[]; }>; isLoading: boolean; selectedConversationId?: string | undefined; onConversationSelect?: ((conversationId?: string | undefined) => void) | undefined; onConversationDeleteClick: (conversationId: string) => void; newConversationHref?: string | undefined; getConversationHref?: ((conversationId: string) => string) | undefined; }) => React.JSX.Element"
"[]; }>; isLoading: boolean; selectedConversationId?: string | undefined; currentUser: Pick<",
"AuthenticatedUser",
", \"username\" | \"full_name\" | \"profile_uid\">; onConversationSelect?: ((conversationId?: string | undefined) => void) | undefined; newConversationHref?: string | undefined; getConversationHref?: ((conversationId: string) => string) | undefined; setIsUpdatingConversationList: (isUpdating: boolean) => void; refreshConversations: () => void; updateDisplayedConversation: (id?: string | undefined) => void; }) => React.JSX.Element"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/conversation_list.tsx",
"deprecated": false,
@ -730,7 +812,7 @@
"id": "def-public.ConversationList.$1",
"type": "Object",
"tags": [],
"label": "{\n conversations,\n isLoading,\n selectedConversationId,\n onConversationSelect,\n onConversationDeleteClick,\n newConversationHref,\n getConversationHref,\n}",
"label": "{\n conversations,\n isLoading,\n selectedConversationId,\n currentUser,\n onConversationSelect,\n newConversationHref,\n getConversationHref,\n setIsUpdatingConversationList,\n refreshConversations,\n updateDisplayedConversation,\n}",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/conversation_list.tsx",
"deprecated": false,
@ -783,6 +865,20 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ConversationList.$1.currentUser",
"type": "Object",
"tags": [],
"label": "currentUser",
"description": [],
"signature": [
"{ username: string; full_name?: string | undefined; profile_uid?: string | undefined; }"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/conversation_list.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ConversationList.$1.onConversationSelect",
@ -815,38 +911,6 @@
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ConversationList.$1.onConversationDeleteClick",
"type": "Function",
"tags": [],
"label": "onConversationDeleteClick",
"description": [],
"signature": [
"(conversationId: string) => void"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/conversation_list.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ConversationList.$1.onConversationDeleteClick.$1",
"type": "string",
"tags": [],
"label": "conversationId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/conversation_list.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ConversationList.$1.newConversationHref",
@ -892,6 +956,86 @@
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ConversationList.$1.setIsUpdatingConversationList",
"type": "Function",
"tags": [],
"label": "setIsUpdatingConversationList",
"description": [],
"signature": [
"(isUpdating: boolean) => void"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/conversation_list.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ConversationList.$1.setIsUpdatingConversationList.$1",
"type": "boolean",
"tags": [],
"label": "isUpdating",
"description": [],
"signature": [
"boolean"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/conversation_list.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ConversationList.$1.refreshConversations",
"type": "Function",
"tags": [],
"label": "refreshConversations",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/conversation_list.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ConversationList.$1.updateDisplayedConversation",
"type": "Function",
"tags": [],
"label": "updateDisplayedConversation",
"description": [],
"signature": [
"(id?: string | undefined) => void"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/conversation_list.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.ConversationList.$1.updateDisplayedConversation.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/chat/conversation_list.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
]
}
@ -1192,6 +1336,92 @@
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.useConversationContextMenu",
"type": "Function",
"tags": [],
"label": "useConversationContextMenu",
"description": [],
"signature": [
"({\n setIsUpdatingConversationList,\n refreshConversations,\n}: { setIsUpdatingConversationList: (isUpdating: boolean) => void; refreshConversations: () => void; }) => ",
{
"pluginId": "@kbn/ai-assistant",
"scope": "public",
"docId": "kibKbnAiAssistantPluginApi",
"section": "def-public.UseConversationContextMenuResult",
"text": "UseConversationContextMenuResult"
}
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.useConversationContextMenu.$1",
"type": "Object",
"tags": [],
"label": "{\n setIsUpdatingConversationList,\n refreshConversations,\n}",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.useConversationContextMenu.$1.setIsUpdatingConversationList",
"type": "Function",
"tags": [],
"label": "setIsUpdatingConversationList",
"description": [],
"signature": [
"(isUpdating: boolean) => void"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.useConversationContextMenu.$1.setIsUpdatingConversationList.$1",
"type": "boolean",
"tags": [],
"label": "isUpdating",
"description": [],
"signature": [
"boolean"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.useConversationContextMenu.$1.refreshConversations",
"type": "Function",
"tags": [],
"label": "refreshConversations",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.useConversationsByDate",
@ -1208,7 +1438,15 @@
"section": "def-common.Conversation",
"text": "Conversation"
},
"[], getConversationHref: ((id: string) => string) | undefined) => Record<string, { id: string; label: string; lastUpdated: string; href?: string | undefined; }[]>"
"[], getConversationHref: ((id: string) => string) | undefined) => Record<string, { id: string; label: string; lastUpdated: string; href?: string | undefined; public: boolean; conversation: ",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
"; }[]>"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversations_by_date.ts",
"deprecated": false,
@ -1324,6 +1562,185 @@
}
],
"interfaces": [
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.CopyConversationToClipboardParams",
"type": "Interface",
"tags": [],
"label": "CopyConversationToClipboardParams",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.CopyConversationToClipboardParams.conversation",
"type": "Object",
"tags": [],
"label": "conversation",
"description": [],
"signature": [
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
}
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.CopyConversationToClipboardParams.messages",
"type": "Array",
"tags": [],
"label": "messages",
"description": [],
"signature": [
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Message",
"text": "Message"
},
"[]"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.UseConversationContextMenuResult",
"type": "Interface",
"tags": [],
"label": "UseConversationContextMenuResult",
"description": [],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.UseConversationContextMenuResult.deleteConversation",
"type": "Function",
"tags": [],
"label": "deleteConversation",
"description": [],
"signature": [
"(id: string) => Promise<void>"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.UseConversationContextMenuResult.deleteConversation.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.UseConversationContextMenuResult.copyConversationToClipboard",
"type": "Function",
"tags": [],
"label": "copyConversationToClipboard",
"description": [],
"signature": [
"(conversation: ",
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
},
") => void"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.UseConversationContextMenuResult.copyConversationToClipboard.$1",
"type": "Object",
"tags": [],
"label": "conversation",
"description": [],
"signature": [
{
"pluginId": "observabilityAIAssistant",
"scope": "common",
"docId": "kibObservabilityAIAssistantPluginApi",
"section": "def-common.Conversation",
"text": "Conversation"
}
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.UseConversationContextMenuResult.copyUrl",
"type": "Function",
"tags": [],
"label": "copyUrl",
"description": [],
"signature": [
"(id: string) => void"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.UseConversationContextMenuResult.copyUrl.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/kbn-ai-assistant/src/hooks/use_conversation_context_menu.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ai-assistant",
"id": "def-public.UseKnowledgeBaseResult",

4
api_docs/kbn_ai_assistant.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ai-assistant
title: "@kbn/ai-assistant"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ai-assistant plugin
date: 2025-03-11
date: 2025-03-12
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ai-assistant']
---
import kbnAiAssistantObj from './kbn_ai_assistant.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/search-kibana](https://github.com/orgs/elastic/teams/search-ki
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 78 | 0 | 78 | 1 |
| 102 | 0 | 102 | 1 |
## Client

2
api_docs/kbn_ai_assistant_common.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ai-assistant-common
title: "@kbn/ai-assistant-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ai-assistant-common plugin
date: 2025-03-11
date: 2025-03-12
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