[api-docs] 2025-05-03 Daily api_docs build (#220018)

Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/1061
This commit is contained in:
Kibana Machine 2025-05-03 08:37:24 +02:00 committed by GitHub
parent c51c0ce212
commit 8e124bbecf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
840 changed files with 4746 additions and 5736 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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';

View file

@ -3167,7 +3167,7 @@
"label": "artifacts",
"description": [],
"signature": [
"Readonly<{ dashboards?: Readonly<{} & { id: string; }>[] | undefined; } & {}> | undefined"
"Readonly<{ dashboards?: Readonly<{} & { id: string; }>[] | undefined; investigation_guide?: Readonly<{} & { blob: string; }> | undefined; } & {}> | undefined"
],
"path": "x-pack/platform/plugins/shared/alerting/server/application/rule/types/rule.ts",
"deprecated": false,
@ -6833,6 +6833,20 @@
"path": "src/platform/packages/shared/kbn-alerting-types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-common.Artifacts.investigation_guide",
"type": "Object",
"tags": [],
"label": "investigation_guide",
"description": [],
"signature": [
"{ blob: string; } | undefined"
],
"path": "src/platform/packages/shared/kbn-alerting-types/rule_types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -11927,6 +11941,85 @@
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.alertMappings.properties.artifacts",
"type": "Object",
"tags": [],
"label": "artifacts",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/saved_objects/rules/mappings.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.alertMappings.properties.artifacts.properties",
"type": "Object",
"tags": [],
"label": "properties",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/saved_objects/rules/mappings.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.alertMappings.properties.artifacts.properties.investigation_guide",
"type": "Object",
"tags": [],
"label": "investigation_guide",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/saved_objects/rules/mappings.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.alertMappings.properties.artifacts.properties.investigation_guide.properties",
"type": "Object",
"tags": [],
"label": "properties",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/saved_objects/rules/mappings.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.alertMappings.properties.artifacts.properties.investigation_guide.properties.blob",
"type": "Object",
"tags": [],
"label": "blob",
"description": [],
"path": "x-pack/platform/plugins/shared/alerting/common/saved_objects/rules/mappings.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.alertMappings.properties.artifacts.properties.investigation_guide.properties.blob.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"text\""
],
"path": "x-pack/platform/plugins/shared/alerting/common/saved_objects/rules/mappings.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
]
}
]
}
]
}
]
},
{
"parentPluginId": "alerting",
"id": "def-common.alertMappings.properties.enabled",

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-05-01
date: 2025-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 899 | 1 | 865 | 52 |
| 906 | 1 | 872 | 52 |
## Client

View file

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

View file

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

View file

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

View file

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

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentManagement
title: "contentManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the contentManagement plugin
date: 2025-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

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

View file

@ -3817,11 +3817,11 @@
"signature": [
"UnifiedHistogramCustomizationId & Pick<",
{
"pluginId": "unifiedHistogram",
"pluginId": "@kbn/unified-histogram",
"scope": "public",
"docId": "kibUnifiedHistogramPluginApi",
"section": "def-public.UnifiedHistogramContainerProps",
"text": "UnifiedHistogramContainerProps"
"docId": "kibKbnUnifiedHistogramPluginApi",
"section": "def-public.UseUnifiedHistogramProps",
"text": "UseUnifiedHistogramProps"
},
", \"onBrushEnd\" | \"withDefaultActions\" | \"disabledActions\" | \"onFilter\">"
],

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

View file

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

View file

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

View file

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

View file

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

View file

@ -117,7 +117,7 @@
"label": "LazyPackageCard",
"description": [],
"signature": [
"React.LazyExoticComponent<({ description, name, title, version, type, icons, integration, url, release, id, fromIntegrations, isReauthorizationRequired, isUnverified, isUpdateAvailable, showLabels, showInstallationStatus, showCompressedInstallationStatus, extraLabelsBadges, isQuickstart, installStatus, onCardClick: onClickProp, isCollectionCard, titleLineClamp, descriptionLineClamp, maxCardHeight, showDescription, showReleaseBadge, }: ",
"React.LazyExoticComponent<({ description, name, title, version, type, icons, integration, url, release, id, fromIntegrations, isReauthorizationRequired, isUnverified, isUpdateAvailable, showLabels, showInstallationStatus, showCompressedInstallationStatus, extraLabelsBadges, isQuickstart, installStatus, onCardClick: onClickProp, isCollectionCard, titleLineClamp, descriptionLineClamp, maxCardHeight, minCardHeight, showDescription, showReleaseBadge, }: ",
{
"pluginId": "fleet",
"scope": "public",
@ -1835,6 +1835,20 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-public.IntegrationCardItem.minCardHeight",
"type": "number",
"tags": [],
"label": "minCardHeight",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/plugins/shared/fleet/public/applications/integrations/sections/epm/screens/home/card_utils.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-public.IntegrationCardItem.name",

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-05-01
date: 2025-05-03
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 |
|-------------------|-----------|------------------------|-----------------|
| 1541 | 5 | 1412 | 91 |
| 1542 | 5 | 1413 | 91 |
## 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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
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-05-01
date: 2025-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
---
import imageEmbeddableObj from './image_embeddable.devdocs.json';

View file

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

View file

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

View file

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

View file

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

View file

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

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-05-01
date: 2025-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ai-assistant-cta']
---
import kbnAiAssistantCtaObj from './kbn_ai_assistant_cta.devdocs.json';

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -66,9 +66,141 @@
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerting-rule-utils",
"id": "def-common.getFormattedGroupBy",
"type": "Function",
"tags": [],
"label": "getFormattedGroupBy",
"description": [],
"signature": [
"(groupBy: string | string[] | undefined, groupSet: Set<string>) => Record<string, ",
{
"pluginId": "@kbn/alerting-rule-utils",
"scope": "common",
"docId": "kibKbnAlertingRuleUtilsPluginApi",
"section": "def-common.Group",
"text": "Group"
},
"[]>"
],
"path": "x-pack/platform/packages/shared/alerting-rule-utils/src/group_by_object_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerting-rule-utils",
"id": "def-common.getFormattedGroupBy.$1",
"type": "CompoundType",
"tags": [],
"label": "groupBy",
"description": [],
"signature": [
"string | string[] | undefined"
],
"path": "x-pack/platform/packages/shared/alerting-rule-utils/src/group_by_object_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/alerting-rule-utils",
"id": "def-common.getFormattedGroupBy.$2",
"type": "Object",
"tags": [],
"label": "groupSet",
"description": [],
"signature": [
"Set<string>"
],
"path": "x-pack/platform/packages/shared/alerting-rule-utils/src/group_by_object_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerting-rule-utils",
"id": "def-common.getGroupByObject",
"type": "Function",
"tags": [],
"label": "getGroupByObject",
"description": [],
"signature": [
"(groupBy: string | string[] | undefined, groupValueSet: Set<string>) => Record<string, unknown>"
],
"path": "x-pack/platform/packages/shared/alerting-rule-utils/src/group_by_object_utils.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerting-rule-utils",
"id": "def-common.getGroupByObject.$1",
"type": "CompoundType",
"tags": [],
"label": "groupBy",
"description": [],
"signature": [
"string | string[] | undefined"
],
"path": "x-pack/platform/packages/shared/alerting-rule-utils/src/group_by_object_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/alerting-rule-utils",
"id": "def-common.getGroupByObject.$2",
"type": "Object",
"tags": [],
"label": "groupValueSet",
"description": [],
"signature": [
"Set<string>"
],
"path": "x-pack/platform/packages/shared/alerting-rule-utils/src/group_by_object_utils.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/alerting-rule-utils",
"id": "def-common.FieldsObject",
"type": "Interface",
"tags": [],
"label": "FieldsObject",
"description": [],
"path": "x-pack/platform/packages/shared/alerting-rule-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/alerting-rule-utils",
"id": "def-common.FieldsObject.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[x: string]: any",
"description": [],
"signature": [
"[x: string]: any"
],
"path": "x-pack/platform/packages/shared/alerting-rule-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/alerting-rule-utils",
"id": "def-common.Group",
@ -76,7 +208,7 @@
"tags": [],
"label": "Group",
"description": [],
"path": "x-pack/platform/packages/shared/alerting-rule-utils/src/get_ecs_groups.ts",
"path": "x-pack/platform/packages/shared/alerting-rule-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
@ -87,7 +219,7 @@
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/platform/packages/shared/alerting-rule-utils/src/get_ecs_groups.ts",
"path": "x-pack/platform/packages/shared/alerting-rule-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
},
@ -98,7 +230,7 @@
"tags": [],
"label": "value",
"description": [],
"path": "x-pack/platform/packages/shared/alerting-rule-utils/src/get_ecs_groups.ts",
"path": "x-pack/platform/packages/shared/alerting-rule-utils/src/types.ts",
"deprecated": false,
"trackAdoption": false
}

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-rule-utils
title: "@kbn/alerting-rule-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerting-rule-utils plugin
date: 2025-05-01
date: 2025-05-03
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-rule-utils']
---
import kbnAlertingRuleUtilsObj from './kbn_alerting_rule_utils.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 5 | 0 | 5 | 0 |
| 13 | 0 | 13 | 0 |
## Common

View file

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

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