[api-docs] 2025-03-28 Daily api_docs build (#216253)

Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/1025
This commit is contained in:
Kibana Machine 2025-03-28 08:34:11 +01:00 committed by GitHub
parent d03727f93a
commit abf3a9a1c4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
819 changed files with 2010 additions and 956 deletions

View file

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

View file

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

View file

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

View file

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

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

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

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-27
date: 2025-03-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
import chartsObj from './charts.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 271 | 2 | 255 | 9 |
| 270 | 2 | 254 | 9 |
## Client

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
title: Deprecated API usage by API
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2025-03-27
date: 2025-03-28
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

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-27
date: 2025-03-28
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -44,7 +44,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibDataPluginApi" section="def-common.SavedObject.migrationVersion" text="migrationVersion"/> | [simple_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/saved-objects/api-browser/src/simple_saved_object.ts#:~:text=migrationVersion), [simple_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/saved-objects/browser-internal/src/simple_saved_object.ts#:~:text=migrationVersion), [simple_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/saved-objects/browser-internal/src/simple_saved_object.ts#:~:text=migrationVersion), [internal_utils.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/saved-objects/api-server-internal/src/lib/apis/utils/internal_utils.ts#:~:text=migrationVersion), [collect_saved_objects.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/saved-objects/import-export-server-internal/src/import/lib/collect_saved_objects.ts#:~:text=migrationVersion), [import_dashboards.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/saved-objects/server-internal/src/routes/legacy_import_export/lib/import_dashboards.ts#:~:text=migrationVersion), [simple_saved_object.mock.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/saved-objects/browser-mocks/src/simple_saved_object.mock.ts#:~:text=migrationVersion), [simple_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/saved-objects/api-browser/src/simple_saved_object.ts#:~:text=migrationVersion), [simple_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/saved-objects/browser-internal/src/simple_saved_object.ts#:~:text=migrationVersion), [simple_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/saved-objects/browser-internal/src/simple_saved_object.ts#:~:text=migrationVersion)+ 4 more | - |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/main/src/core/packages/application/browser-internal/src/ui/app_container.tsx#:~:text=appBasePath), [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/application/browser-mocks/src/application_service.mock.ts#:~:text=appBasePath), [mocks.ts](https://github.com/elastic/kibana/tree/main/src/core/public/mocks.ts#:~:text=appBasePath) | - |
| <DocLink id="kibKbnCoreElasticsearchServerPluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | [elasticsearch_service.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/elasticsearch/server-internal/src/elasticsearch_service.ts#:~:text=legacy), [plugin_context.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/plugins/server-internal/src/plugin_context.ts#:~:text=legacy), [plugin_context.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/plugins/server-internal/src/plugin_context.ts#:~:text=legacy), [elasticsearch_service.test.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/elasticsearch/server-internal/src/elasticsearch_service.test.ts#:~:text=legacy) | - |
| <DocLink id="kibKbnCoreHttpServerPluginApi" section="def-server.RouteConfigOptions.authRequired" text="authRequired"/> | [security_route_config_validator.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/http/router-server-internal/src/security_route_config_validator.ts#:~:text=authRequired), [http_server.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/http/server-internal/src/http_server.ts#:~:text=authRequired), [http_server.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/http/server-internal/src/http_server.ts#:~:text=authRequired), [elu_history.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/metrics/server-internal/src/routes/elu_history.ts#:~:text=authRequired), [status.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/status/server-internal/src/routes/status.ts#:~:text=authRequired), [translations.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/i18n/server-internal/src/routes/translations.ts#:~:text=authRequired), [register_bootstrap_route.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/rendering/server-internal/src/bootstrap/register_bootstrap_route.ts#:~:text=authRequired), [bundles_route.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/apps/server-internal/src/bundle_routes/bundles_route.ts#:~:text=authRequired), [security_route_config_validator.test.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/http/router-server-internal/src/security_route_config_validator.test.ts#:~:text=authRequired), [core_versioned_route.test.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/http/router-server-internal/src/versioned_router/core_versioned_route.test.ts#:~:text=authRequired)+ 10 more | - |
| <DocLink id="kibKbnCoreHttpServerPluginApi" section="def-server.RouteConfigOptions.authRequired" text="authRequired"/> | [security_route_config_validator.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/http/router-server-internal/src/security_route_config_validator.ts#:~:text=authRequired), [http_server.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/http/server-internal/src/http_server.ts#:~:text=authRequired), [http_server.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/http/server-internal/src/http_server.ts#:~:text=authRequired), [status.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/status/server-internal/src/routes/status.ts#:~:text=authRequired), [translations.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/i18n/server-internal/src/routes/translations.ts#:~:text=authRequired), [register_bootstrap_route.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/rendering/server-internal/src/bootstrap/register_bootstrap_route.ts#:~:text=authRequired), [bundles_route.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/apps/server-internal/src/bundle_routes/bundles_route.ts#:~:text=authRequired), [security_route_config_validator.test.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/http/router-server-internal/src/security_route_config_validator.test.ts#:~:text=authRequired), [core_versioned_route.test.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/http/router-server-internal/src/versioned_router/core_versioned_route.test.ts#:~:text=authRequired), [auth.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/http/server-internal/src/lifecycle/auth.ts#:~:text=authRequired)+ 9 more | - |
| <DocLink id="kibKbnCoreLifecycleBrowserPluginApi" section="def-public.CoreStart.savedObjects" text="savedObjects"/> | [plugin_context.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/plugins/browser-internal/src/plugin_context.ts#:~:text=savedObjects), [plugin_context.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/plugins/browser-internal/src/plugin_context.ts#:~:text=savedObjects), [core_system.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/root/browser-internal/src/core_system.ts#:~:text=savedObjects), [plugins_service.test.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/plugins/browser-internal/src/plugins_service.test.ts#:~:text=savedObjects) | - |
| <DocLink id="kibKbnCoreLoggingServerPluginApi" section="def-server.NumericRollingStrategyConfig.max" text="max"/> | [index.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/logging/server-internal/src/appenders/rolling_file/strategies/index.ts#:~:text=max), [create_retention_policy.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/logging/server-internal/src/appenders/rolling_file/retention/create_retention_policy.ts#:~:text=max), [appenders.test.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/logging/server-internal/src/appenders/appenders.test.ts#:~:text=max), [rolling_file_appender.test.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/logging/server-internal/src/appenders/rolling_file/rolling_file_appender.test.ts#:~:text=max), [create_retention_policy.test.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/logging/server-internal/src/appenders/rolling_file/retention/create_retention_policy.test.ts#:~:text=max), [numeric_strategy.test.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/logging/server-internal/src/appenders/rolling_file/strategies/numeric/numeric_strategy.test.ts#:~:text=max) | - |
| <DocLink id="kibKbnCorePluginsServerPluginApi" section="def-server.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> | [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/plugins/server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/plugins/server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/plugins/server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/plugins/server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/plugins/server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs), [plugin_manifest_parser.ts](https://github.com/elastic/kibana/tree/main/src/core/packages/plugins/server-internal/src/discovery/plugin_manifest_parser.ts#:~:text=extraPublicDirs) | - |

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -4356,6 +4356,28 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-public.EPM_API_ROUTES.BULK_UPGRADE_PATTERN",
"type": "string",
"tags": [],
"label": "BULK_UPGRADE_PATTERN",
"description": [],
"path": "x-pack/platform/plugins/shared/fleet/common/constants/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-public.EPM_API_ROUTES.BULK_UPGRADE_INFO_PATTERN",
"type": "string",
"tags": [],
"label": "BULK_UPGRADE_INFO_PATTERN",
"description": [],
"path": "x-pack/platform/plugins/shared/fleet/common/constants/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-public.EPM_API_ROUTES.LIST_PATTERN",
@ -4854,7 +4876,7 @@
"label": "integration_details_overview",
"description": [],
"signature": [
"({ pkgkey, integration }: ",
"({ pkgkey, integration, returnAppId, returnPath }: ",
{
"pluginId": "fleet",
"scope": "public",
@ -4873,7 +4895,7 @@
"id": "def-public.pagePathGetters.integration_details_overview.$1",
"type": "Object",
"tags": [],
"label": "{ pkgkey, integration }",
"label": "{ pkgkey, integration, returnAppId, returnPath }",
"description": [],
"signature": [
{
@ -4900,7 +4922,7 @@
"label": "integration_details_policies",
"description": [],
"signature": [
"({ pkgkey, integration, addAgentToPolicyId }: ",
"({ pkgkey, integration, addAgentToPolicyId, returnAppId, returnPath, }: ",
{
"pluginId": "fleet",
"scope": "public",
@ -4919,7 +4941,7 @@
"id": "def-public.pagePathGetters.integration_details_policies.$1",
"type": "Object",
"tags": [],
"label": "{ pkgkey, integration, addAgentToPolicyId }",
"label": "{\n pkgkey,\n integration,\n addAgentToPolicyId,\n returnAppId,\n returnPath,\n }",
"description": [],
"signature": [
{
@ -4946,7 +4968,7 @@
"label": "integration_details_assets",
"description": [],
"signature": [
"({ pkgkey, integration }: ",
"({ pkgkey, integration, returnAppId, returnPath }: ",
{
"pluginId": "fleet",
"scope": "public",
@ -4965,7 +4987,7 @@
"id": "def-public.pagePathGetters.integration_details_assets.$1",
"type": "Object",
"tags": [],
"label": "{ pkgkey, integration }",
"label": "{ pkgkey, integration, returnAppId, returnPath }",
"description": [],
"signature": [
{
@ -4992,7 +5014,7 @@
"label": "integration_details_settings",
"description": [],
"signature": [
"({ pkgkey, integration }: ",
"({ pkgkey, integration, returnAppId, returnPath }: ",
{
"pluginId": "fleet",
"scope": "public",
@ -5011,7 +5033,7 @@
"id": "def-public.pagePathGetters.integration_details_settings.$1",
"type": "Object",
"tags": [],
"label": "{ pkgkey, integration }",
"label": "{ pkgkey, integration, returnAppId, returnPath }",
"description": [],
"signature": [
{
@ -5038,7 +5060,7 @@
"label": "integration_details_configs",
"description": [],
"signature": [
"({ pkgkey, integration }: ",
"({ pkgkey, integration, returnAppId, returnPath }: ",
{
"pluginId": "fleet",
"scope": "public",
@ -5057,7 +5079,7 @@
"id": "def-public.pagePathGetters.integration_details_configs.$1",
"type": "Object",
"tags": [],
"label": "{ pkgkey, integration }",
"label": "{ pkgkey, integration, returnAppId, returnPath }",
"description": [],
"signature": [
{
@ -5084,7 +5106,7 @@
"label": "integration_details_custom",
"description": [],
"signature": [
"({ pkgkey, integration }: ",
"({ pkgkey, integration, returnAppId, returnPath }: ",
{
"pluginId": "fleet",
"scope": "public",
@ -5103,7 +5125,7 @@
"id": "def-public.pagePathGetters.integration_details_custom.$1",
"type": "Object",
"tags": [],
"label": "{ pkgkey, integration }",
"label": "{ pkgkey, integration, returnAppId, returnPath }",
"description": [],
"signature": [
{
@ -5130,7 +5152,7 @@
"label": "integration_details_api_reference",
"description": [],
"signature": [
"({ pkgkey, integration }: ",
"({ pkgkey, integration, returnAppId, returnPath }: ",
{
"pluginId": "fleet",
"scope": "public",
@ -5149,7 +5171,7 @@
"id": "def-public.pagePathGetters.integration_details_api_reference.$1",
"type": "Object",
"tags": [],
"label": "{ pkgkey, integration }",
"label": "{ pkgkey, integration, returnAppId, returnPath }",
"description": [],
"signature": [
{
@ -31133,6 +31155,28 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.EPM_API_ROUTES.BULK_UPGRADE_PATTERN",
"type": "string",
"tags": [],
"label": "BULK_UPGRADE_PATTERN",
"description": [],
"path": "x-pack/platform/plugins/shared/fleet/common/constants/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.EPM_API_ROUTES.BULK_UPGRADE_INFO_PATTERN",
"type": "string",
"tags": [],
"label": "BULK_UPGRADE_INFO_PATTERN",
"description": [],
"path": "x-pack/platform/plugins/shared/fleet/common/constants/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.EPM_API_ROUTES.LIST_PATTERN",
@ -31610,6 +31654,54 @@
"children": [],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-common.epmRouteService.getBulkUpgradePath",
"type": "Function",
"tags": [],
"label": "getBulkUpgradePath",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/platform/plugins/shared/fleet/common/services/routes.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-common.epmRouteService.getOneBulkUpgradePath",
"type": "Function",
"tags": [],
"label": "getOneBulkUpgradePath",
"description": [],
"signature": [
"(taskId: string) => string"
],
"path": "x-pack/platform/plugins/shared/fleet/common/services/routes.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-common.epmRouteService.getOneBulkUpgradePath.$1",
"type": "string",
"tags": [],
"label": "taskId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/fleet/common/services/routes.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-common.epmRouteService.getRemovePath",

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-27
date: 2025-03-28
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 |
|-------------------|-----------|------------------------|-----------------|
| 1489 | 5 | 1361 | 89 |
| 1496 | 5 | 1368 | 89 |
## Client

View file

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

View file

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

View file

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

View file

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

View file

@ -443,7 +443,7 @@
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
" & ({ page: \"data_streams_details\"; dataStreamName?: string | undefined; } | { page: \"index_template\"; indexTemplate: string; } | { page: \"component_template\"; componentTemplate: string; })"
" & ({ page: \"index_list\"; filter?: string | undefined; includeHiddenIndices?: boolean | undefined; } | { page: \"data_streams_details\"; dataStreamName?: string | undefined; } | { page: \"index_template\"; indexTemplate: string; } | { page: \"index_template_edit\"; indexTemplate: string; } | { page: \"index_template_clone\"; indexTemplate: string; } | { page: \"component_template\"; componentTemplate: string; } | { page: \"component_template_list\"; filter?: string | undefined; } | { page: \"edit_component_template\"; componentTemplate: string; } | { page: \"clone_component_template\"; componentTemplate: string; } | { page: \"create_component_template\"; componentTemplate: string; })"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
@ -714,6 +714,171 @@
}
],
"returnComment": []
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getComponentTemplateFlyoutComponent",
"type": "Function",
"tags": [],
"label": "getComponentTemplateFlyoutComponent",
"description": [],
"signature": [
"(deps: { history: ",
"ScopedHistory",
"<unknown>; }) => React.FC<",
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.ComponentTemplateFlyoutProps",
"text": "ComponentTemplateFlyoutProps"
},
">"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getComponentTemplateFlyoutComponent.$1",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getComponentTemplateFlyoutComponent.$1.history",
"type": "Object",
"tags": [],
"label": "history",
"description": [],
"signature": [
"ScopedHistory",
"<unknown>"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getIndexTemplateFlyoutComponent",
"type": "Function",
"tags": [],
"label": "getIndexTemplateFlyoutComponent",
"description": [],
"signature": [
"(deps: { history: ",
"ScopedHistory",
"<unknown>; }) => React.FC<",
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.IndexTemplateFlyoutProps",
"text": "IndexTemplateFlyoutProps"
},
">"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getIndexTemplateFlyoutComponent.$1",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getIndexTemplateFlyoutComponent.$1.history",
"type": "Object",
"tags": [],
"label": "history",
"description": [],
"signature": [
"ScopedHistory",
"<unknown>"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getDatastreamFlyoutComponent",
"type": "Function",
"tags": [],
"label": "getDatastreamFlyoutComponent",
"description": [],
"signature": [
"(deps: { history: ",
"ScopedHistory",
"<unknown>; }) => React.FC<",
{
"pluginId": "@kbn/index-management-shared-types",
"scope": "common",
"docId": "kibKbnIndexManagementSharedTypesPluginApi",
"section": "def-common.DatastreamFlyoutProps",
"text": "DatastreamFlyoutProps"
},
">"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getDatastreamFlyoutComponent.$1",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-public.IndexManagementPluginStart.getDatastreamFlyoutComponent.$1.history",
"type": "Object",
"tags": [],
"label": "history",
"description": [],
"signature": [
"ScopedHistory",
"<unknown>"
],
"path": "x-pack/platform/packages/shared/index-management/index_management_shared_types/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
}
],
"lifecycle": "start",

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-27
date: 2025-03-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
---
import indexManagementObj from './index_management.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kiban
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 246 | 0 | 241 | 1 |
| 255 | 0 | 250 | 1 |
## Client

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

View file

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

View file

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

View file

@ -48,6 +48,69 @@
}
],
"initialIsOpen": false
},
{
"parentPluginId": "ingestPipelines",
"id": "def-public.IngestPipelinesPluginStart",
"type": "Interface",
"tags": [],
"label": "IngestPipelinesPluginStart",
"description": [],
"path": "x-pack/platform/plugins/shared/ingest_pipelines/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ingestPipelines",
"id": "def-public.IngestPipelinesPluginStart.getIngestPipelineFlyoutComponent",
"type": "Function",
"tags": [],
"label": "getIngestPipelineFlyoutComponent",
"description": [],
"signature": [
"(deps: { history: ",
"ScopedHistory",
"<unknown>; }) => React.FC<",
"IngestPipelineFlyoutProps",
">"
],
"path": "x-pack/platform/plugins/shared/ingest_pipelines/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ingestPipelines",
"id": "def-public.IngestPipelinesPluginStart.getIngestPipelineFlyoutComponent.$1",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"path": "x-pack/platform/plugins/shared/ingest_pipelines/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "ingestPipelines",
"id": "def-public.IngestPipelinesPluginStart.getIngestPipelineFlyoutComponent.$1.history",
"type": "Object",
"tags": [],
"label": "history",
"description": [],
"signature": [
"ScopedHistory",
"<unknown>"
],
"path": "x-pack/platform/plugins/shared/ingest_pipelines/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [

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-27
date: 2025-03-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ingestPipelines']
---
import ingestPipelinesObj from './ingest_pipelines.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kiban
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 4 | 0 | 4 | 0 |
| 8 | 0 | 8 | 1 |
## Client

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -13,7 +13,7 @@
"\nA pure component that renders a call to action to add a connector."
],
"signature": [
"({ onAddConnector }: ",
"({ onAddConnector, ...props }: ",
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
@ -32,7 +32,7 @@
"id": "def-public.AddConnector.$1",
"type": "Object",
"tags": [],
"label": "{ onAddConnector }",
"label": "{ onAddConnector, ...props }",
"description": [],
"signature": [
{
@ -62,7 +62,7 @@
"\nA \"Call to Action\" panel for use in the AI Assistant. Comprises a title, description, and children.\n\nThis is a base component that can be used to create more specific calls to action, (e.g. install knowledge base)."
],
"signature": [
"({ title, description, color, children, }: ",
"({ title, description, color, children, centered, ...props }: ",
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
@ -81,7 +81,7 @@
"id": "def-public.AssistantCallToAction.$1",
"type": "Object",
"tags": [],
"label": "{\n title = translations.title,\n description,\n color = 'plain',\n children,\n}",
"label": "{\n title = translations.title,\n description,\n color = 'plain',\n children,\n centered = false,\n ...props\n}",
"description": [],
"signature": [
{
@ -111,7 +111,7 @@
"\nA pure component that renders a call to action to install a knowledge base."
],
"signature": [
"({ onInstallKnowledgeBase }: ",
"({ onInstallKnowledgeBase, isInstalling, isInstallAvailable, ...props }: ",
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
@ -130,7 +130,7 @@
"id": "def-public.InstallKnowledgeBase.$1",
"type": "Object",
"tags": [],
"label": "{ onInstallKnowledgeBase }",
"label": "{\n onInstallKnowledgeBase,\n isInstalling = false,\n isInstallAvailable = true,\n ...props\n}",
"description": [],
"signature": [
{
@ -160,7 +160,7 @@
"\nA pure component that renders a call to action to upgrade a license."
],
"signature": [
"({ onManageLicense }: ",
"({ onManageLicense, ...props }: ",
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
@ -179,7 +179,7 @@
"id": "def-public.NeedLicenseUpgrade.$1",
"type": "Object",
"tags": [],
"label": "{ onManageLicense }",
"label": "{ onManageLicense, ...props }",
"description": [],
"signature": [
{
@ -209,7 +209,7 @@
"\nA pure component that renders a call to action to upgrade the tier on a Serverless project."
],
"signature": [
"({ onManageSubscription }: ",
"({ onManageSubscription, ...props }: ",
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
@ -228,7 +228,7 @@
"id": "def-public.NeedTierUpgrade.$1",
"type": "Object",
"tags": [],
"label": "{ onManageSubscription }",
"label": "{ onManageSubscription, ...props }",
"description": [],
"signature": [
{
@ -258,12 +258,28 @@
"\nA call to action that is displayed if the user does not have permission or ability to add a connector."
],
"signature": [
"() => React.JSX.Element"
"(props: NoConnectorAccessProps) => React.JSX.Element"
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/no_connector_access/no_connector_access.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"children": [
{
"parentPluginId": "@kbn/ai-assistant-cta",
"id": "def-public.NoConnectorAccess.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"NoConnectorAccessProps"
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/no_connector_access/no_connector_access.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
@ -277,7 +293,7 @@
"\nA pure component that renders a call to action that indicates the AI Assistant is configured\nand ready to be used."
],
"signature": [
"({ type }: ",
"({ type, ...props }: ",
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
@ -296,7 +312,7 @@
"id": "def-public.ReadyToHelp.$1",
"type": "Object",
"tags": [],
"label": "{ type = 'stack' }",
"label": "{ type = 'stack', ...props }",
"description": [],
"signature": [
{
@ -327,6 +343,24 @@
"description": [
"\nProps for the `AddConnector` call to action."
],
"signature": [
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
"docId": "kibKbnAiAssistantCtaPluginApi",
"section": "def-public.AddConnectorProps",
"text": "AddConnectorProps"
},
" extends Pick<",
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
"docId": "kibKbnAiAssistantCtaPluginApi",
"section": "def-public.AssistantCallToActionProps",
"text": "AssistantCallToActionProps"
},
", \"data-test-subj\" | \"centered\">"
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/add_connector/add_connector.tsx",
"deprecated": false,
"trackAdoption": false,
@ -413,6 +447,22 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ai-assistant-cta",
"id": "def-public.AssistantCallToActionProps.centered",
"type": "CompoundType",
"tags": [],
"label": "centered",
"description": [
"\nTrue if the panel is intended to be vertically centered, false otherwise. If true, the panel will compensate for the\nbeacon height to ensure the title and description are centered."
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/call_to_action.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ai-assistant-cta",
"id": "def-public.AssistantCallToActionProps.children",
@ -428,6 +478,22 @@
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/call_to_action.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ai-assistant-cta",
"id": "def-public.AssistantCallToActionProps.datatestsubj",
"type": "string",
"tags": [],
"label": "['data-test-subj']",
"description": [
"Optional test subject for the component."
],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/call_to_action.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -439,7 +505,25 @@
"tags": [],
"label": "InstallKnowledgeBaseProps",
"description": [
"\nProps for the `InstallKnowledgeBase`."
"\nProps for the `InstallKnowledgeBase` call to action."
],
"signature": [
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
"docId": "kibKbnAiAssistantCtaPluginApi",
"section": "def-public.InstallKnowledgeBaseProps",
"text": "InstallKnowledgeBaseProps"
},
" extends Pick<",
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
"docId": "kibKbnAiAssistantCtaPluginApi",
"section": "def-public.AssistantCallToActionProps",
"text": "AssistantCallToActionProps"
},
", \"data-test-subj\" | \"centered\">"
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/install_knowledge_base/install_knowledge_base.tsx",
"deprecated": false,
@ -462,6 +546,38 @@
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/ai-assistant-cta",
"id": "def-public.InstallKnowledgeBaseProps.isInstalling",
"type": "CompoundType",
"tags": [],
"label": "isInstalling",
"description": [
"True if the Knowledge Base is currently installing, false otherwise."
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/install_knowledge_base/install_knowledge_base.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ai-assistant-cta",
"id": "def-public.InstallKnowledgeBaseProps.isInstallAvailable",
"type": "CompoundType",
"tags": [],
"label": "isInstallAvailable",
"description": [
"True if the Knowledge Base can be installed, false otherwise."
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/install_knowledge_base/install_knowledge_base.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -475,6 +591,24 @@
"description": [
"\nProps for the `NeedLicenseUpgrade` call to action."
],
"signature": [
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
"docId": "kibKbnAiAssistantCtaPluginApi",
"section": "def-public.NeedLicenseUpgradeProps",
"text": "NeedLicenseUpgradeProps"
},
" extends Pick<",
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
"docId": "kibKbnAiAssistantCtaPluginApi",
"section": "def-public.AssistantCallToActionProps",
"text": "AssistantCallToActionProps"
},
", \"data-test-subj\" | \"centered\">"
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/need_license_upgrade/need_license_upgrade.tsx",
"deprecated": false,
"trackAdoption": false,
@ -509,6 +643,24 @@
"description": [
"\nProps for the `NeedTierUpgrade` call to action."
],
"signature": [
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
"docId": "kibKbnAiAssistantCtaPluginApi",
"section": "def-public.NeedTierUpgradeProps",
"text": "NeedTierUpgradeProps"
},
" extends Pick<",
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
"docId": "kibKbnAiAssistantCtaPluginApi",
"section": "def-public.AssistantCallToActionProps",
"text": "AssistantCallToActionProps"
},
", \"data-test-subj\" | \"centered\">"
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/need_tier_upgrade/need_tier_upgrade.tsx",
"deprecated": false,
"trackAdoption": false,
@ -543,6 +695,24 @@
"description": [
"\nProps for the `ReadyToHelp`."
],
"signature": [
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
"docId": "kibKbnAiAssistantCtaPluginApi",
"section": "def-public.ReadyToHelpProps",
"text": "ReadyToHelpProps"
},
" extends Pick<",
{
"pluginId": "@kbn/ai-assistant-cta",
"scope": "public",
"docId": "kibKbnAiAssistantCtaPluginApi",
"section": "def-public.AssistantCallToActionProps",
"text": "AssistantCallToActionProps"
},
", \"data-test-subj\" | \"centered\">"
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/ready_to_help/ready_to_help.tsx",
"deprecated": false,
"trackAdoption": false,
@ -568,7 +738,76 @@
}
],
"enums": [],
"misc": [],
"misc": [
{
"parentPluginId": "@kbn/ai-assistant-cta",
"id": "def-public.DATA_TEST_SUBJ_ADD_CONNECTOR_BUTTON",
"type": "string",
"tags": [],
"label": "DATA_TEST_SUBJ_ADD_CONNECTOR_BUTTON",
"description": [
"Data test subject for the add connector button."
],
"signature": [
"\"aiCTAAddConnectorButton\""
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/add_connector/add_connector.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ai-assistant-cta",
"id": "def-public.DATA_TEST_SUBJ_INSTALL_KNOWLEDGE_BASE_BUTTON",
"type": "string",
"tags": [],
"label": "DATA_TEST_SUBJ_INSTALL_KNOWLEDGE_BASE_BUTTON",
"description": [
"Data test subject for the install knowledge base button."
],
"signature": [
"\"aiCTAInstallKnowledgeBaseButton\""
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/install_knowledge_base/install_knowledge_base.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ai-assistant-cta",
"id": "def-public.DATA_TEST_SUBJ_MANAGE_LICENSE_BUTTON",
"type": "string",
"tags": [],
"label": "DATA_TEST_SUBJ_MANAGE_LICENSE_BUTTON",
"description": [
"Data test subject for the manage license button."
],
"signature": [
"\"aiCTAManageLicenseButton\""
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/need_license_upgrade/need_license_upgrade.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ai-assistant-cta",
"id": "def-public.DATA_TEST_SUBJ_MANAGE_SUBSCRIPTION_BUTTON",
"type": "string",
"tags": [],
"label": "DATA_TEST_SUBJ_MANAGE_SUBSCRIPTION_BUTTON",
"description": [
"Data test subject for the manage subscription button."
],
"signature": [
"\"aiCTAManageSubscriptionButton\""
],
"path": "x-pack/platform/packages/shared/ai-assistant/ai-assistant-cta/need_tier_upgrade/need_tier_upgrade.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
},
"server": {

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ai-assistant-cta
title: "@kbn/ai-assistant-cta"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ai-assistant-cta plugin
date: 2025-03-27
date: 2025-03-28
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ai-assistant-cta']
---
import kbnAiAssistantCtaObj from './kbn_ai_assistant_cta.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 28 | 0 | 6 | 0 |
| 37 | 0 | 7 | 0 |
## Client
@ -31,3 +31,6 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
### Interfaces
<DocDefinitionList data={kbnAiAssistantCtaObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={kbnAiAssistantCtaObj.client.misc}/>

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