mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 10:40:07 -04:00
[api-docs] 2025-05-23 Daily api_docs build (#221328)
Generated by https://buildkite.com/elastic/kibana-api-docs-daily/builds/1081
This commit is contained in:
Kibana Machine
GitHub
parent
12b7429afe
commit
d133c2f6b5
918 changed files with 10507 additions and 5386 deletions
|
|
@ -1203,27 +1203,27 @@
|
|||
"InfoResponse",
|
||||
">; }; ingest: ",
|
||||
"default",
|
||||
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"; knnSearch: { (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
">; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
", unknown>>; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; }; license: ",
|
||||
"TODO",
|
||||
">; }; license: ",
|
||||
"default",
|
||||
"; logstash: ",
|
||||
"default",
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
|
||||
---
|
||||
import actionsObj from './actions.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
|
||||
---
|
||||
import advancedSettingsObj from './advanced_settings.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection']
|
||||
---
|
||||
import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
|
||||
---
|
||||
import aiopsObj from './aiops.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -11330,7 +11330,16 @@
|
|||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.AlertsFilterTimeframe",
|
||||
"text": "AlertsFilterTimeframe"
|
||||
}
|
||||
},
|
||||
" | { kql: string; filters: ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsQueryPluginApi",
|
||||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
"[]; dsl?: string | undefined; }"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/alerting/common/rule.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
|
||||
---
|
||||
import alertingObj from './alerting.devdocs.json';
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
|
||||
---
|
||||
import apmObj from './apm.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -1089,27 +1089,27 @@
|
|||
"InfoResponse",
|
||||
">; }; ingest: ",
|
||||
"default",
|
||||
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"; knnSearch: { (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
">; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
", unknown>>; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; }; license: ",
|
||||
"TODO",
|
||||
">; }; license: ",
|
||||
"default",
|
||||
"; logstash: ",
|
||||
"default",
|
||||
|
|
@ -1701,17 +1701,6 @@
|
|||
"path": "x-pack/solutions/observability/plugins/apm_data_access/server/services/get_document_sources/get_document_sources.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "apmDataAccess",
|
||||
"id": "def-server.DocumentSourcesRequest.enableContinuousRollups",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "enableContinuousRollups",
|
||||
"description": [],
|
||||
"path": "x-pack/solutions/observability/plugins/apm_data_access/server/services/get_document_sources/get_document_sources.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -1921,7 +1910,7 @@
|
|||
"label": "ApmDataAccessServices",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ getDocumentSources: ({ enableContinuousRollups, end, kuery, start, }: Omit<",
|
||||
"{ getDocumentSources: ({ end, kuery, start }: Omit<",
|
||||
{
|
||||
"pluginId": "apmDataAccess",
|
||||
"scope": "server",
|
||||
|
|
@ -2097,7 +2086,7 @@
|
|||
"section": "def-server.ApmDataAccessServicesParams",
|
||||
"text": "ApmDataAccessServicesParams"
|
||||
},
|
||||
") => { getDocumentSources: ({ enableContinuousRollups, end, kuery, start, }: Omit<",
|
||||
") => { getDocumentSources: ({ end, kuery, start }: Omit<",
|
||||
{
|
||||
"pluginId": "apmDataAccess",
|
||||
"scope": "server",
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
|
||||
---
|
||||
import apmDataAccessObj from './apm_data_access.devdocs.json';
|
||||
|
|
@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/te
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 91 | 0 | 91 | 3 |
|
||||
| 90 | 0 | 90 | 3 |
|
||||
|
||||
## Server
|
||||
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmSourcesAccess']
|
||||
---
|
||||
import apmSourcesAccessObj from './apm_sources_access.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'automaticImport']
|
||||
---
|
||||
import automaticImportObj from './automatic_import.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
|
||||
---
|
||||
import bannersObj from './banners.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
|
||||
---
|
||||
import canvasObj from './canvas.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
|
||||
---
|
||||
import casesObj from './cases.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
|
||||
---
|
||||
import chartsObj from './charts.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
|
||||
---
|
||||
import cloudObj from './cloud.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
|
||||
---
|
||||
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -288,6 +288,54 @@
|
|||
"trackAdoption": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cloudSecurityPosture",
|
||||
"id": "def-public.CspClientPluginStart.getCloudSecurityPostureVulnerabilityFlyout",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getCloudSecurityPostureVulnerabilityFlyout",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => { Component: React.FC<",
|
||||
{
|
||||
"pluginId": "@kbn/cloud-security-posture",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnCloudSecurityPosturePluginApi",
|
||||
"section": "def-public.FindingVulnerabilityFlyoutProps",
|
||||
"text": "FindingVulnerabilityFlyoutProps"
|
||||
},
|
||||
">; Header: React.FC<",
|
||||
{
|
||||
"pluginId": "@kbn/cloud-security-posture",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnCloudSecurityPosturePluginApi",
|
||||
"section": "def-public.FindingsVulnerabilityFlyoutHeaderProps",
|
||||
"text": "FindingsVulnerabilityFlyoutHeaderProps"
|
||||
},
|
||||
">; Body: React.FC<",
|
||||
{
|
||||
"pluginId": "@kbn/cloud-security-posture",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnCloudSecurityPosturePluginApi",
|
||||
"section": "def-public.FindingsVulnerabilityFlyoutContentProps",
|
||||
"text": "FindingsVulnerabilityFlyoutContentProps"
|
||||
},
|
||||
">; Footer: React.FC<",
|
||||
{
|
||||
"pluginId": "@kbn/cloud-security-posture",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnCloudSecurityPosturePluginApi",
|
||||
"section": "def-public.FindingsVulnerabilityFlyoutFooterProps",
|
||||
"text": "FindingsVulnerabilityFlyoutFooterProps"
|
||||
},
|
||||
">; }"
|
||||
],
|
||||
"path": "x-pack/solutions/security/plugins/cloud_security_posture/public/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
|
||||
---
|
||||
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';
|
||||
|
|
@ -21,7 +21,7 @@ Contact [@elastic/kibana-cloud-security-posture](https://github.com/orgs/elastic
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 17 | 0 | 6 | 3 |
|
||||
| 18 | 0 | 7 | 3 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
|
||||
---
|
||||
import consoleObj from './console.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentConnectors']
|
||||
---
|
||||
import contentConnectorsObj from './content_connectors.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
|
||||
---
|
||||
import contentManagementObj from './content_management.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -49,6 +49,99 @@
|
|||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "controls",
|
||||
"id": "def-public.serializeRuntimeState",
|
||||
"type": "Function",
|
||||
"tags": [
|
||||
"deprecated"
|
||||
],
|
||||
"label": "serializeRuntimeState",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(runtimeState: Partial<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.ControlGroupRuntimeState",
|
||||
"text": "ControlGroupRuntimeState"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.DefaultControlState",
|
||||
"text": "DefaultControlState"
|
||||
},
|
||||
">>) => ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.SerializedPanelState",
|
||||
"text": "SerializedPanelState"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.ControlGroupSerializedState",
|
||||
"text": "ControlGroupSerializedState"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/controls/public/control_group/utils/serialize_runtime_state.ts",
|
||||
"deprecated": true,
|
||||
"trackAdoption": false,
|
||||
"references": [
|
||||
{
|
||||
"plugin": "dashboard",
|
||||
"path": "src/platform/plugins/shared/dashboard/public/dashboard_app/url/url_utils.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "dashboard",
|
||||
"path": "src/platform/plugins/shared/dashboard/public/dashboard_app/url/url_utils.ts"
|
||||
}
|
||||
],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "controls",
|
||||
"id": "def-public.serializeRuntimeState.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "runtimeState",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Partial<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.ControlGroupRuntimeState",
|
||||
"text": "ControlGroupRuntimeState"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.DefaultControlState",
|
||||
"text": "DefaultControlState"
|
||||
},
|
||||
">>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/controls/public/control_group/utils/serialize_runtime_state.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [
|
||||
|
|
@ -1127,7 +1220,7 @@
|
|||
"section": "def-public.PresentationContainer",
|
||||
"text": "PresentationContainer"
|
||||
},
|
||||
" & ",
|
||||
"<unknown> & ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
|
|
@ -1143,23 +1236,7 @@
|
|||
"section": "def-common.ControlGroupSerializedState",
|
||||
"text": "ControlGroupSerializedState"
|
||||
},
|
||||
", ",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.ControlGroupRuntimeState",
|
||||
"text": "ControlGroupRuntimeState"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.DefaultControlState",
|
||||
"text": "DefaultControlState"
|
||||
},
|
||||
">> & ",
|
||||
"> & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -1215,31 +1292,15 @@
|
|||
"section": "def-public.HasEditCapabilities",
|
||||
"text": "HasEditCapabilities"
|
||||
},
|
||||
" & Pick<",
|
||||
" & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"pluginId": "@kbn/presentation-containers",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.PublishesUnsavedChanges",
|
||||
"text": "PublishesUnsavedChanges"
|
||||
"docId": "kibKbnPresentationContainersPluginApi",
|
||||
"section": "def-public.HasLastSavedChildState",
|
||||
"text": "HasLastSavedChildState"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.ControlGroupRuntimeState",
|
||||
"text": "ControlGroupRuntimeState"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.DefaultControlState",
|
||||
"text": "DefaultControlState"
|
||||
},
|
||||
">>, \"unsavedChanges$\"> & ",
|
||||
"<object> & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -1255,6 +1316,14 @@
|
|||
"section": "def-public.PublishesDisabledActionIds",
|
||||
"text": "PublishesDisabledActionIds"
|
||||
},
|
||||
" & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.PublishesUnsavedChanges",
|
||||
"text": "PublishesUnsavedChanges"
|
||||
},
|
||||
" & Partial<",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
|
|
@ -1272,14 +1341,6 @@
|
|||
"text": "PublishesUnifiedSearch"
|
||||
},
|
||||
"> & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-containers",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationContainersPluginApi",
|
||||
"section": "def-public.HasSaveNotification",
|
||||
"text": "HasSaveNotification"
|
||||
},
|
||||
" & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -1335,7 +1396,7 @@
|
|||
"section": "def-common.ControlLabelPosition",
|
||||
"text": "ControlLabelPosition"
|
||||
},
|
||||
">; asyncResetUnsavedChanges: () => Promise<void>; controlFetch$: (controlUuid: string, onReload?: (() => void) | undefined) => ",
|
||||
">; controlFetch$: (controlUuid: string, onReload?: (() => void) | undefined) => ",
|
||||
"Observable",
|
||||
"<",
|
||||
"ControlFetchContext",
|
||||
|
|
@ -1363,7 +1424,7 @@
|
|||
"section": "def-common.ControlGroupEditorConfig",
|
||||
"text": "ControlGroupEditorConfig"
|
||||
},
|
||||
" | undefined; getLastSavedControlState: (controlUuid: string) => object; setChainingSystem: (chainingSystem: ",
|
||||
" | undefined; setChainingSystem: (chainingSystem: ",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
|
|
@ -1393,7 +1454,7 @@
|
|||
"section": "def-public.PresentationContainer",
|
||||
"text": "PresentationContainer"
|
||||
},
|
||||
" & ",
|
||||
"<unknown> & ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
|
|
@ -1409,23 +1470,7 @@
|
|||
"section": "def-common.ControlGroupSerializedState",
|
||||
"text": "ControlGroupSerializedState"
|
||||
},
|
||||
", ",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.ControlGroupRuntimeState",
|
||||
"text": "ControlGroupRuntimeState"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.DefaultControlState",
|
||||
"text": "DefaultControlState"
|
||||
},
|
||||
">> & ",
|
||||
"> & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -1481,31 +1526,15 @@
|
|||
"section": "def-public.HasEditCapabilities",
|
||||
"text": "HasEditCapabilities"
|
||||
},
|
||||
" & Pick<",
|
||||
" & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"pluginId": "@kbn/presentation-containers",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.PublishesUnsavedChanges",
|
||||
"text": "PublishesUnsavedChanges"
|
||||
"docId": "kibKbnPresentationContainersPluginApi",
|
||||
"section": "def-public.HasLastSavedChildState",
|
||||
"text": "HasLastSavedChildState"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.ControlGroupRuntimeState",
|
||||
"text": "ControlGroupRuntimeState"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.DefaultControlState",
|
||||
"text": "DefaultControlState"
|
||||
},
|
||||
">>, \"unsavedChanges$\"> & ",
|
||||
"<object> & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -1521,6 +1550,14 @@
|
|||
"section": "def-public.PublishesDisabledActionIds",
|
||||
"text": "PublishesDisabledActionIds"
|
||||
},
|
||||
" & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.PublishesUnsavedChanges",
|
||||
"text": "PublishesUnsavedChanges"
|
||||
},
|
||||
" & Partial<",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
|
|
@ -1538,14 +1575,6 @@
|
|||
"text": "PublishesUnifiedSearch"
|
||||
},
|
||||
"> & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-containers",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationContainersPluginApi",
|
||||
"section": "def-public.HasSaveNotification",
|
||||
"text": "HasSaveNotification"
|
||||
},
|
||||
" & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -1601,7 +1630,7 @@
|
|||
"section": "def-common.ControlLabelPosition",
|
||||
"text": "ControlLabelPosition"
|
||||
},
|
||||
">; asyncResetUnsavedChanges: () => Promise<void>; controlFetch$: (controlUuid: string, onReload?: (() => void) | undefined) => ",
|
||||
">; controlFetch$: (controlUuid: string, onReload?: (() => void) | undefined) => ",
|
||||
"Observable",
|
||||
"<",
|
||||
"ControlFetchContext",
|
||||
|
|
@ -1629,7 +1658,7 @@
|
|||
"section": "def-common.ControlGroupEditorConfig",
|
||||
"text": "ControlGroupEditorConfig"
|
||||
},
|
||||
" | undefined; getLastSavedControlState: (controlUuid: string) => object; setChainingSystem: (chainingSystem: ",
|
||||
" | undefined; setChainingSystem: (chainingSystem: ",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
|
|
@ -1654,7 +1683,7 @@
|
|||
"text": "DefaultControlState"
|
||||
},
|
||||
">>) => void; getInput$: () => ",
|
||||
"BehaviorSubject",
|
||||
"Observable",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
|
|
@ -1671,7 +1700,23 @@
|
|||
"section": "def-common.DefaultControlState",
|
||||
"text": "DefaultControlState"
|
||||
},
|
||||
">>; }"
|
||||
">>; getInput: () => ",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.ControlGroupRuntimeState",
|
||||
"text": "ControlGroupRuntimeState"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.DefaultControlState",
|
||||
"text": "DefaultControlState"
|
||||
},
|
||||
">; }"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/controls/public/control_group/control_group_renderer/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -1858,7 +1903,7 @@
|
|||
"section": "def-public.PublishesUnsavedChanges",
|
||||
"text": "PublishesUnsavedChanges"
|
||||
},
|
||||
"<object> & Partial<",
|
||||
" & Partial<",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -1926,7 +1971,7 @@
|
|||
"section": "def-public.ControlGroupApi",
|
||||
"text": "ControlGroupApi"
|
||||
},
|
||||
"> & { setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; grow: ",
|
||||
"> & { setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; grow$: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -1934,7 +1979,7 @@
|
|||
"section": "def-public.PublishingSubject",
|
||||
"text": "PublishingSubject"
|
||||
},
|
||||
"<boolean | undefined>; width: ",
|
||||
"<boolean | undefined>; width$: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2022,7 +2067,7 @@
|
|||
"section": "def-public.PublishesUnsavedChanges",
|
||||
"text": "PublishesUnsavedChanges"
|
||||
},
|
||||
"<object> & Partial<",
|
||||
" & Partial<",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2090,7 +2135,7 @@
|
|||
"section": "def-public.ControlGroupApi",
|
||||
"text": "ControlGroupApi"
|
||||
},
|
||||
"> & { setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; grow: ",
|
||||
"> & { setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; grow$: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2098,7 +2143,7 @@
|
|||
"section": "def-public.PublishingSubject",
|
||||
"text": "PublishingSubject"
|
||||
},
|
||||
"<boolean | undefined>; width: ",
|
||||
"<boolean | undefined>; width$: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2167,7 +2212,7 @@
|
|||
"section": "def-public.PublishesUnsavedChanges",
|
||||
"text": "PublishesUnsavedChanges"
|
||||
},
|
||||
"<object> & Partial<",
|
||||
" & Partial<",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2235,7 +2280,7 @@
|
|||
"section": "def-public.ControlGroupApi",
|
||||
"text": "ControlGroupApi"
|
||||
},
|
||||
"> & { setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; grow: ",
|
||||
"> & { setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; grow$: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2243,7 +2288,7 @@
|
|||
"section": "def-public.PublishingSubject",
|
||||
"text": "PublishingSubject"
|
||||
},
|
||||
"<boolean | undefined>; width: ",
|
||||
"<boolean | undefined>; width$: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2336,7 +2381,7 @@
|
|||
"section": "def-public.PublishesUnsavedChanges",
|
||||
"text": "PublishesUnsavedChanges"
|
||||
},
|
||||
"<object> & Partial<",
|
||||
" & Partial<",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2404,7 +2449,7 @@
|
|||
"section": "def-public.ControlGroupApi",
|
||||
"text": "ControlGroupApi"
|
||||
},
|
||||
"> & { setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; grow: ",
|
||||
"> & { setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; grow$: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2412,7 +2457,7 @@
|
|||
"section": "def-public.PublishingSubject",
|
||||
"text": "PublishingSubject"
|
||||
},
|
||||
"<boolean | undefined>; width: ",
|
||||
"<boolean | undefined>; width$: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2517,7 +2562,7 @@
|
|||
"section": "def-public.PublishesUnsavedChanges",
|
||||
"text": "PublishesUnsavedChanges"
|
||||
},
|
||||
"<object> & Partial<",
|
||||
" & Partial<",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2585,7 +2630,7 @@
|
|||
"section": "def-public.ControlGroupApi",
|
||||
"text": "ControlGroupApi"
|
||||
},
|
||||
"> & { setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; grow: ",
|
||||
"> & { setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; grow$: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2593,7 +2638,7 @@
|
|||
"section": "def-public.PublishingSubject",
|
||||
"text": "PublishingSubject"
|
||||
},
|
||||
"<boolean | undefined>; width: ",
|
||||
"<boolean | undefined>; width$: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2696,7 +2741,7 @@
|
|||
"section": "def-public.PublishesUnsavedChanges",
|
||||
"text": "PublishesUnsavedChanges"
|
||||
},
|
||||
"<object> & Partial<",
|
||||
" & Partial<",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2764,7 +2809,7 @@
|
|||
"section": "def-public.ControlGroupApi",
|
||||
"text": "ControlGroupApi"
|
||||
},
|
||||
"> & { setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; grow: ",
|
||||
"> & { setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; grow$: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -2772,7 +2817,7 @@
|
|||
"section": "def-public.PublishingSubject",
|
||||
"text": "PublishingSubject"
|
||||
},
|
||||
"<boolean | undefined>; width: ",
|
||||
"<boolean | undefined>; width$: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
|
||||
---
|
||||
import controlsObj from './controls.devdocs.json';
|
||||
|
|
@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 142 | 0 | 138 | 15 |
|
||||
| 144 | 0 | 140 | 15 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
|
||||
---
|
||||
import customIntegrationsObj from './custom_integrations.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -523,7 +523,7 @@
|
|||
"section": "def-public.EmbeddablePackageState",
|
||||
"text": "EmbeddablePackageState"
|
||||
},
|
||||
" | undefined) | undefined"
|
||||
"<object> | undefined) | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -563,6 +563,8 @@
|
|||
"section": "def-public.DashboardApi",
|
||||
"text": "DashboardApi"
|
||||
},
|
||||
", dashboardInternalApi: ",
|
||||
"DashboardInternalApi",
|
||||
") => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -1033,18 +1035,10 @@
|
|||
"pluginId": "@kbn/presentation-containers",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationContainersPluginApi",
|
||||
"section": "def-public.HasRuntimeChildState",
|
||||
"text": "HasRuntimeChildState"
|
||||
"section": "def-public.HasLastSavedChildState",
|
||||
"text": "HasLastSavedChildState"
|
||||
},
|
||||
"<object> & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-containers",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationContainersPluginApi",
|
||||
"section": "def-public.HasSaveNotification",
|
||||
"text": "HasSaveNotification"
|
||||
},
|
||||
" & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-containers",
|
||||
"scope": "public",
|
||||
|
|
@ -1076,7 +1070,7 @@
|
|||
"section": "def-public.PresentationContainer",
|
||||
"text": "PresentationContainer"
|
||||
},
|
||||
" & ",
|
||||
"<unknown> & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -1270,15 +1264,17 @@
|
|||
"section": "def-server.Reference",
|
||||
"text": "Reference"
|
||||
},
|
||||
"[]; }; getDashboardPanelFromId: (id: string) => ",
|
||||
"[]; }; getDashboardPanelFromId: (id: string) => { type: string; gridData: ",
|
||||
"GridData",
|
||||
"; serializedState: ",
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"scope": "common",
|
||||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-common.DashboardPanelState",
|
||||
"text": "DashboardPanelState"
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.SerializedPanelState",
|
||||
"text": "SerializedPanelState"
|
||||
},
|
||||
"<object>; hasOverlays$: ",
|
||||
"<object>; }; hasOverlays$: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -1318,23 +1314,7 @@
|
|||
"section": "def-common.DashboardLocatorParams",
|
||||
"text": "DashboardLocatorParams"
|
||||
},
|
||||
">, \"navigate\" | \"getRedirectUrl\"> | undefined; panels$: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.PublishingSubject",
|
||||
"text": "PublishingSubject"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"scope": "common",
|
||||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-common.DashboardPanelMap",
|
||||
"text": "DashboardPanelMap"
|
||||
},
|
||||
">; runInteractiveSave: () => Promise<",
|
||||
">, \"navigate\" | \"getRedirectUrl\"> | undefined; runInteractiveSave: () => Promise<",
|
||||
"SaveDashboardReturn",
|
||||
" | undefined>; runQuickSave: () => Promise<void>; scrollToPanel: (panelRef: HTMLDivElement) => void; scrollToPanelId$: ",
|
||||
{
|
||||
|
|
@ -1352,15 +1332,7 @@
|
|||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
"[] | undefined) => void; setFullScreenMode: (fullScreenMode: boolean) => void; setHighlightPanelId: (id: string | undefined) => void; setPanels: (panels: ",
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"scope": "common",
|
||||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-common.DashboardPanelMap",
|
||||
"text": "DashboardPanelMap"
|
||||
},
|
||||
") => void; setQuery: (query?: ",
|
||||
"[] | undefined) => void; setFullScreenMode: (fullScreenMode: boolean) => void; setHighlightPanelId: (id: string | undefined) => void; setQuery: (query?: ",
|
||||
{
|
||||
"pluginId": "@kbn/es-query",
|
||||
"scope": "common",
|
||||
|
|
@ -1400,7 +1372,7 @@
|
|||
"section": "def-common.Filter",
|
||||
"text": "Filter"
|
||||
},
|
||||
"[] | undefined>; untilEmbeddableLoaded: (id: string) => Promise<unknown>; }"
|
||||
"[] | undefined>; }"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -2097,38 +2069,6 @@
|
|||
"path": "src/platform/plugins/shared/dashboard/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-common.DashboardState.controlGroupState",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "controlGroupState",
|
||||
"description": [
|
||||
"\nRuntime control group state.\nContains state passed from dashboard locator\nUse runtime state when building input for portable dashboards"
|
||||
],
|
||||
"signature": [
|
||||
"Partial<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.ControlGroupRuntimeState",
|
||||
"text": "ControlGroupRuntimeState"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.DefaultControlState",
|
||||
"text": "DefaultControlState"
|
||||
},
|
||||
">> | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/dashboard/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -2187,7 +2127,7 @@
|
|||
"label": "DashboardLocatorParams",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Partial<Omit<",
|
||||
"Partial<Partial<Omit<",
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"scope": "common",
|
||||
|
|
@ -2195,9 +2135,15 @@
|
|||
"section": "def-common.DashboardState",
|
||||
"text": "DashboardState"
|
||||
},
|
||||
", \"references\" | \"controlGroupInput\" | \"panels\">> & { dashboardId?: string | undefined; useHash?: boolean | undefined; preserveSavedFilters?: boolean | undefined; searchSessionId?: string | undefined; panels?: (Omit<Readonly<{ id?: string | undefined; version?: string | undefined; title?: string | undefined; panelRefName?: string | undefined; panelIndex?: string | undefined; } & { type: string; panelConfig: Readonly<{ version?: string | undefined; title?: string | undefined; description?: string | undefined; hidePanelTitles?: boolean | undefined; enhancements?: Record<string, any> | undefined; savedObjectId?: string | undefined; } & {}>; gridData: Readonly<{ i?: string | undefined; } & { y: number; w: number; h: number; x: number; }>; }>, \"panelConfig\"> & { panelConfig: Readonly<{ version?: string | undefined; title?: string | undefined; description?: string | undefined; hidePanelTitles?: boolean | undefined; enhancements?: Record<string, any> | undefined; savedObjectId?: string | undefined; } & {}> & { [key: string]: any; }; gridData: ",
|
||||
"GridData",
|
||||
"; } & ",
|
||||
", \"panels\"> & { controlGroupInput?: (",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
"docId": "kibControlsPluginApi",
|
||||
"section": "def-common.ControlGroupSerializedState",
|
||||
"text": "ControlGroupSerializedState"
|
||||
},
|
||||
" & ",
|
||||
{
|
||||
"pluginId": "@kbn/utility-types",
|
||||
"scope": "common",
|
||||
|
|
@ -2205,7 +2151,7 @@
|
|||
"section": "def-common.SerializableRecord",
|
||||
"text": "SerializableRecord"
|
||||
},
|
||||
")[] | undefined; controlGroupState?: (Partial<",
|
||||
") | undefined; controlGroupState?: (Partial<",
|
||||
{
|
||||
"pluginId": "controls",
|
||||
"scope": "common",
|
||||
|
|
@ -2229,7 +2175,31 @@
|
|||
"section": "def-common.SerializableRecord",
|
||||
"text": "SerializableRecord"
|
||||
},
|
||||
") | undefined; }"
|
||||
") | undefined; panels: ",
|
||||
{
|
||||
"pluginId": "dashboard",
|
||||
"scope": "server",
|
||||
"docId": "kibDashboardPluginApi",
|
||||
"section": "def-server.DashboardPanel",
|
||||
"text": "DashboardPanel"
|
||||
},
|
||||
"[]; references?: (",
|
||||
{
|
||||
"pluginId": "@kbn/content-management-utils",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnContentManagementUtilsPluginApi",
|
||||
"section": "def-server.Reference",
|
||||
"text": "Reference"
|
||||
},
|
||||
"[] & ",
|
||||
{
|
||||
"pluginId": "@kbn/utility-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnUtilityTypesPluginApi",
|
||||
"section": "def-common.SerializableRecord",
|
||||
"text": "SerializableRecord"
|
||||
},
|
||||
") | undefined; }>> & { dashboardId?: string | undefined; useHash?: boolean | undefined; preserveSavedFilters?: boolean | undefined; searchSessionId?: string | undefined; }"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/dashboard/common/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -2244,7 +2214,14 @@
|
|||
"label": "DashboardSettings",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{} & { hidePanelTitles: boolean; useMargins: boolean; syncColors: boolean; syncTooltips: boolean; syncCursor: boolean; }> & { description?: string | undefined; tags: string[]; timeRestore: boolean; title: string; }"
|
||||
{
|
||||
"pluginId": "@kbn/utility-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnUtilityTypesPluginApi",
|
||||
"section": "def-common.Writable",
|
||||
"text": "Writable"
|
||||
},
|
||||
"<Readonly<{} & { hidePanelTitles: boolean; useMargins: boolean; syncColors: boolean; syncTooltips: boolean; syncCursor: boolean; }>> & { description?: string | undefined; tags: string[]; timeRestore: boolean; title: string; }"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/dashboard/common/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
|
||||
---
|
||||
import dashboardObj from './dashboard.devdocs.json';
|
||||
|
|
@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 88 | 0 | 82 | 10 |
|
||||
| 87 | 0 | 82 | 11 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
|
||||
---
|
||||
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -4824,7 +4824,7 @@
|
|||
"section": "def-common.SerializedSearchSourceFields",
|
||||
"text": "SerializedSearchSourceFields"
|
||||
},
|
||||
" & { indexRefName: string; }, references: ",
|
||||
" & { indexRefName?: string | undefined; }, references: ",
|
||||
"SavedObjectReference",
|
||||
"[]) => ",
|
||||
{
|
||||
|
|
@ -4854,7 +4854,7 @@
|
|||
"section": "def-common.SerializedSearchSourceFields",
|
||||
"text": "SerializedSearchSourceFields"
|
||||
},
|
||||
" & { indexRefName: string; }"
|
||||
" & { indexRefName?: string | undefined; }"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/data/common/search/search_source/inject_references.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -16324,27 +16324,27 @@
|
|||
"InfoResponse",
|
||||
">; }; ingest: ",
|
||||
"default",
|
||||
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"; knnSearch: { (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
">; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
", unknown>>; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; }; license: ",
|
||||
"TODO",
|
||||
">; }; license: ",
|
||||
"default",
|
||||
"; logstash: ",
|
||||
"default",
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
|
||||
---
|
||||
import dataObj from './data.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataQuality']
|
||||
---
|
||||
import dataQualityObj from './data_quality.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
|
||||
---
|
||||
import dataQueryObj from './data_query.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -10984,7 +10984,7 @@
|
|||
"section": "def-common.SerializedSearchSourceFields",
|
||||
"text": "SerializedSearchSourceFields"
|
||||
},
|
||||
" & { indexRefName: string; }, references: ",
|
||||
" & { indexRefName?: string | undefined; }, references: ",
|
||||
"SavedObjectReference",
|
||||
"[]) => ",
|
||||
{
|
||||
|
|
@ -15657,7 +15657,7 @@
|
|||
"section": "def-common.SerializedSearchSourceFields",
|
||||
"text": "SerializedSearchSourceFields"
|
||||
},
|
||||
" & { indexRefName: string; }, references: ",
|
||||
" & { indexRefName?: string | undefined; }, references: ",
|
||||
"SavedObjectReference",
|
||||
"[]) => ",
|
||||
{
|
||||
|
|
@ -15687,7 +15687,7 @@
|
|||
"section": "def-common.SerializedSearchSourceFields",
|
||||
"text": "SerializedSearchSourceFields"
|
||||
},
|
||||
" & { indexRefName: string; }"
|
||||
" & { indexRefName?: string | undefined; }"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/data/common/search/search_source/inject_references.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
|
||||
---
|
||||
import dataSearchObj from './data_search.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataUsage']
|
||||
---
|
||||
import dataUsageObj from './data_usage.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
|
||||
---
|
||||
import dataViewEditorObj from './data_view_editor.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
|
||||
---
|
||||
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
|
||||
---
|
||||
import dataViewManagementObj from './data_view_management.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -13012,27 +13012,27 @@
|
|||
"InfoResponse",
|
||||
">; }; ingest: ",
|
||||
"default",
|
||||
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"; knnSearch: { (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
">; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
", unknown>>; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; }; license: ",
|
||||
"TODO",
|
||||
">; }; license: ",
|
||||
"default",
|
||||
"; logstash: ",
|
||||
"default",
|
||||
|
|
@ -13646,6 +13646,10 @@
|
|||
"plugin": "@kbn/unified-field-list",
|
||||
"path": "src/platform/packages/shared/kbn-unified-field-list/src/hooks/use_existing_fields.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "controls",
|
||||
"path": "src/platform/plugins/shared/controls/public/controls/data_controls/options_list_control/options_list_fetch_cache.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "lens",
|
||||
"path": "x-pack/platform/plugins/shared/lens/public/data_views_service/loader.ts"
|
||||
|
|
@ -13654,10 +13658,6 @@
|
|||
"plugin": "lens",
|
||||
"path": "x-pack/platform/plugins/shared/lens/public/app_plugin/lens_top_nav.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "controls",
|
||||
"path": "src/platform/plugins/shared/controls/public/controls/data_controls/options_list_control/options_list_fetch_cache.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "@kbn/lens-embeddable-utils",
|
||||
"path": "src/platform/packages/shared/kbn-lens-embeddable-utils/config_builder/columns/breakdown.ts"
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
|
||||
---
|
||||
import dataViewsObj from './data_views.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
|
||||
---
|
||||
import dataVisualizerObj from './data_visualizer.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -89,7 +89,7 @@
|
|||
"label": "getDataStreamsStats",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(params?: (({ types: (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[]; } | { datasetQuery: string; }) & { includeCreationDate?: boolean | undefined; }) | undefined) => Promise<{ datasetUserPrivileges: { canMonitor: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }>"
|
||||
"(params?: (({ types: (\"profiling\" | \"metrics\" | \"synthetics\" | \"traces\" | \"logs\")[]; } | { datasetQuery: string; }) & { includeCreationDate?: boolean | undefined; }) | undefined) => Promise<{ datasetUserPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }>"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/dataset_quality/public/services/data_streams_stats/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -273,7 +273,7 @@
|
|||
"label": "DataStreamStatServiceResponse",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ datasetUserPrivileges: { canMonitor: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }"
|
||||
"{ datasetUserPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/dataset_quality/common/data_streams_stats/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -698,7 +698,7 @@
|
|||
"StringC",
|
||||
"; }>; }>, ",
|
||||
"DatasetQualityRouteHandlerResources",
|
||||
", { lastBackingIndexName?: string | undefined; indexTemplate?: string | undefined; createdOn?: number | null | undefined; integration?: string | undefined; datasetUserPrivileges?: ({ canMonitor: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }) | undefined; }, ",
|
||||
", { lastBackingIndexName?: string | undefined; indexTemplate?: string | undefined; createdOn?: number | null | undefined; integration?: string | undefined; datasetUserPrivileges?: ({ canMonitor: boolean; canReadFailureStore: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }) | undefined; }, ",
|
||||
"DatasetQualityRouteCreateOptions",
|
||||
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/details\": ",
|
||||
{
|
||||
|
|
@ -722,7 +722,7 @@
|
|||
"Type",
|
||||
"<number, string, unknown>; }>; }>, ",
|
||||
"DatasetQualityRouteHandlerResources",
|
||||
", { lastActivity?: number | undefined; degradedDocsCount?: number | undefined; failedDocsCount?: number | undefined; docsCount?: number | undefined; sizeBytes?: number | undefined; services?: { [x: string]: string[]; } | undefined; hosts?: { [x: string]: string[]; } | undefined; userPrivileges?: { canMonitor: boolean; } | undefined; }, ",
|
||||
", { lastActivity?: number | undefined; degradedDocsCount?: number | undefined; failedDocsCount?: number | undefined; docsCount?: number | undefined; sizeBytes?: number | undefined; services?: { [x: string]: string[]; } | undefined; hosts?: { [x: string]: string[]; } | undefined; userPrivileges?: { canMonitor: boolean; canReadFailureStore: boolean; } | undefined; }, ",
|
||||
"DatasetQualityRouteCreateOptions",
|
||||
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_field/{degradedField}/values\": ",
|
||||
{
|
||||
|
|
@ -912,7 +912,7 @@
|
|||
"Type",
|
||||
"<boolean, boolean, unknown>; }>]>; }>, ",
|
||||
"DatasetQualityRouteHandlerResources",
|
||||
", { datasetUserPrivileges: { canMonitor: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }, ",
|
||||
", { datasetUserPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }, ",
|
||||
"DatasetQualityRouteCreateOptions",
|
||||
">; }[TEndpoint] extends ",
|
||||
{
|
||||
|
|
@ -1167,7 +1167,7 @@
|
|||
"StringC",
|
||||
"; }>; }>, ",
|
||||
"DatasetQualityRouteHandlerResources",
|
||||
", { lastBackingIndexName?: string | undefined; indexTemplate?: string | undefined; createdOn?: number | null | undefined; integration?: string | undefined; datasetUserPrivileges?: ({ canMonitor: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }) | undefined; }, ",
|
||||
", { lastBackingIndexName?: string | undefined; indexTemplate?: string | undefined; createdOn?: number | null | undefined; integration?: string | undefined; datasetUserPrivileges?: ({ canMonitor: boolean; canReadFailureStore: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }) | undefined; }, ",
|
||||
"DatasetQualityRouteCreateOptions",
|
||||
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/details\": ",
|
||||
{
|
||||
|
|
@ -1191,7 +1191,7 @@
|
|||
"Type",
|
||||
"<number, string, unknown>; }>; }>, ",
|
||||
"DatasetQualityRouteHandlerResources",
|
||||
", { lastActivity?: number | undefined; degradedDocsCount?: number | undefined; failedDocsCount?: number | undefined; docsCount?: number | undefined; sizeBytes?: number | undefined; services?: { [x: string]: string[]; } | undefined; hosts?: { [x: string]: string[]; } | undefined; userPrivileges?: { canMonitor: boolean; } | undefined; }, ",
|
||||
", { lastActivity?: number | undefined; degradedDocsCount?: number | undefined; failedDocsCount?: number | undefined; docsCount?: number | undefined; sizeBytes?: number | undefined; services?: { [x: string]: string[]; } | undefined; hosts?: { [x: string]: string[]; } | undefined; userPrivileges?: { canMonitor: boolean; canReadFailureStore: boolean; } | undefined; }, ",
|
||||
"DatasetQualityRouteCreateOptions",
|
||||
">; \"GET /internal/dataset_quality/data_streams/{dataStream}/degraded_field/{degradedField}/values\": ",
|
||||
{
|
||||
|
|
@ -1381,7 +1381,7 @@
|
|||
"Type",
|
||||
"<boolean, boolean, unknown>; }>]>; }>, ",
|
||||
"DatasetQualityRouteHandlerResources",
|
||||
", { datasetUserPrivileges: { canMonitor: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }, ",
|
||||
", { datasetUserPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }; dataStreamsStats: ({ name: string; userPrivileges: { canMonitor: boolean; canReadFailureStore: boolean; }; } & { size?: string | undefined; sizeBytes?: number | undefined; lastActivity?: number | undefined; integration?: string | undefined; totalDocs?: number | undefined; creationDate?: number | undefined; })[]; }, ",
|
||||
"DatasetQualityRouteCreateOptions",
|
||||
">; }[TEndpoint] extends ",
|
||||
{
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality']
|
||||
---
|
||||
import datasetQualityObj from './dataset_quality.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
|
@ -18,12 +18,12 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibAlertingPluginApi" section="def-public.PluginSetupContract.registerNavigation" text="registerNavigation"/> | ml, stackAlerts | - |
|
||||
| <DocLink id="kibCasesPluginApi" section="def-common.FEATURE_ID" text="FEATURE_ID"/> | ml | - |
|
||||
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | data, @kbn/search-errors, savedObjectsManagement, unifiedSearch, @kbn/unified-field-list, lens, controls, @kbn/lens-embeddable-utils, triggersActionsUi, dataVisualizer, ml, canvas, fleet, graph, transform, @kbn/ml-data-view-utils, upgradeAssistant, securitySolution, timelines, exploratoryView, stackAlerts, maps, visTypeTimeseries, uptime, ux, enterpriseSearch, @kbn/cloud-security-posture-graph, eventAnnotationListing, inputControlVis, visDefaultEditor, dataViewManagement, visTypeTimelion, visTypeVega | - |
|
||||
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | data, @kbn/search-errors, savedObjectsManagement, unifiedSearch, @kbn/unified-field-list, controls, lens, @kbn/lens-embeddable-utils, triggersActionsUi, dataVisualizer, ml, canvas, fleet, graph, transform, @kbn/ml-data-view-utils, upgradeAssistant, securitySolution, timelines, exploratoryView, stackAlerts, maps, visTypeTimeseries, uptime, ux, enterpriseSearch, @kbn/cloud-security-posture-graph, eventAnnotationListing, inputControlVis, visDefaultEditor, dataViewManagement, visTypeTimelion, visTypeVega | - |
|
||||
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | ml, securitySolution | - |
|
||||
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | ml, savedObjectsTagging, actions | - |
|
||||
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.registerAction" text="registerAction"/> | uiActionsEnhanced, ml, discover, imageEmbeddable, securitySolution | - |
|
||||
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.addTriggerAction" text="addTriggerAction"/> | data, lens, cases, aiops, ml, reporting, discoverEnhanced, dashboardEnhanced, securitySolution, inputControlVis, @kbn/test-suites-src | - |
|
||||
| <DocLink id="kibKbnCoreHttpServerPluginApi" section="def-server.RouteConfigOptions.authRequired" text="authRequired"/> | @kbn/core, usageCollection, taskManager, security, telemetry, monitoringCollection, banners, securitySolution, @kbn/test-suites-xpack, cloudFullStory, customBranding, enterpriseSearch, interactiveSetup, @kbn/test-suites-src, mockIdpPlugin, spaces, ml | - |
|
||||
| <DocLink id="kibKbnCoreHttpServerPluginApi" section="def-server.RouteConfigOptions.authRequired" text="authRequired"/> | @kbn/core, usageCollection, taskManager, security, telemetry, monitoringCollection, banners, securitySolution, @kbn/test-suites-xpack, customBranding, enterpriseSearch, interactiveSetup, @kbn/test-suites-src, mockIdpPlugin, spaces, ml | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SimpleSavedObject" text="SimpleSavedObject"/> | @kbn/core, visualizations, dataVisualizer, ml, aiops, graph, dashboardEnhanced, lens, securitySolution, eventAnnotation | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | @kbn/core, savedObjects, visualizations, canvas, graph, ml | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.migrations" text="migrations"/> | @kbn/core, ml, spaces, taskManager, dataViews, data, fleet, share, actions, alerting, apmSourcesAccess, dashboard, savedSearch, canvas, graph, lens, cases, maps, lists, securitySolution, apm, visualizations, infra, slo, synthetics, uptime, cloudSecurityPosture, eventAnnotation, links, savedObjectsManagement | - |
|
||||
|
|
@ -70,6 +70,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_NAME" text="ENDPOINT_BLOCKLISTS_LIST_NAME"/> | securitySolution | - |
|
||||
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION" text="ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION"/> | securitySolution | - |
|
||||
| <DocLink id="kibKbnUnifiedDataTablePluginApi" section="def-public.UnifiedDataTableProps.externalControlColumns" text="externalControlColumns"/> | cloudSecurityPosture, securitySolution | - |
|
||||
| <DocLink id="kibControlsPluginApi" section="def-public.serializeRuntimeState" text="serializeRuntimeState"/> | dashboard | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | @kbn/core, savedObjectsManagement, savedObjects, visualizations, savedObjectsTagging, eventAnnotation, lens, maps, streamsApp, graph, dashboard, kibanaUtils, expressions, data, savedObjectsTaggingOss, embeddable, uiActionsEnhanced, controls, canvas, dashboardEnhanced, globalSearchProviders | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.schemas" text="schemas"/> | @kbn/core, spaces, data, dashboard, savedSearch, visualizations, cloudSecurityPosture | - |
|
||||
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | actions, alerting | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.syncQueryStateWithUrl" text="syncQueryStateWithUrl"/> | monitoring | - |
|
||||
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | monitoring, observabilityShared | - |
|
||||
|
|
@ -119,8 +122,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObject" text="SavedObject"/> | @kbn/core, home, savedObjectsTagging, canvas, savedObjectsTaggingOss, upgradeAssistant, lists, @kbn/test-suites-src, savedObjectsManagement | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributeSingle" text="SavedObjectAttributeSingle"/> | @kbn/core | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttribute" text="SavedObjectAttribute"/> | @kbn/core, visualizations, @kbn/response-ops-rule-form | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | @kbn/core, savedObjectsManagement, savedObjects, visualizations, savedObjectsTagging, eventAnnotation, lens, maps, streamsApp, graph, dashboard, kibanaUtils, expressions, data, savedObjectsTaggingOss, embeddable, uiActionsEnhanced, controls, canvas, dashboardEnhanced, globalSearchProviders | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.schemas" text="schemas"/> | @kbn/core, spaces, data, dashboard, savedSearch, visualizations, cloudSecurityPosture | - |
|
||||
| <DocLink id="kibDiscoverPluginApi" section="def-common.DiscoverAppLocatorParams.indexPatternId" text="indexPatternId"/> | fleet, osquery, exploratoryView, synthetics | - |
|
||||
| <DocLink id="kibSecurityPluginApi" section="def-server.ApiActions.get" text="get"/> | @kbn/security-plugin-types-server, telemetry, fleet, profiling, @kbn/security-authorization-core, security | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | graph, visTypeTimeseries, dataViewManagement, dataViews | - |
|
||||
|
|
@ -141,7 +142,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | spaces, savedObjectsManagement | - |
|
||||
| <DocLink id="kibDataViewsPluginApi" section="def-server.getFieldByName" text="getFieldByName"/> | unifiedSearch | - |
|
||||
| <DocLink id="kibDataViewsPluginApi" section="def-server.findIndexPatternById" text="findIndexPatternById"/> | unifiedSearch | - |
|
||||
| <DocLink id="kibKbnPresentationPublishingPluginApi" section="def-public.apiHasSnapshottableState" text="apiHasSnapshottableState"/> | controls, dashboard | - |
|
||||
| <DocLink id="kibKbnPresentationPublishingPluginApi" section="def-public.useBatchedOptionalPublishingSubjects" text="useBatchedOptionalPublishingSubjects"/> | presentationPanel, controls | - |
|
||||
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionFunctionDefinition.context" text="context"/> | canvas | - |
|
||||
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionsServiceSetup.getFunction" text="getFunction"/> | canvas | - |
|
||||
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionsServiceSetup.getFunctions" text="getFunctions"/> | canvas | - |
|
||||
|
|
@ -165,9 +166,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| <DocLink id="kibKbnReportingExportTypesCsvCommonPluginApi" section="def-common.CSV_JOB_TYPE_DEPRECATED" text="CSV_JOB_TYPE_DEPRECATED"/> | reporting | - |
|
||||
| <DocLink id="kibKbnReportingExportTypesPdfPluginApi" section="def-server.PdfV1ExportType" text="PdfV1ExportType"/> | reporting | - |
|
||||
| <DocLink id="kibKbnContentManagementTableListViewTablePluginApi" section="def-public.TableListViewTableProps.withoutPageTemplateWrapper" text="withoutPageTemplateWrapper"/> | @kbn/content-management-table-list-view, filesManagement | - |
|
||||
| <DocLink id="kibKbnPresentationContainersPluginApi" section="def-public.HasRuntimeChildState" text="HasRuntimeChildState"/> | dashboard | - |
|
||||
| <DocLink id="kibKbnPresentationContainersPluginApi" section="def-public.apiHasRuntimeChildState" text="apiHasRuntimeChildState"/> | embeddable | - |
|
||||
| <DocLink id="kibKbnPresentationPublishingPluginApi" section="def-public.HasSnapshottableState" text="HasSnapshottableState"/> | @kbn/presentation-containers, embeddable | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion" text="convertToMultiNamespaceTypeVersion"/> | encryptedSavedObjects | - |
|
||||
| <DocLink id="kibKbnEsqlAstPluginApi" section="def-common.ESQLColumn.quoted" text="quoted"/> | @kbn/esql-validation-autocomplete | - |
|
||||
| <DocLink id="kibKbnEsqlAstPluginApi" section="def-common.ParseResult.ast" text="ast"/> | @kbn/esql-validation-autocomplete, @kbn/esql-utils | - |
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
|
@ -141,14 +141,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
|
||||
|
||||
|
||||
## @kbn/presentation-containers
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibKbnPresentationPublishingPluginApi" section="def-public.HasSnapshottableState" text="HasSnapshottableState"/> | [initialize_unsaved_changes.ts](https://github.com/elastic/kibana/tree/main/src/platform/packages/shared/presentation/presentation_containers/interfaces/unsaved_changes/initialize_unsaved_changes.ts#:~:text=HasSnapshottableState), [initialize_unsaved_changes.ts](https://github.com/elastic/kibana/tree/main/src/platform/packages/shared/presentation/presentation_containers/interfaces/unsaved_changes/initialize_unsaved_changes.ts#:~:text=HasSnapshottableState) | - |
|
||||
|
||||
|
||||
|
||||
## @kbn/react-kibana-context-styled
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
|
|
@ -403,14 +395,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
|
||||
|
||||
|
||||
## cloudFullStory
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibKbnCoreHttpServerPluginApi" section="def-server.RouteConfigOptions.authRequired" text="authRequired"/> | [fullstory.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/private/cloud_integrations/cloud_full_story/server/routes/fullstory.ts#:~:text=authRequired) | - |
|
||||
|
||||
|
||||
|
||||
## cloudLinks
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
|
|
@ -426,7 +410,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginStart.authc" text="authc"/> | [setup_routes.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_security_posture/server/routes/setup_routes.ts#:~:text=authc), [setup_routes.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_security_posture/server/routes/setup_routes.ts#:~:text=authc) | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.migrations" text="migrations"/> | [csp_benchmark_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_security_posture/server/saved_objects/csp_benchmark_rule.ts#:~:text=migrations) | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.schemas" text="schemas"/> | [csp_benchmark_rule.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_security_posture/server/saved_objects/csp_benchmark_rule.ts#:~:text=schemas), [csp_settings.ts](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_security_posture/server/saved_objects/csp_settings.ts#:~:text=schemas) | - |
|
||||
| <DocLink id="kibKbnUnifiedDataTablePluginApi" section="def-public.UnifiedDataTableProps.externalControlColumns" text="externalControlColumns"/> | [cloud_security_data_table.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_security_posture/public/components/cloud_security_data_table/cloud_security_data_table.tsx#:~:text=externalControlColumns), [vulnerability_security_data_table.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_security_posture/public/components/cloud_security_data_table/vulnerability_security_data_table.tsx#:~:text=externalControlColumns) | - |
|
||||
| <DocLink id="kibKbnUnifiedDataTablePluginApi" section="def-public.UnifiedDataTableProps.externalControlColumns" text="externalControlColumns"/> | [cloud_security_data_table.tsx](https://github.com/elastic/kibana/tree/main/x-pack/solutions/security/plugins/cloud_security_posture/public/components/cloud_security_data_table/cloud_security_data_table.tsx#:~:text=externalControlColumns) | - |
|
||||
|
||||
|
||||
|
||||
|
|
@ -444,7 +428,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | [options_list_fetch_cache.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/public/controls/data_controls/options_list_control/options_list_fetch_cache.ts#:~:text=title) | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | [control_group_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/control_group/control_group_persistable_state.ts#:~:text=SavedObjectReference), [control_group_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/control_group/control_group_persistable_state.ts#:~:text=SavedObjectReference), [control_group_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/control_group/control_group_persistable_state.ts#:~:text=SavedObjectReference), [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [time_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/server/time_slider/time_slider_persistable_state.ts#:~:text=SavedObjectReference)+ 5 more | - |
|
||||
| <DocLink id="kibKbnPresentationPublishingPluginApi" section="def-public.apiHasSnapshottableState" text="apiHasSnapshottableState"/> | [init_controls_manager.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/public/control_group/init_controls_manager.ts#:~:text=apiHasSnapshottableState), [init_controls_manager.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/public/control_group/init_controls_manager.ts#:~:text=apiHasSnapshottableState) | - |
|
||||
| <DocLink id="kibKbnPresentationPublishingPluginApi" section="def-public.useBatchedOptionalPublishingSubjects" text="useBatchedOptionalPublishingSubjects"/> | [control_panel.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/public/control_group/components/control_panel.tsx#:~:text=useBatchedOptionalPublishingSubjects), [control_panel.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/controls/public/control_group/components/control_panel.tsx#:~:text=useBatchedOptionalPublishingSubjects) | - |
|
||||
|
||||
|
||||
|
||||
|
|
@ -468,12 +452,11 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibControlsPluginApi" section="def-public.serializeRuntimeState" text="serializeRuntimeState"/> | [url_utils.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/dashboard/public/dashboard_app/url/url_utils.ts#:~:text=serializeRuntimeState), [url_utils.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/dashboard/public/dashboard_app/url/url_utils.ts#:~:text=serializeRuntimeState) | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/dashboard/common/bwc/types.ts#:~:text=SavedObjectReference), [types.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/dashboard/common/bwc/types.ts#:~:text=SavedObjectReference) | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.migrations" text="migrations"/> | [dashboard_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/dashboard/server/dashboard_saved_object/dashboard_saved_object.ts#:~:text=migrations) | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.schemas" text="schemas"/> | [dashboard_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/dashboard/server/dashboard_saved_object/dashboard_saved_object.ts#:~:text=schemas) | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-server.SavedObjectsType.convertToMultiNamespaceTypeVersion" text="convertToMultiNamespaceTypeVersion"/> | [dashboard_saved_object.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/dashboard/server/dashboard_saved_object/dashboard_saved_object.ts#:~:text=convertToMultiNamespaceTypeVersion) | - |
|
||||
| <DocLink id="kibKbnPresentationContainersPluginApi" section="def-public.HasRuntimeChildState" text="HasRuntimeChildState"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts#:~:text=HasRuntimeChildState), [types.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/dashboard/public/dashboard_api/types.ts#:~:text=HasRuntimeChildState) | - |
|
||||
| <DocLink id="kibKbnPresentationPublishingPluginApi" section="def-public.apiHasSnapshottableState" text="apiHasSnapshottableState"/> | [copy_to_dashboard_modal.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/dashboard/public/dashboard_actions/copy_to_dashboard_modal.tsx#:~:text=apiHasSnapshottableState), [copy_to_dashboard_modal.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/dashboard/public/dashboard_actions/copy_to_dashboard_modal.tsx#:~:text=apiHasSnapshottableState) | - |
|
||||
|
||||
|
||||
|
||||
|
|
@ -583,8 +566,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | [migrate_base_input.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/embeddable/common/lib/migrate_base_input.ts#:~:text=SavedObjectReference), [migrate_base_input.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/embeddable/common/lib/migrate_base_input.ts#:~:text=SavedObjectReference), [migrate_base_input.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/embeddable/common/lib/migrate_base_input.ts#:~:text=SavedObjectReference), [inject.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/embeddable/common/lib/inject.ts#:~:text=SavedObjectReference), [inject.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/embeddable/common/lib/inject.ts#:~:text=SavedObjectReference) | - |
|
||||
| <DocLink id="kibKbnPresentationContainersPluginApi" section="def-public.apiHasRuntimeChildState" text="apiHasRuntimeChildState"/> | [react_embeddable_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx#:~:text=apiHasRuntimeChildState), [react_embeddable_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx#:~:text=apiHasRuntimeChildState) | - |
|
||||
| <DocLink id="kibKbnPresentationPublishingPluginApi" section="def-public.HasSnapshottableState" text="HasSnapshottableState"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts#:~:text=HasSnapshottableState), [types.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts#:~:text=HasSnapshottableState), [types.ts](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts#:~:text=HasSnapshottableState), [react_embeddable_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx#:~:text=HasSnapshottableState), [react_embeddable_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx#:~:text=HasSnapshottableState) | - |
|
||||
|
||||
|
||||
|
||||
|
|
@ -992,6 +973,14 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
|
||||
|
||||
|
||||
## presentationPanel
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibKbnPresentationPublishingPluginApi" section="def-public.useBatchedOptionalPublishingSubjects" text="useBatchedOptionalPublishingSubjects"/> | [presentation_panel_hover_actions.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/private/presentation_panel/public/panel_component/panel_header/presentation_panel_hover_actions.tsx#:~:text=useBatchedOptionalPublishingSubjects), [presentation_panel_hover_actions.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/private/presentation_panel/public/panel_component/panel_header/presentation_panel_hover_actions.tsx#:~:text=useBatchedOptionalPublishingSubjects), [presentation_panel_internal.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/private/presentation_panel/public/panel_component/presentation_panel_internal.tsx#:~:text=useBatchedOptionalPublishingSubjects), [presentation_panel_internal.tsx](https://github.com/elastic/kibana/tree/main/src/platform/plugins/private/presentation_panel/public/panel_component/presentation_panel_internal.tsx#:~:text=useBatchedOptionalPublishingSubjects) | - |
|
||||
|
||||
|
||||
|
||||
## profiling
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
|
|
@ -1132,7 +1121,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
|
|||
| <DocLink id="kibKbnSecurityPluginTypesPublicPluginApi" section="def-public.SecurityPluginSetup.authc" text="authc"/> | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/public/plugin.tsx#:~:text=authc) | - |
|
||||
| <DocLink id="kibKbnSecurityPluginTypesPublicPluginApi" section="def-public.SecurityPluginStart.authc" text="authc"/> | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/public/plugin.tsx#:~:text=authc) | - |
|
||||
| <DocLink id="kibKbnSecurityPluginTypesPublicPluginApi" section="def-public.SecurityPluginStart.userProfiles" text="userProfiles"/> | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/public/plugin.tsx#:~:text=userProfiles) | - |
|
||||
| <DocLink id="kibKbnSecurityPluginTypesServerPluginApi" section="def-server.ApiActions.get" text="get"/> | [api_authorization.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/server/authorization/api_authorization.ts#:~:text=get), [api_authorization.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/server/authorization/api_authorization.ts#:~:text=get), [api_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/server/authorization/api_authorization.test.ts#:~:text=get), [api_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/server/authorization/api_authorization.test.ts#:~:text=get), [api_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/server/authorization/api_authorization.test.ts#:~:text=get) | - |
|
||||
| <DocLink id="kibKbnSecurityPluginTypesServerPluginApi" section="def-server.ApiActions.get" text="get"/> | [api_authorization.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/server/authorization/api_authorization.ts#:~:text=get), [api_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/server/authorization/api_authorization.test.ts#:~:text=get), [api_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/server/authorization/api_authorization.test.ts#:~:text=get), [api_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/server/authorization/api_authorization.test.ts#:~:text=get) | - |
|
||||
| <DocLink id="kibKbnSecurityPluginTypesServerPluginApi" section="def-server.SecurityPluginSetup.audit" text="audit"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/server/plugin.ts#:~:text=audit) | - |
|
||||
| <DocLink id="kibKbnSecurityPluginTypesServerPluginApi" section="def-server.SecurityPluginStart.authc" text="authc"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/server/plugin.ts#:~:text=authc) | - |
|
||||
| <DocLink id="kibKbnSecurityPluginTypesServerPluginApi" section="def-server.SecurityPluginStart.userProfiles" text="userProfiles"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/platform/plugins/shared/security/server/plugin.ts#:~:text=userProfiles) | - |
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
|
||||
---
|
||||
import devToolsObj from './dev_tools.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -3496,14 +3496,6 @@
|
|||
"section": "def-public.SearchEmbeddableSerializedState",
|
||||
"text": "SearchEmbeddableSerializedState"
|
||||
},
|
||||
", ",
|
||||
{
|
||||
"pluginId": "discover",
|
||||
"scope": "public",
|
||||
"docId": "kibDiscoverPluginApi",
|
||||
"section": "def-public.SearchEmbeddableRuntimeState",
|
||||
"text": "SearchEmbeddableRuntimeState"
|
||||
},
|
||||
"> & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
|
|
@ -3528,15 +3520,23 @@
|
|||
"section": "def-public.PublishesBlockingError",
|
||||
"text": "PublishesBlockingError"
|
||||
},
|
||||
" & ",
|
||||
" & Required<",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.PublishesTitle",
|
||||
"text": "PublishesTitle"
|
||||
"section": "def-public.PublishesWritableTitle",
|
||||
"text": "PublishesWritableTitle"
|
||||
},
|
||||
" & { setTitle: (newTitle: string | undefined) => void; setHideTitle: (hide: boolean | undefined) => void; } & ",
|
||||
"> & Required<",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.PublishesDescription",
|
||||
"text": "PublishesDescription"
|
||||
},
|
||||
"> & ",
|
||||
{
|
||||
"pluginId": "discover",
|
||||
"scope": "public",
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
|
||||
---
|
||||
import discoverObj from './discover.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
|
||||
---
|
||||
import discoverEnhancedObj from './discover_enhanced.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverShared']
|
||||
---
|
||||
import discoverSharedObj from './discover_shared.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
|
||||
---
|
||||
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -818,27 +818,27 @@
|
|||
"InfoResponse",
|
||||
">; }; ingest: ",
|
||||
"default",
|
||||
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"; knnSearch: { (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
">; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
", unknown>>; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; }; license: ",
|
||||
"TODO",
|
||||
">; }; license: ",
|
||||
"default",
|
||||
"; logstash: ",
|
||||
"default",
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistant']
|
||||
---
|
||||
import elasticAssistantObj from './elastic_assistant.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -266,7 +266,7 @@
|
|||
"section": "def-public.EmbeddablePackageState",
|
||||
"text": "EmbeddablePackageState"
|
||||
},
|
||||
" | undefined"
|
||||
"<object> | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -436,7 +436,7 @@
|
|||
"\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddablePackageState | embeddable package state}"
|
||||
],
|
||||
"signature": [
|
||||
"(appId: string, options?: { path?: string | undefined; state: ",
|
||||
"<SerializedStateType extends object = object>(appId: string, options?: { path?: string | undefined; state: ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
|
|
@ -444,7 +444,7 @@
|
|||
"section": "def-public.EmbeddablePackageState",
|
||||
"text": "EmbeddablePackageState"
|
||||
},
|
||||
"; } | undefined) => Promise<void>"
|
||||
"<SerializedStateType>; } | undefined) => Promise<void>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -504,7 +504,8 @@
|
|||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.EmbeddablePackageState",
|
||||
"text": "EmbeddablePackageState"
|
||||
}
|
||||
},
|
||||
"<SerializedStateType>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/state_transfer/embeddable_state_transfer.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -622,6 +623,188 @@
|
|||
}
|
||||
],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddableRenderer",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "EmbeddableRenderer",
|
||||
"description": [
|
||||
"\nRenders a component from the React Embeddable registry into a Presentation Panel."
|
||||
],
|
||||
"signature": [
|
||||
"<SerializedState extends object = object, Api extends ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.DefaultEmbeddableApi",
|
||||
"text": "DefaultEmbeddableApi"
|
||||
},
|
||||
"<SerializedState> = ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.DefaultEmbeddableApi",
|
||||
"text": "DefaultEmbeddableApi"
|
||||
},
|
||||
"<SerializedState>, ParentApi extends ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-containers",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationContainersPluginApi",
|
||||
"section": "def-public.HasSerializedChildState",
|
||||
"text": "HasSerializedChildState"
|
||||
},
|
||||
"<SerializedState> = ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-containers",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationContainersPluginApi",
|
||||
"section": "def-public.HasSerializedChildState",
|
||||
"text": "HasSerializedChildState"
|
||||
},
|
||||
"<SerializedState>>({ type, maybeId, getParentApi, panelProps, onApiAvailable, hidePanelChrome, }: { type: string; maybeId?: string | undefined; getParentApi: () => ParentApi; onApiAvailable?: ((api: Api) => void) | undefined; panelProps?: Pick<",
|
||||
{
|
||||
"pluginId": "presentationPanel",
|
||||
"scope": "public",
|
||||
"docId": "kibPresentationPanelPluginApi",
|
||||
"section": "def-public.PresentationPanelProps",
|
||||
"text": "PresentationPanelProps"
|
||||
},
|
||||
"<Api, {}>, \"showShadow\" | \"showBorder\" | \"showBadges\" | \"showNotifications\" | \"hideLoader\" | \"hideHeader\" | \"hideInspector\" | \"getActions\" | \"setDragHandles\"> | undefined; hidePanelChrome?: boolean | undefined; }) => React.JSX.Element"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddableRenderer.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "{\n type,\n maybeId,\n getParentApi,\n panelProps,\n onApiAvailable,\n hidePanelChrome,\n}",
|
||||
"description": [],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddableRenderer.$1.type",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "type",
|
||||
"description": [],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddableRenderer.$1.maybeId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "maybeId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddableRenderer.$1.getParentApi",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getParentApi",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ParentApi"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddableRenderer.$1.onApiAvailable",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "onApiAvailable",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"((api: Api) => void) | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddableRenderer.$1.onApiAvailable.$1",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "api",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Api"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddableRenderer.$1.panelProps",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "panelProps",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "presentationPanel",
|
||||
"scope": "public",
|
||||
"docId": "kibPresentationPanelPluginApi",
|
||||
"section": "def-public.PresentationPanelProps",
|
||||
"text": "PresentationPanelProps"
|
||||
},
|
||||
"<Api, {}>, \"showShadow\" | \"showBorder\" | \"showBadges\" | \"showNotifications\" | \"hideLoader\" | \"hideHeader\" | \"hideInspector\" | \"getActions\" | \"setDragHandles\"> | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddableRenderer.$1.hidePanelChrome",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "hidePanelChrome",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.isMultiValueClickTriggerContext",
|
||||
|
|
@ -914,245 +1097,6 @@
|
|||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableRenderer",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "ReactEmbeddableRenderer",
|
||||
"description": [
|
||||
"\nRenders a component from the React Embeddable registry into a Presentation Panel.\n\nTODO: Rename this to simply `Embeddable` when the legacy Embeddable system is removed."
|
||||
],
|
||||
"signature": [
|
||||
"<SerializedState extends object = object, RuntimeState extends object = SerializedState, Api extends ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.DefaultEmbeddableApi",
|
||||
"text": "DefaultEmbeddableApi"
|
||||
},
|
||||
"<SerializedState, RuntimeState> = ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.DefaultEmbeddableApi",
|
||||
"text": "DefaultEmbeddableApi"
|
||||
},
|
||||
"<SerializedState, RuntimeState>, ParentApi extends ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-containers",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationContainersPluginApi",
|
||||
"section": "def-public.HasSerializedChildState",
|
||||
"text": "HasSerializedChildState"
|
||||
},
|
||||
"<SerializedState> = ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-containers",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationContainersPluginApi",
|
||||
"section": "def-public.HasSerializedChildState",
|
||||
"text": "HasSerializedChildState"
|
||||
},
|
||||
"<SerializedState>>({ type, maybeId, getParentApi, panelProps, onAnyStateChange, onApiAvailable, hidePanelChrome, }: { type: string; maybeId?: string | undefined; getParentApi: () => ParentApi; onApiAvailable?: ((api: Api) => void) | undefined; panelProps?: Pick<",
|
||||
{
|
||||
"pluginId": "presentationPanel",
|
||||
"scope": "public",
|
||||
"docId": "kibPresentationPanelPluginApi",
|
||||
"section": "def-public.PresentationPanelProps",
|
||||
"text": "PresentationPanelProps"
|
||||
},
|
||||
"<Api, {}>, \"showShadow\" | \"showBorder\" | \"showBadges\" | \"showNotifications\" | \"hideLoader\" | \"hideHeader\" | \"hideInspector\" | \"getActions\" | \"setDragHandles\"> | undefined; hidePanelChrome?: boolean | undefined; onAnyStateChange?: ((state: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.SerializedPanelState",
|
||||
"text": "SerializedPanelState"
|
||||
},
|
||||
"<SerializedState>) => void) | undefined; }) => React.JSX.Element"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableRenderer.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "{\n type,\n maybeId,\n getParentApi,\n panelProps,\n onAnyStateChange,\n onApiAvailable,\n hidePanelChrome,\n}",
|
||||
"description": [],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableRenderer.$1.type",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "type",
|
||||
"description": [],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableRenderer.$1.maybeId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "maybeId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableRenderer.$1.getParentApi",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getParentApi",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ParentApi"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableRenderer.$1.onApiAvailable",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "onApiAvailable",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"((api: Api) => void) | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableRenderer.$1.onApiAvailable.$1",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "api",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Api"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableRenderer.$1.panelProps",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "panelProps",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "presentationPanel",
|
||||
"scope": "public",
|
||||
"docId": "kibPresentationPanelPluginApi",
|
||||
"section": "def-public.PresentationPanelProps",
|
||||
"text": "PresentationPanelProps"
|
||||
},
|
||||
"<Api, {}>, \"showShadow\" | \"showBorder\" | \"showBadges\" | \"showNotifications\" | \"hideLoader\" | \"hideHeader\" | \"hideInspector\" | \"getActions\" | \"setDragHandles\"> | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableRenderer.$1.hidePanelChrome",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "hidePanelChrome",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableRenderer.$1.onAnyStateChange",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "onAnyStateChange",
|
||||
"description": [
|
||||
"\nThis `onAnyStateChange` callback allows the parent to keep track of the state of the embeddable\nas it changes. This is **not** expected to change over the lifetime of the component."
|
||||
],
|
||||
"signature": [
|
||||
"((state: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.SerializedPanelState",
|
||||
"text": "SerializedPanelState"
|
||||
},
|
||||
"<SerializedState>) => void) | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableRenderer.$1.onAnyStateChange.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.SerializedPanelState",
|
||||
"text": "SerializedPanelState"
|
||||
},
|
||||
"<SerializedState>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.useAddFromLibraryTypes",
|
||||
|
|
@ -1205,7 +1149,7 @@
|
|||
"section": "def-public.DefaultEmbeddableApi",
|
||||
"text": "DefaultEmbeddableApi"
|
||||
},
|
||||
"<SerializedState, RuntimeState> extends ",
|
||||
"<SerializedState> extends ",
|
||||
"DefaultPresentationPanelApi",
|
||||
",",
|
||||
{
|
||||
|
|
@ -1223,15 +1167,7 @@
|
|||
"section": "def-public.PublishesPhaseEvents",
|
||||
"text": "PublishesPhaseEvents"
|
||||
},
|
||||
",Partial<",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.PublishesUnsavedChanges",
|
||||
"text": "PublishesUnsavedChanges"
|
||||
},
|
||||
"<object>>,",
|
||||
",",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
|
|
@ -1239,15 +1175,7 @@
|
|||
"section": "def-public.HasSerializableState",
|
||||
"text": "HasSerializableState"
|
||||
},
|
||||
"<SerializedState>,",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.HasSnapshottableState",
|
||||
"text": "HasSnapshottableState"
|
||||
},
|
||||
"<RuntimeState>"
|
||||
"<SerializedState>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -1340,6 +1268,82 @@
|
|||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddableFactory",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "EmbeddableFactory",
|
||||
"description": [
|
||||
"\nThe React Embeddable Factory interface is used to register a series of functions that\ncreate and manage an embeddable instance.\n\nEmbeddables are React components that manage their own state, can be serialized and\ndeserialized, and return an API that can be used to interact with them imperatively."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.EmbeddableFactory",
|
||||
"text": "EmbeddableFactory"
|
||||
},
|
||||
"<SerializedState, Api>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddableFactory.type",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "type",
|
||||
"description": [
|
||||
"\nA unique key for the type of this embeddable. The React Embeddable Renderer will use this type\nto find this factory."
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddableFactory.buildEmbeddable",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "buildEmbeddable",
|
||||
"description": [
|
||||
"\nA required async function that builds your embeddable component and a linked API instance. The API\nand component will be combined together by the ReactEmbeddableRenderer."
|
||||
],
|
||||
"signature": [
|
||||
"(props: ",
|
||||
"BuildEmbeddableProps",
|
||||
"<SerializedState, Api>) => Promise<{ Component: React.FC<{}>; api: Api; }>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddableFactory.buildEmbeddable.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"BuildEmbeddableProps",
|
||||
"<SerializedState, Api>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddablePackageState",
|
||||
|
|
@ -1349,6 +1353,16 @@
|
|||
"description": [
|
||||
"\nA state package that contains all fields necessary to create or update an embeddable by reference or by value in a container."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.EmbeddablePackageState",
|
||||
"text": "EmbeddablePackageState"
|
||||
},
|
||||
"<SerializedStateType>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/state_transfer/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
|
|
@ -1366,15 +1380,20 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddablePackageState.input",
|
||||
"type": "Uncategorized",
|
||||
"id": "def-public.EmbeddablePackageState.serializedState",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "input",
|
||||
"description": [
|
||||
"\nFor react embeddables, this input must be runtime state."
|
||||
],
|
||||
"label": "serializedState",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"object"
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.SerializedPanelState",
|
||||
"text": "SerializedPanelState"
|
||||
},
|
||||
"<SerializedStateType>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/state_transfer/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -1469,251 +1488,6 @@
|
|||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableFactory",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "ReactEmbeddableFactory",
|
||||
"description": [
|
||||
"\nThe React Embeddable Factory interface is used to register a series of functions that\ncreate and manage an embeddable instance.\n\nEmbeddables are React components that manage their own state, can be serialized and\ndeserialized, and return an API that can be used to interact with them imperatively."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ReactEmbeddableFactory",
|
||||
"text": "ReactEmbeddableFactory"
|
||||
},
|
||||
"<SerializedState, RuntimeState, Api>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableFactory.type",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "type",
|
||||
"description": [
|
||||
"\nA unique key for the type of this embeddable. The React Embeddable Renderer will use this type\nto find this factory."
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableFactory.deserializeState",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "deserializeState",
|
||||
"description": [
|
||||
"\nA required asynchronous function that transforms serialized state into runtime state.\n\nThis could be used to:\n- Load state from some external store\n- Inject references provided by the parent\n- Migrate the state to a newer version (this must be undone when serializing)"
|
||||
],
|
||||
"signature": [
|
||||
"(panelState: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.SerializedPanelState",
|
||||
"text": "SerializedPanelState"
|
||||
},
|
||||
"<SerializedState>) => ",
|
||||
{
|
||||
"pluginId": "@kbn/utility-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnUtilityTypesPluginApi",
|
||||
"section": "def-common.MaybePromise",
|
||||
"text": "MaybePromise"
|
||||
},
|
||||
"<RuntimeState>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableFactory.deserializeState.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "panelState",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.SerializedPanelState",
|
||||
"text": "SerializedPanelState"
|
||||
},
|
||||
"<SerializedState>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableFactory.buildEmbeddable",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "buildEmbeddable",
|
||||
"description": [
|
||||
"\nA required async function that builds your embeddable component and a linked API instance. The API\nand component will be combined together by the ReactEmbeddableRenderer. Initial state will contain the result of\nthe deserialize function.\n\nThe returned API must extend {@link HasSerializableState} which does the opposite of the deserializeState\nfunction."
|
||||
],
|
||||
"signature": [
|
||||
"(initialRuntimeState: RuntimeState, buildApi: (apiRegistration: ",
|
||||
"BuildReactEmbeddableApiRegistration",
|
||||
"<SerializedState, RuntimeState, Api>, comparators: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.StateComparators",
|
||||
"text": "StateComparators"
|
||||
},
|
||||
"<RuntimeState>) => Api & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.HasSnapshottableState",
|
||||
"text": "HasSnapshottableState"
|
||||
},
|
||||
"<RuntimeState>, uuid: string, parentApi: unknown, setApi: (api: ",
|
||||
"SetReactEmbeddableApiRegistration",
|
||||
"<SerializedState, RuntimeState, Api>) => Api, lastSavedRuntimeState: RuntimeState) => Promise<{ Component: React.FC<{}>; api: Api; }>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$1",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "initialRuntimeState",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"RuntimeState"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$2",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "buildApi",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(apiRegistration: ",
|
||||
"BuildReactEmbeddableApiRegistration",
|
||||
"<SerializedState, RuntimeState, Api>, comparators: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.StateComparators",
|
||||
"text": "StateComparators"
|
||||
},
|
||||
"<RuntimeState>) => Api & ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-publishing",
|
||||
"scope": "public",
|
||||
"docId": "kibKbnPresentationPublishingPluginApi",
|
||||
"section": "def-public.HasSnapshottableState",
|
||||
"text": "HasSnapshottableState"
|
||||
},
|
||||
"<RuntimeState>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$3",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "uuid",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$4",
|
||||
"type": "Unknown",
|
||||
"tags": [],
|
||||
"label": "parentApi",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"unknown"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$5",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "setApi",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(api: ",
|
||||
"SetReactEmbeddableApiRegistration",
|
||||
"<SerializedState, RuntimeState, Api>) => Api"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$6",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "lastSavedRuntimeState",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"RuntimeState"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"enums": [],
|
||||
|
|
@ -2397,7 +2171,7 @@
|
|||
"tags": [],
|
||||
"label": "registerAddFromLibraryType",
|
||||
"description": [
|
||||
"\nRegister a saved object type with the \"Add from library\" flyout.\n"
|
||||
"\nRegister a saved object type with the \"Add from library\" flyout.\n\n`onAdd` receives the container and the saved object. You may pass a second boolean parameter\n to `addNewPanel` to enable a success message and automatic scrolling.\n"
|
||||
],
|
||||
"signature": [
|
||||
"<TSavedObjectAttributes extends ",
|
||||
|
|
@ -2541,7 +2315,7 @@
|
|||
"\nRegisters an async {@link ReactEmbeddableFactory} getter."
|
||||
],
|
||||
"signature": [
|
||||
"<SerializedState extends object = object, RuntimeState extends object = SerializedState, Api extends ",
|
||||
"<SerializedState extends object = object, Api extends ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
|
|
@ -2549,7 +2323,7 @@
|
|||
"section": "def-public.DefaultEmbeddableApi",
|
||||
"text": "DefaultEmbeddableApi"
|
||||
},
|
||||
"<SerializedState, RuntimeState> = ",
|
||||
"<SerializedState> = ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
|
|
@ -2557,15 +2331,15 @@
|
|||
"section": "def-public.DefaultEmbeddableApi",
|
||||
"text": "DefaultEmbeddableApi"
|
||||
},
|
||||
"<SerializedState, RuntimeState>>(type: string, getFactory: () => Promise<",
|
||||
"<SerializedState>>(type: string, getFactory: () => Promise<",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ReactEmbeddableFactory",
|
||||
"text": "ReactEmbeddableFactory"
|
||||
"section": "def-public.EmbeddableFactory",
|
||||
"text": "EmbeddableFactory"
|
||||
},
|
||||
"<SerializedState, RuntimeState, Api>>) => void"
|
||||
"<SerializedState, Api>>) => void"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -2596,10 +2370,10 @@
|
|||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.ReactEmbeddableFactory",
|
||||
"text": "ReactEmbeddableFactory"
|
||||
"section": "def-public.EmbeddableFactory",
|
||||
"text": "EmbeddableFactory"
|
||||
},
|
||||
"<SerializedState, RuntimeState, Api>>"
|
||||
"<SerializedState, Api>>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/embeddable/public/react_embeddable_system/react_embeddable_registry.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
|
||||
---
|
||||
import embeddableObj from './embeddable.devdocs.json';
|
||||
|
|
@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 158 | 0 | 131 | 2 |
|
||||
| 149 | 0 | 125 | 1 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableAlertsTable']
|
||||
---
|
||||
import embeddableAlertsTableObj from './embeddable_alerts_table.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -257,16 +257,16 @@
|
|||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddableEnhanced",
|
||||
"id": "def-public.StartContract.initializeReactEmbeddableDynamicActions",
|
||||
"id": "def-public.StartContract.initializeEmbeddableDynamicActions",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "initializeReactEmbeddableDynamicActions",
|
||||
"label": "initializeEmbeddableDynamicActions",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(uuid: string, getTitle: () => string | undefined, state: ",
|
||||
"DynamicActionsSerializedState",
|
||||
") => ",
|
||||
"ReactEmbeddableDynamicActionsApi"
|
||||
"EmbeddableDynamicActionsManager"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/embeddable_enhanced/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -274,7 +274,7 @@
|
|||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddableEnhanced",
|
||||
"id": "def-public.StartContract.initializeReactEmbeddableDynamicActions.$1",
|
||||
"id": "def-public.StartContract.initializeEmbeddableDynamicActions.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "uuid",
|
||||
|
|
@ -289,7 +289,7 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "embeddableEnhanced",
|
||||
"id": "def-public.StartContract.initializeReactEmbeddableDynamicActions.$2",
|
||||
"id": "def-public.StartContract.initializeEmbeddableDynamicActions.$2",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getTitle",
|
||||
|
|
@ -304,7 +304,7 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "embeddableEnhanced",
|
||||
"id": "def-public.StartContract.initializeReactEmbeddableDynamicActions.$3",
|
||||
"id": "def-public.StartContract.initializeEmbeddableDynamicActions.$3",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
|
||||
---
|
||||
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
|
||||
---
|
||||
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
|
||||
---
|
||||
import enterpriseSearchObj from './enterprise_search.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'entitiesDataAccess']
|
||||
---
|
||||
import entitiesDataAccessObj from './entities_data_access.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'entityManager']
|
||||
---
|
||||
import entityManagerObj from './entity_manager.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
|
||||
---
|
||||
import esUiSharedObj from './es_ui_shared.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -484,6 +484,22 @@
|
|||
"path": "src/platform/packages/private/kbn-esql-editor/src/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "esql",
|
||||
"id": "def-public.ESQLEditorProps.expandToFitQueryOnMount",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "expandToFitQueryOnMount",
|
||||
"description": [
|
||||
"Resize the editor to fit the initially passed query on mount"
|
||||
],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "src/platform/packages/private/kbn-esql-editor/src/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -513,11 +529,35 @@
|
|||
"signature": [
|
||||
"() => Promise<",
|
||||
{
|
||||
"pluginId": "esql",
|
||||
"pluginId": "@kbn/esql-types",
|
||||
"scope": "common",
|
||||
"docId": "kibEsqlPluginApi",
|
||||
"section": "def-common.JoinIndicesAutocompleteResult",
|
||||
"text": "JoinIndicesAutocompleteResult"
|
||||
"docId": "kibKbnEsqlTypesPluginApi",
|
||||
"section": "def-common.IndicesAutocompleteResult",
|
||||
"text": "IndicesAutocompleteResult"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/esql/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "esql",
|
||||
"id": "def-public.EsqlPluginStart.getTimeseriesIndicesAutocomplete",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getTimeseriesIndicesAutocomplete",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => Promise<",
|
||||
{
|
||||
"pluginId": "@kbn/esql-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnEsqlTypesPluginApi",
|
||||
"section": "def-common.IndicesAutocompleteResult",
|
||||
"text": "IndicesAutocompleteResult"
|
||||
},
|
||||
">"
|
||||
],
|
||||
|
|
@ -557,93 +597,7 @@
|
|||
"common": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [
|
||||
{
|
||||
"parentPluginId": "esql",
|
||||
"id": "def-common.JoinIndexAutocompleteItem",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "JoinIndexAutocompleteItem",
|
||||
"description": [],
|
||||
"path": "src/platform/plugins/shared/esql/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "esql",
|
||||
"id": "def-common.JoinIndexAutocompleteItem.name",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"path": "src/platform/plugins/shared/esql/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "esql",
|
||||
"id": "def-common.JoinIndexAutocompleteItem.mode",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "mode",
|
||||
"description": [],
|
||||
"path": "src/platform/plugins/shared/esql/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "esql",
|
||||
"id": "def-common.JoinIndexAutocompleteItem.aliases",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "aliases",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string[]"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/esql/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "esql",
|
||||
"id": "def-common.JoinIndicesAutocompleteResult",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "JoinIndicesAutocompleteResult",
|
||||
"description": [],
|
||||
"path": "src/platform/plugins/shared/esql/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "esql",
|
||||
"id": "def-common.JoinIndicesAutocompleteResult.indices",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "indices",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "esql",
|
||||
"scope": "common",
|
||||
"docId": "kibEsqlPluginApi",
|
||||
"section": "def-common.JoinIndexAutocompleteItem",
|
||||
"text": "JoinIndexAutocompleteItem"
|
||||
},
|
||||
"[]"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/esql/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esql']
|
||||
---
|
||||
import esqlObj from './esql.devdocs.json';
|
||||
|
|
@ -21,7 +21,7 @@ Contact [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 36 | 0 | 16 | 1 |
|
||||
| 32 | 0 | 11 | 1 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
@ -34,8 +34,3 @@ Contact [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql
|
|||
### Interfaces
|
||||
<DocDefinitionList data={esqlObj.client.interfaces}/>
|
||||
|
||||
## Common
|
||||
|
||||
### Interfaces
|
||||
<DocDefinitionList data={esqlObj.common.interfaces}/>
|
||||
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esqlDataGrid']
|
||||
---
|
||||
import esqlDataGridObj from './esql_data_grid.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
|
||||
---
|
||||
import eventAnnotationObj from './event_annotation.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotationListing']
|
||||
---
|
||||
import eventAnnotationListingObj from './event_annotation_listing.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
|
||||
---
|
||||
import eventLogObj from './event_log.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
|
||||
---
|
||||
import exploratoryViewObj from './exploratory_view.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
|
||||
---
|
||||
import expressionGaugeObj from './expression_gauge.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
|
||||
---
|
||||
import expressionHeatmapObj from './expression_heatmap.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
|
||||
---
|
||||
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -434,6 +434,62 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.secondaryColor",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "secondaryColor",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.secondaryTrendVisuals",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "secondaryTrendVisuals",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.secondaryTrendBaseline",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "secondaryTrendBaseline",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | number | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.secondaryTrendPalette",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "secondaryTrendPalette",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"[string, string, string] | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.progressDirection",
|
||||
|
|
@ -737,6 +793,34 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam.secondaryColor",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "secondaryColor",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam.secondaryTrend",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "secondaryTrend",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ visuals?: string | undefined; baseline?: string | number | undefined; palette?: [string, string, string] | undefined; }"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam.color",
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
|
||||
---
|
||||
import expressionMetricVisObj from './expression_metric_vis.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 |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 75 | 0 | 75 | 2 |
|
||||
| 81 | 0 | 81 | 2 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
|
||||
---
|
||||
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
|
||||
---
|
||||
import expressionTagcloudObj from './expression_tagcloud.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
|
||||
---
|
||||
import expressionXYObj from './expression_x_y.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -30850,7 +30850,23 @@
|
|||
"tags": [],
|
||||
"label": "dimensionName",
|
||||
"description": [
|
||||
"\nnames the domain this column represents"
|
||||
"\ni18nized names the domain this column represents"
|
||||
],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/expressions/common/expression_types/specs/datatable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressions",
|
||||
"id": "def-common.DatatableColumnMeta.dimensionType",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "dimensionType",
|
||||
"description": [
|
||||
"\ntypes of dimension this column represents"
|
||||
],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
|
|
@ -36878,6 +36894,18 @@
|
|||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressions",
|
||||
"id": "def-common.DimensionType",
|
||||
"type": "Enum",
|
||||
"tags": [],
|
||||
"label": "DimensionType",
|
||||
"description": [],
|
||||
"path": "src/platform/plugins/shared/expressions/common/expression_types/specs/datatable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressions",
|
||||
"id": "def-common.FontSizeUnit",
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
|
||||
---
|
||||
import expressionsObj from './expressions.devdocs.json';
|
||||
|
|
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2267 | 17 | 1795 | 6 |
|
||||
| 2269 | 17 | 1796 | 6 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
|
||||
---
|
||||
import featuresObj from './features.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
|
||||
---
|
||||
import fieldFormatsObj from './field_formats.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldsMetadata']
|
||||
---
|
||||
import fieldsMetadataObj from './fields_metadata.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
|
||||
---
|
||||
import fileUploadObj from './file_upload.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -1353,27 +1353,27 @@
|
|||
"InfoResponse",
|
||||
">; }; ingest: ",
|
||||
"default",
|
||||
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"; knnSearch: { (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
">; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
", unknown>>; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; }; license: ",
|
||||
"TODO",
|
||||
">; }; license: ",
|
||||
"default",
|
||||
"; logstash: ",
|
||||
"default",
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
|
||||
---
|
||||
import filesObj from './files.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
|
||||
---
|
||||
import filesManagementObj from './files_management.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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, minCardHeight, 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, hasDataStreams, }: ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "public",
|
||||
|
|
@ -1684,6 +1684,20 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-public.IntegrationCardItem.hasDataStreams",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "hasDataStreams",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | 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.icons",
|
||||
|
|
@ -7880,27 +7894,27 @@
|
|||
"InfoResponse",
|
||||
">; }; ingest: ",
|
||||
"default",
|
||||
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"; knnSearch: { (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
">; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
", unknown>>; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; }; license: ",
|
||||
"TODO",
|
||||
">; }; license: ",
|
||||
"default",
|
||||
"; logstash: ",
|
||||
"default",
|
||||
|
|
@ -9083,27 +9097,27 @@
|
|||
"InfoResponse",
|
||||
">; }; ingest: ",
|
||||
"default",
|
||||
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"; knnSearch: { (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
">; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
", unknown>>; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; }; license: ",
|
||||
"TODO",
|
||||
">; }; license: ",
|
||||
"default",
|
||||
"; logstash: ",
|
||||
"default",
|
||||
|
|
@ -15514,27 +15528,27 @@
|
|||
"InfoResponse",
|
||||
">; }; ingest: ",
|
||||
"default",
|
||||
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"; knnSearch: { (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
">; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
", unknown>>; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; }; license: ",
|
||||
"TODO",
|
||||
">; }; license: ",
|
||||
"default",
|
||||
"; logstash: ",
|
||||
"default",
|
||||
|
|
@ -16605,27 +16619,27 @@
|
|||
"InfoResponse",
|
||||
">; }; ingest: ",
|
||||
"default",
|
||||
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"; knnSearch: { (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
">; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
", unknown>>; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; }; license: ",
|
||||
"TODO",
|
||||
">; }; license: ",
|
||||
"default",
|
||||
"; logstash: ",
|
||||
"default",
|
||||
|
|
@ -17709,27 +17723,27 @@
|
|||
"InfoResponse",
|
||||
">; }; ingest: ",
|
||||
"default",
|
||||
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"; knnSearch: { (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
">; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
", unknown>>; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; }; license: ",
|
||||
"TODO",
|
||||
">; }; license: ",
|
||||
"default",
|
||||
"; logstash: ",
|
||||
"default",
|
||||
|
|
@ -18810,27 +18824,27 @@
|
|||
"InfoResponse",
|
||||
">; }; ingest: ",
|
||||
"default",
|
||||
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"; knnSearch: { (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
">; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
", unknown>>; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; }; license: ",
|
||||
"TODO",
|
||||
">; }; license: ",
|
||||
"default",
|
||||
"; logstash: ",
|
||||
"default",
|
||||
|
|
@ -19914,27 +19928,27 @@
|
|||
"InfoResponse",
|
||||
">; }; ingest: ",
|
||||
"default",
|
||||
"; knnSearch: { <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"; knnSearch: { (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
">; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>, unknown>>; <TDocument = unknown>(this: That, params: ",
|
||||
"KnnSearchRequest",
|
||||
", options?: ",
|
||||
"TODO",
|
||||
", unknown>>; (this: That, params?: ",
|
||||
"TODO",
|
||||
" | undefined, options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"KnnSearchResponse",
|
||||
"<TDocument>>; }; license: ",
|
||||
"TODO",
|
||||
">; }; license: ",
|
||||
"default",
|
||||
"; logstash: ",
|
||||
"default",
|
||||
|
|
@ -21820,13 +21834,21 @@
|
|||
"label": "result",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ error?: Error | undefined; status?: ",
|
||||
"InstallResultStatus",
|
||||
" | undefined; assets?: ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.InstallResult",
|
||||
"text": "InstallResult"
|
||||
}
|
||||
"section": "def-common.AssetReference",
|
||||
"text": "AssetReference"
|
||||
},
|
||||
"[] | undefined; installType: ",
|
||||
"InstallType",
|
||||
"; installSource?: ",
|
||||
"InstallSource",
|
||||
" | undefined; }"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/fleet/common/types/rest_spec/epm.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -24769,6 +24791,17 @@
|
|||
"path": "x-pack/platform/plugins/shared/fleet/common/types/rest_spec/epm.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.InstallResult.pkgName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "pkgName",
|
||||
"description": [],
|
||||
"path": "x-pack/platform/plugins/shared/fleet/common/types/rest_spec/epm.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
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 |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 1542 | 5 | 1413 | 91 |
|
||||
| 1544 | 5 | 1415 | 92 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
|
||||
---
|
||||
import globalSearchObj from './global_search.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
|
||||
---
|
||||
import guidedOnboardingObj from './guided_onboarding.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -2075,7 +2075,7 @@
|
|||
"section": "def-server.TutorialContext",
|
||||
"text": "TutorialContext"
|
||||
},
|
||||
") => Readonly<{ artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; euiIconType?: string | undefined; isBeta?: boolean | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{} & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{} & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { id: string; name: string; category: \"security\" | \"metrics\" | \"other\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{} & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>"
|
||||
") => Readonly<{ artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; euiIconType?: string | undefined; isBeta?: boolean | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{} & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{} & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; omitServerless?: boolean | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { id: string; name: string; category: \"security\" | \"metrics\" | \"other\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{} & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -2113,7 +2113,7 @@
|
|||
"label": "TutorialSchema",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly euiIconType?: string | undefined; readonly isBeta?: boolean | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{} & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{} & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly id: string; readonly name: string; readonly category: \"security\" | \"metrics\" | \"other\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{} & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }"
|
||||
"{ readonly artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly euiIconType?: string | undefined; readonly isBeta?: boolean | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{} & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{} & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly omitServerless?: boolean | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly id: string; readonly name: string; readonly category: \"security\" | \"metrics\" | \"other\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{} & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }"
|
||||
],
|
||||
"path": "src/platform/plugins/shared/home/server/services/tutorials/lib/tutorial_schema.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
|
||||
---
|
||||
import homeObj from './home.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
|
||||
---
|
||||
import imageEmbeddableObj from './image_embeddable.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -2275,7 +2275,7 @@
|
|||
"label": "indexMode",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"standard\" | \"time_series\" | \"lookup\" | \"logsdb\""
|
||||
"\"standard\" | \"time_series\" | \"logsdb\" | \"lookup\""
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -3910,7 +3910,7 @@
|
|||
"label": "IndexMode",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"standard\" | \"time_series\" | \"lookup\" | \"logsdb\""
|
||||
"\"standard\" | \"time_series\" | \"logsdb\" | \"lookup\""
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/index_management/common/types/data_streams.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
|||
|
|
@ -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-06
|
||||
date: 2025-05-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
|
||||
---
|
||||
import indexManagementObj from './index_management.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -278,6 +278,320 @@
|
|||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "inference",
|
||||
"id": "def-server.withChatCompleteSpan",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "withChatCompleteSpan",
|
||||
"description": [
|
||||
"\nWrapper around {@link withInferenceSpan} that sets the right attributes for a chat operation span."
|
||||
],
|
||||
"signature": [
|
||||
"(options: InferenceGenerationOptions, cb: (span?: ",
|
||||
"Span",
|
||||
" | undefined) => T) => T"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/inference/server/tracing/with_chat_complete_span.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "inference",
|
||||
"id": "def-server.withChatCompleteSpan.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"InferenceGenerationOptions"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/inference/server/tracing/with_chat_complete_span.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "inference",
|
||||
"id": "def-server.withChatCompleteSpan.$2",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "cb",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(span?: ",
|
||||
"Span",
|
||||
" | undefined) => T"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/inference/server/tracing/with_chat_complete_span.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "inference",
|
||||
"id": "def-server.withChatCompleteSpan",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "withChatCompleteSpan",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(options: InferenceGenerationOptions, cb: (span?: ",
|
||||
"Span",
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "@kbn/inference-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnInferenceCommonPluginApi",
|
||||
"section": "def-common.ChatCompleteResponse",
|
||||
"text": "ChatCompleteResponse"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "@kbn/inference-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnInferenceCommonPluginApi",
|
||||
"section": "def-common.ToolOptions",
|
||||
"text": "ToolOptions"
|
||||
},
|
||||
"<string>>> | ",
|
||||
{
|
||||
"pluginId": "@kbn/inference-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnInferenceCommonPluginApi",
|
||||
"section": "def-common.ChatCompleteStreamResponse",
|
||||
"text": "ChatCompleteStreamResponse"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "@kbn/inference-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnInferenceCommonPluginApi",
|
||||
"section": "def-common.ToolOptions",
|
||||
"text": "ToolOptions"
|
||||
},
|
||||
"<string>>) => Promise<",
|
||||
{
|
||||
"pluginId": "@kbn/inference-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnInferenceCommonPluginApi",
|
||||
"section": "def-common.ChatCompleteResponse",
|
||||
"text": "ChatCompleteResponse"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "@kbn/inference-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnInferenceCommonPluginApi",
|
||||
"section": "def-common.ToolOptions",
|
||||
"text": "ToolOptions"
|
||||
},
|
||||
"<string>>> | ",
|
||||
{
|
||||
"pluginId": "@kbn/inference-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnInferenceCommonPluginApi",
|
||||
"section": "def-common.ChatCompleteStreamResponse",
|
||||
"text": "ChatCompleteStreamResponse"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "@kbn/inference-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnInferenceCommonPluginApi",
|
||||
"section": "def-common.ToolOptions",
|
||||
"text": "ToolOptions"
|
||||
},
|
||||
"<string>>"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/inference/server/tracing/with_chat_complete_span.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "inference",
|
||||
"id": "def-server.withChatCompleteSpan.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"InferenceGenerationOptions"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/inference/server/tracing/with_chat_complete_span.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "inference",
|
||||
"id": "def-server.withChatCompleteSpan.$2",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "cb",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(span?: ",
|
||||
"Span",
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "@kbn/inference-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnInferenceCommonPluginApi",
|
||||
"section": "def-common.ChatCompleteResponse",
|
||||
"text": "ChatCompleteResponse"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "@kbn/inference-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnInferenceCommonPluginApi",
|
||||
"section": "def-common.ToolOptions",
|
||||
"text": "ToolOptions"
|
||||
},
|
||||
"<string>>> | ",
|
||||
{
|
||||
"pluginId": "@kbn/inference-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnInferenceCommonPluginApi",
|
||||
"section": "def-common.ChatCompleteStreamResponse",
|
||||
"text": "ChatCompleteStreamResponse"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "@kbn/inference-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnInferenceCommonPluginApi",
|
||||
"section": "def-common.ToolOptions",
|
||||
"text": "ToolOptions"
|
||||
},
|
||||
"<string>>"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/inference/server/tracing/with_chat_complete_span.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "inference",
|
||||
"id": "def-server.withExecuteToolSpan",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "withExecuteToolSpan",
|
||||
"description": [
|
||||
"\nWrapper around {@link withInferenceSpan} that sets the right attributes for a execute_tool operation span."
|
||||
],
|
||||
"signature": [
|
||||
"(options: string | { name: string; description?: string | undefined; toolCallId?: string | undefined; input?: unknown; }, cb: (span?: ",
|
||||
"Span",
|
||||
" | undefined) => T) => T"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/inference/server/tracing/with_execute_tool_span.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "inference",
|
||||
"id": "def-server.withExecuteToolSpan.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | { name: string; description?: string | undefined; toolCallId?: string | undefined; input?: unknown; }"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/inference/server/tracing/with_execute_tool_span.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "inference",
|
||||
"id": "def-server.withExecuteToolSpan.$2",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "cb",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(span?: ",
|
||||
"Span",
|
||||
" | undefined) => T"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/inference/server/tracing/with_execute_tool_span.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "inference",
|
||||
"id": "def-server.withInferenceSpan",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "withInferenceSpan",
|
||||
"description": [
|
||||
"\nWraps a callback in an active span. If the callback returns an Observable\nor Promise, it will set the span status to the appropriate value when the\nasync operation completes."
|
||||
],
|
||||
"signature": [
|
||||
"(options: string | ({ name: string; } & ",
|
||||
"GenAISemConvAttributes",
|
||||
"), cb: (span?: ",
|
||||
"Span",
|
||||
" | undefined) => T) => T"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/inference/server/tracing/with_inference_span.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "inference",
|
||||
"id": "def-server.withInferenceSpan.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | ({ name: string; } & ",
|
||||
"GenAISemConvAttributes",
|
||||
")"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/inference/server/tracing/with_inference_span.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "inference",
|
||||
"id": "def-server.withInferenceSpan.$2",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "cb",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(span?: ",
|
||||
"Span",
|
||||
" | undefined) => T"
|
||||
],
|
||||
"path": "x-pack/platform/plugins/shared/inference/server/tracing/with_inference_span.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue