[api-docs] 2024-09-18 Daily api_docs build (#193236)

Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/834
This commit is contained in:
Kibana Machine 2024-09-18 15:07:34 +10:00 committed by GitHub
parent d58e82272a
commit 81193a904a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
760 changed files with 2492 additions and 4681 deletions

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm
title: "apm" title: "apm"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the apm plugin description: API docs for the apm plugin
date: 2024-09-17 date: 2024-09-18
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
--- ---
import apmObj from './apm.devdocs.json'; import apmObj from './apm.devdocs.json';

View file

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

View file

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

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/bfetch
title: "bfetch" title: "bfetch"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the bfetch plugin description: API docs for the bfetch plugin
date: 2024-09-17 date: 2024-09-18
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
--- ---
import bfetchObj from './bfetch.devdocs.json'; import bfetchObj from './bfetch.devdocs.json';

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDefend
title: "cloudDefend" title: "cloudDefend"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDefend plugin description: API docs for the cloudDefend plugin
date: 2024-09-17 date: 2024-09-18
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
--- ---
import cloudDefendObj from './cloud_defend.devdocs.json'; import cloudDefendObj from './cloud_defend.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudExperiments
title: "cloudExperiments" title: "cloudExperiments"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudExperiments plugin description: API docs for the cloudExperiments plugin
date: 2024-09-17 date: 2024-09-18
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments']
--- ---
import cloudExperimentsObj from './cloud_experiments.devdocs.json'; import cloudExperimentsObj from './cloud_experiments.devdocs.json';

View file

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

View file

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

View file

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

File diff suppressed because it is too large Load diff

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/controls
title: "controls" title: "controls"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the controls plugin description: API docs for the controls plugin
date: 2024-09-17 date: 2024-09-18
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
--- ---
import controlsObj from './controls.devdocs.json'; 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 | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 259 | 0 | 254 | 30 | | 138 | 0 | 134 | 14 |
## Client ## Client
@ -31,9 +31,6 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
### Functions ### Functions
<DocDefinitionList data={controlsObj.client.functions}/> <DocDefinitionList data={controlsObj.client.functions}/>
### Classes
<DocDefinitionList data={controlsObj.client.classes}/>
### Interfaces ### Interfaces
<DocDefinitionList data={controlsObj.client.interfaces}/> <DocDefinitionList data={controlsObj.client.interfaces}/>
@ -45,10 +42,10 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
### Functions ### Functions
<DocDefinitionList data={controlsObj.server.functions}/> <DocDefinitionList data={controlsObj.server.functions}/>
## Common ### Interfaces
<DocDefinitionList data={controlsObj.server.interfaces}/>
### Functions ## Common
<DocDefinitionList data={controlsObj.common.functions}/>
### Interfaces ### Interfaces
<DocDefinitionList data={controlsObj.common.interfaces}/> <DocDefinitionList data={controlsObj.common.interfaces}/>

View file

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

View file

@ -119,48 +119,6 @@
"returnComment": [], "returnComment": [],
"initialIsOpen": false "initialIsOpen": false
}, },
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardRenderer",
"type": "Function",
"tags": [],
"label": "DashboardRenderer",
"description": [],
"signature": [
"React.ForwardRefExoticComponent<",
"DashboardRendererProps",
" & React.RefAttributes<",
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.AwaitingDashboardAPI",
"text": "AwaitingDashboardAPI"
},
">>"
],
"path": "src/plugins/dashboard/public/dashboard_container/external_api/dashboard_renderer.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.DashboardRenderer.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{ {
"parentPluginId": "dashboard", "parentPluginId": "dashboard",
"id": "def-public.DashboardTopNav", "id": "def-public.DashboardTopNav",
@ -377,6 +335,41 @@
], ],
"returnComment": [], "returnComment": [],
"initialIsOpen": false "initialIsOpen": false
},
{
"parentPluginId": "dashboard",
"id": "def-public.LazyDashboardRenderer",
"type": "Function",
"tags": [],
"label": "LazyDashboardRenderer",
"description": [],
"signature": [
"(props: ",
"DashboardRendererProps",
") => JSX.Element"
],
"path": "src/plugins/dashboard/public/dashboard_container/external_api/lazy_dashboard_renderer.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dashboard",
"id": "def-public.LazyDashboardRenderer.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"DashboardRendererProps"
],
"path": "src/plugins/dashboard/public/dashboard_container/external_api/lazy_dashboard_renderer.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
} }
], ],
"interfaces": [ "interfaces": [
@ -750,28 +743,6 @@
} }
], ],
"misc": [ "misc": [
{
"parentPluginId": "dashboard",
"id": "def-public.AwaitingDashboardAPI",
"type": "Type",
"tags": [],
"label": "AwaitingDashboardAPI",
"description": [],
"signature": [
{
"pluginId": "dashboard",
"scope": "public",
"docId": "kibDashboardPluginApi",
"section": "def-public.DashboardAPI",
"text": "DashboardAPI"
},
" | null"
],
"path": "src/plugins/dashboard/public/dashboard_container/external_api/dashboard_api.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{ {
"parentPluginId": "dashboard", "parentPluginId": "dashboard",
"id": "def-public.DASHBOARD_APP_ID", "id": "def-public.DASHBOARD_APP_ID",
@ -819,14 +790,28 @@
}, },
{ {
"parentPluginId": "dashboard", "parentPluginId": "dashboard",
"id": "def-public.DashboardAPI", "id": "def-public.DashboardApi",
"type": "Type", "type": "Type",
"tags": [], "tags": [],
"label": "DashboardAPI", "label": "DashboardApi",
"description": [], "description": [],
"signature": [ "signature": [
"DashboardContainer", {
" & Partial<", "pluginId": "@kbn/presentation-containers",
"scope": "public",
"docId": "kibKbnPresentationContainersPluginApi",
"section": "def-public.CanExpandPanels",
"text": "CanExpandPanels"
},
" & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.HasAppContext",
"text": "HasAppContext"
},
" & ",
{ {
"pluginId": "@kbn/presentation-publishing", "pluginId": "@kbn/presentation-publishing",
"scope": "public", "scope": "public",
@ -835,6 +820,38 @@
"text": "HasType" "text": "HasType"
}, },
"<\"dashboard\"> & ", "<\"dashboard\"> & ",
{
"pluginId": "@kbn/presentation-containers",
"scope": "public",
"docId": "kibKbnPresentationContainersPluginApi",
"section": "def-public.PresentationContainer",
"text": "PresentationContainer"
},
" & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesDataViews",
"text": "PublishesDataViews"
},
" & Pick<",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesPanelTitle",
"text": "PublishesPanelTitle"
},
", \"panelTitle\"> & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesSavedObjectId",
"text": "PublishesSavedObjectId"
},
" & ",
{ {
"pluginId": "@kbn/presentation-publishing", "pluginId": "@kbn/presentation-publishing",
"scope": "public", "scope": "public",
@ -879,20 +896,134 @@
"pluginId": "@kbn/presentation-publishing", "pluginId": "@kbn/presentation-publishing",
"scope": "public", "scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi", "docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesPanelTitle", "section": "def-public.PublishesViewMode",
"text": "PublishesPanelTitle" "text": "PublishesViewMode"
}, },
" & ", " & ",
{
"pluginId": "@kbn/presentation-containers",
"scope": "public",
"docId": "kibKbnPresentationContainersPluginApi",
"section": "def-public.TracksOverlays",
"text": "TracksOverlays"
},
" & { addFromLibrary: () => void; asyncResetToLastSavedState: () => Promise<void>; controlGroupApi$: ",
{ {
"pluginId": "@kbn/presentation-publishing", "pluginId": "@kbn/presentation-publishing",
"scope": "public", "scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi", "docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishesSavedObjectId", "section": "def-public.PublishingSubject",
"text": "PublishesSavedObjectId" "text": "PublishingSubject"
}, },
">" "<",
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlGroupApi",
"text": "ControlGroupApi"
},
" | undefined>; fullScreenMode$: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishingSubject",
"text": "PublishingSubject"
},
"<boolean | undefined>; focusedPanelId$: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishingSubject",
"text": "PublishingSubject"
},
"<string | undefined>; forceRefresh: () => void; getPanelsState: () => ",
{
"pluginId": "dashboard",
"scope": "common",
"docId": "kibDashboardPluginApi",
"section": "def-common.DashboardPanelMap",
"text": "DashboardPanelMap"
},
"; hasOverlays$: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishingSubject",
"text": "PublishingSubject"
},
"<boolean | undefined>; hasRunMigrations$: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishingSubject",
"text": "PublishingSubject"
},
"<boolean | undefined>; hasUnsavedChanges$: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishingSubject",
"text": "PublishingSubject"
},
"<boolean | undefined>; managed$: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.PublishingSubject",
"text": "PublishingSubject"
},
"<boolean | undefined>; runInteractiveSave: (interactionMode: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.ViewMode",
"text": "ViewMode"
},
") => Promise<",
"SaveDashboardReturn",
" | undefined>; runQuickSave: () => Promise<void>; scrollToTop: () => void; setFilters: (filters?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined) => void; setFullScreenMode: (fullScreenMode: boolean) => void; setQuery: (query?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | undefined) => void; setTags: (tags: string[]) => void; setTimeRange: (timeRange?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined) => void; setViewMode: (viewMode: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "public",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-public.ViewMode",
"text": "ViewMode"
},
") => void; openSettingsFlyout: () => void; }"
], ],
"path": "src/plugins/dashboard/public/dashboard_container/external_api/dashboard_api.ts", "path": "src/plugins/dashboard/public/dashboard_api/types.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false, "trackAdoption": false,
"initialIsOpen": false "initialIsOpen": false
@ -962,13 +1093,19 @@
")[] | undefined; controlGroupState?: (Partial<", ")[] | undefined; controlGroupState?: (Partial<",
{ {
"pluginId": "controls", "pluginId": "controls",
"scope": "public", "scope": "common",
"docId": "kibControlsPluginApi", "docId": "kibControlsPluginApi",
"section": "def-public.ControlGroupRuntimeState", "section": "def-common.ControlGroupRuntimeState",
"text": "ControlGroupRuntimeState" "text": "ControlGroupRuntimeState"
}, },
"<", "<",
"DefaultControlState", {
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.DefaultControlState",
"text": "DefaultControlState"
},
">> & ", ">> & ",
{ {
"pluginId": "@kbn/utility-types", "pluginId": "@kbn/utility-types",
@ -2617,7 +2754,7 @@
"section": "def-common.KibanaExecutionContext", "section": "def-common.KibanaExecutionContext",
"text": "KibanaExecutionContext" "text": "KibanaExecutionContext"
}, },
" | undefined; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ", " | undefined; isEmbeddedExternally?: boolean | undefined; timeslice?: [number, number] | undefined; hidePanelTitles?: boolean | undefined; syncTooltips?: boolean | undefined; useMargins?: boolean | undefined; syncColors?: boolean | undefined; syncCursor?: boolean | undefined; lastReloadRequestTime?: number | undefined; enhancements?: ",
{ {
"pluginId": "@kbn/utility-types", "pluginId": "@kbn/utility-types",
"scope": "common", "scope": "common",
@ -2625,7 +2762,7 @@
"section": "def-common.SerializableRecord", "section": "def-common.SerializableRecord",
"text": "SerializableRecord" "text": "SerializableRecord"
}, },
" | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; syncCursor?: boolean | undefined; syncTooltips?: boolean | undefined; timeslice?: [number, number] | undefined; isEmbeddedExternally?: boolean | undefined; useMargins?: boolean | undefined; panels?: ", " | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; panels?: ",
{ {
"pluginId": "dashboard", "pluginId": "dashboard",
"scope": "common", "scope": "common",

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboard
title: "dashboard" title: "dashboard"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboard plugin description: API docs for the dashboard plugin
date: 2024-09-17 date: 2024-09-18
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
--- ---
import dashboardObj from './dashboard.devdocs.json'; 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 | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 129 | 0 | 123 | 12 | | 128 | 0 | 123 | 13 |
## Client ## Client

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -14078,14 +14078,6 @@
"plugin": "lens", "plugin": "lens",
"path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx" "path": "x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx"
}, },
{
"plugin": "controls",
"path": "src/plugins/controls/public/services/options_list/options_list_service.ts"
},
{
"plugin": "controls",
"path": "src/plugins/controls/public/services/options_list/options_list_service.ts"
},
{ {
"plugin": "controls", "plugin": "controls",
"path": "src/plugins/controls/public/react_controls/controls/data_controls/options_list_control/options_list_fetch_cache.ts" "path": "src/plugins/controls/public/react_controls/controls/data_controls/options_list_control/options_list_fetch_cache.ts"
@ -14400,7 +14392,7 @@
}, },
{ {
"plugin": "controls", "plugin": "controls",
"path": "src/plugins/controls/public/services/data_views/data_views.story.ts" "path": "src/plugins/controls/public/services/data_views/data_views.stub.ts"
}, },
{ {
"plugin": "dataViewManagement", "plugin": "dataViewManagement",

View file

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

View file

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

View file

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

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
title: Deprecated API usage 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. description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2024-09-17 date: 2024-09-18
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---
@ -72,7 +72,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginStart.authc" text="authc"/> | alerting, observabilityAIAssistant, fleet, cloudSecurityPosture, entityManager, serverlessSearch, transform, upgradeAssistant, apm, synthetics, security | - | | <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginStart.authc" text="authc"/> | alerting, observabilityAIAssistant, fleet, cloudSecurityPosture, entityManager, serverlessSearch, transform, upgradeAssistant, apm, synthetics, security | - |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | actions, alerting | - | | <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | actions, alerting | - |
| <DocLink id="kibDataPluginApi" section="def-public.syncQueryStateWithUrl" text="syncQueryStateWithUrl"/> | monitoring | - | | <DocLink id="kibDataPluginApi" section="def-public.syncQueryStateWithUrl" text="syncQueryStateWithUrl"/> | monitoring | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | @kbn/core-saved-objects-api-browser, @kbn/core, savedObjects, savedObjectsManagement, visualizations, savedObjectsTagging, eventAnnotation, lens, maps, graph, dashboard, savedObjectsTaggingOss, kibanaUtils, expressions, data, embeddable, uiActionsEnhanced, controls, canvas, dashboardEnhanced, globalSearchProviders | - | | <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | @kbn/core-saved-objects-api-browser, @kbn/core, savedObjects, savedObjectsManagement, visualizations, savedObjectsTagging, eventAnnotation, lens, maps, graph, dashboard, savedObjectsTaggingOss, kibanaUtils, expressions, data, embeddable, uiActionsEnhanced, canvas, dashboardEnhanced, globalSearchProviders, controls | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract" text="SavedObjectsClientContract"/> | @kbn/core-saved-objects-browser, @kbn/core-saved-objects-browser-internal, @kbn/core, home, savedObjects, visualizations, lens, visTypeTimeseries, @kbn/core-saved-objects-browser-mocks | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract" text="SavedObjectsClientContract"/> | @kbn/core-saved-objects-browser, @kbn/core-saved-objects-browser-internal, @kbn/core, home, savedObjects, visualizations, lens, visTypeTimeseries, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.create" text="create"/> | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, savedObjects | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.create" text="create"/> | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, savedObjects | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.bulkCreate" text="bulkCreate"/> | @kbn/core-saved-objects-browser-mocks, home, @kbn/core-saved-objects-browser-internal | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-public.SavedObjectsClientContract.bulkCreate" text="bulkCreate"/> | @kbn/core-saved-objects-browser-mocks, home, @kbn/core-saved-objects-browser-internal | - |
@ -115,7 +115,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnCoreLifecycleBrowserPluginApi" section="def-public.CoreStart.savedObjects" text="savedObjects"/> | @kbn/core-plugins-browser-internal, @kbn/core-root-browser-internal, home, savedObjects, unifiedSearch, visualizations, fileUpload, dashboardEnhanced, transform, discover, dataVisualizer | - | | <DocLink id="kibKbnCoreLifecycleBrowserPluginApi" section="def-public.CoreStart.savedObjects" text="savedObjects"/> | @kbn/core-plugins-browser-internal, @kbn/core-root-browser-internal, home, savedObjects, unifiedSearch, visualizations, fileUpload, dashboardEnhanced, transform, discover, dataVisualizer | - |
| <DocLink id="kibKbnCoreSavedObjectsBrowserMocksPluginApi" section="def-public.simpleSavedObjectMock" text="simpleSavedObjectMock"/> | @kbn/core, lens, savedObjects | - | | <DocLink id="kibKbnCoreSavedObjectsBrowserMocksPluginApi" section="def-public.simpleSavedObjectMock" text="simpleSavedObjectMock"/> | @kbn/core, lens, savedObjects | - |
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddablePanel" text="EmbeddablePanel"/> | lens, dashboard, canvas | - | | <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddablePanel" text="EmbeddablePanel"/> | lens, dashboard, canvas | - |
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableSetup.registerEmbeddableFactory" text="registerEmbeddableFactory"/> | lens, controls, dashboard | - | | <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableSetup.registerEmbeddableFactory" text="registerEmbeddableFactory"/> | lens, dashboard | - |
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableStart.getEmbeddableFactory" text="getEmbeddableFactory"/> | lens, controls, dashboard, investigateApp | - | | <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableStart.getEmbeddableFactory" text="getEmbeddableFactory"/> | lens, controls, dashboard, investigateApp | - |
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableStart.getEmbeddableFactories" text="getEmbeddableFactories"/> | canvas, dashboard | - | | <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableStart.getEmbeddableFactories" text="getEmbeddableFactories"/> | canvas, dashboard | - |
| <DocLink id="kibKbnPresentationPublishingPluginApi" section="def-public.apiHasLegacyLibraryTransforms" text="apiHasLegacyLibraryTransforms"/> | dashboard | - | | <DocLink id="kibKbnPresentationPublishingPluginApi" section="def-public.apiHasLegacyLibraryTransforms" text="apiHasLegacyLibraryTransforms"/> | dashboard | - |

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
title: Deprecated API usage 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. description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2024-09-17 date: 2024-09-18
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---
@ -632,10 +632,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By | | Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | [options_list_service.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/services/options_list/options_list_service.ts#:~:text=title), [options_list_service.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/services/options_list/options_list_service.ts#:~:text=title), [options_list_fetch_cache.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/react_controls/controls/data_controls/options_list_control/options_list_fetch_cache.ts#:~:text=title), [data_views.story.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/services/data_views/data_views.story.ts#:~:text=title) | - | | <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | [options_list_fetch_cache.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/react_controls/controls/data_controls/options_list_control/options_list_fetch_cache.ts#:~:text=title), [data_views.stub.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/services/data_views/data_views.stub.ts#:~:text=title) | - |
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableSetup.registerEmbeddableFactory" text="registerEmbeddableFactory"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/plugin.ts#:~:text=registerEmbeddableFactory), [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/plugin.ts#:~:text=registerEmbeddableFactory), [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/plugin.ts#:~:text=registerEmbeddableFactory), [plugin.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/plugin.ts#:~:text=registerEmbeddableFactory) | - | | <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableStart.getEmbeddableFactory" text="getEmbeddableFactory"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/services/embeddable/types.ts#:~:text=getEmbeddableFactory), [embeddable_service.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/services/embeddable/embeddable_service.ts#:~:text=getEmbeddableFactory), [embeddable.stub.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/services/embeddable/embeddable.stub.ts#:~:text=getEmbeddableFactory) | - |
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableStart.getEmbeddableFactory" text="getEmbeddableFactory"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/services/embeddable/types.ts#:~:text=getEmbeddableFactory), [embeddable_service.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/services/embeddable/embeddable_service.ts#:~:text=getEmbeddableFactory), [embeddable.story.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/public/services/embeddable/embeddable.story.ts#:~:text=getEmbeddableFactory) | - | | <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | [control_group_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/server/control_group/control_group_persistable_state.ts#:~:text=SavedObjectReference), [control_group_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/server/control_group/control_group_persistable_state.ts#:~:text=SavedObjectReference), [control_group_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/server/control_group/control_group_persistable_state.ts#:~:text=SavedObjectReference), [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/server/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/server/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/server/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/server/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/server/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/server/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [time_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/server/time_slider/time_slider_persistable_state.ts#:~:text=SavedObjectReference)+ 2 more | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/common/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/common/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [options_list_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/common/options_list/options_list_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/common/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/common/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [range_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/common/range_slider/range_slider_persistable_state.ts#:~:text=SavedObjectReference), [time_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/common/time_slider/time_slider_persistable_state.ts#:~:text=SavedObjectReference), [time_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/common/time_slider/time_slider_persistable_state.ts#:~:text=SavedObjectReference), [time_slider_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/common/time_slider/time_slider_persistable_state.ts#:~:text=SavedObjectReference), [control_group_persistable_state.ts](https://github.com/elastic/kibana/tree/main/src/plugins/controls/common/control_group/control_group_persistable_state.ts#:~:text=SavedObjectReference)+ 2 more | - |

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
title: Deprecated APIs due to be removed, 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. description: Lists the teams that are referencing deprecated APIs with a remove by date.
date: 2024-09-17 date: 2024-09-18
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -1000,7 +1000,7 @@
"section": "def-public.IEmbeddable", "section": "def-public.IEmbeddable",
"text": "IEmbeddable" "text": "IEmbeddable"
}, },
"<EEI, EEO, any>>(type: string, explicitInput: Partial<EEI>, attributes?: unknown) => Promise<", "<EEI, EEO, any>>(type: string, explicitInput: Partial<EEI>, attributes?: unknown) => Promise<E | ",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "public", "scope": "public",
@ -1008,7 +1008,7 @@
"section": "def-public.ErrorEmbeddable", "section": "def-public.ErrorEmbeddable",
"text": "ErrorEmbeddable" "text": "ErrorEmbeddable"
}, },
" | E>" ">"
], ],
"path": "src/plugins/embeddable/public/lib/containers/container.ts", "path": "src/plugins/embeddable/public/lib/containers/container.ts",
"deprecated": false, "deprecated": false,
@ -1455,7 +1455,7 @@
"section": "def-public.EmbeddableOutput", "section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput" "text": "EmbeddableOutput"
}, },
", any>>(id: string) => Promise<TEmbeddable | ", ", any>>(id: string) => Promise<",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "public", "scope": "public",
@ -1463,7 +1463,7 @@
"section": "def-public.ErrorEmbeddable", "section": "def-public.ErrorEmbeddable",
"text": "ErrorEmbeddable" "text": "ErrorEmbeddable"
}, },
">" " | TEmbeddable>"
], ],
"path": "src/plugins/embeddable/public/lib/containers/container.ts", "path": "src/plugins/embeddable/public/lib/containers/container.ts",
"deprecated": false, "deprecated": false,
@ -1822,7 +1822,7 @@
"section": "def-common.PanelState", "section": "def-common.PanelState",
"text": "PanelState" "text": "PanelState"
}, },
"<{ id: string; version?: string | undefined; }>, otherPanels: TContainerInput[\"panels\"]) => Promise<TEmbeddable | ", "<{ id: string; version?: string | undefined; }>, otherPanels: TContainerInput[\"panels\"]) => Promise<",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "public", "scope": "public",
@ -1830,7 +1830,7 @@
"section": "def-public.ErrorEmbeddable", "section": "def-public.ErrorEmbeddable",
"text": "ErrorEmbeddable" "text": "ErrorEmbeddable"
}, },
">" " | TEmbeddable>"
], ],
"path": "src/plugins/embeddable/public/lib/containers/container.ts", "path": "src/plugins/embeddable/public/lib/containers/container.ts",
"deprecated": false, "deprecated": false,
@ -8394,9 +8394,7 @@
"label": "isExplicitInputWithAttributes", "label": "isExplicitInputWithAttributes",
"description": [], "description": [],
"signature": [ "signature": [
"(value: ", "(value: Partial<",
"ExplicitInputWithAttributes",
" | Partial<",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "common", "scope": "common",
@ -8404,7 +8402,9 @@
"section": "def-common.EmbeddableInput", "section": "def-common.EmbeddableInput",
"text": "EmbeddableInput" "text": "EmbeddableInput"
}, },
">) => value is ", "> | ",
"ExplicitInputWithAttributes",
") => value is ",
"ExplicitInputWithAttributes" "ExplicitInputWithAttributes"
], ],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
@ -8419,8 +8419,7 @@
"label": "value", "label": "value",
"description": [], "description": [],
"signature": [ "signature": [
"ExplicitInputWithAttributes", "Partial<",
" | Partial<",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "common", "scope": "common",
@ -8428,7 +8427,8 @@
"section": "def-common.EmbeddableInput", "section": "def-common.EmbeddableInput",
"text": "EmbeddableInput" "text": "EmbeddableInput"
}, },
">" "> | ",
"ExplicitInputWithAttributes"
], ],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"deprecated": false, "deprecated": false,
@ -10224,9 +10224,9 @@
"section": "def-public.ContainerOutput", "section": "def-public.ContainerOutput",
"text": "ContainerOutput" "text": "ContainerOutput"
}, },
"> | undefined) => Promise<Partial<TEmbeddableInput> | ", "> | undefined) => Promise<",
"ExplicitInputWithAttributes", "ExplicitInputWithAttributes",
">" " | Partial<TEmbeddableInput>>"
], ],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"deprecated": false, "deprecated": false,
@ -10322,7 +10322,7 @@
"section": "def-public.ContainerOutput", "section": "def-public.ContainerOutput",
"text": "ContainerOutput" "text": "ContainerOutput"
}, },
"> | undefined) => Promise<", "> | undefined) => Promise<TEmbeddable | ",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "public", "scope": "public",
@ -10330,7 +10330,7 @@
"section": "def-public.ErrorEmbeddable", "section": "def-public.ErrorEmbeddable",
"text": "ErrorEmbeddable" "text": "ErrorEmbeddable"
}, },
" | TEmbeddable>" ">"
], ],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"deprecated": false, "deprecated": false,
@ -10443,7 +10443,7 @@
"section": "def-public.ContainerOutput", "section": "def-public.ContainerOutput",
"text": "ContainerOutput" "text": "ContainerOutput"
}, },
"> | undefined) => Promise<", "> | undefined) => Promise<TEmbeddable | ",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "public", "scope": "public",
@ -10451,7 +10451,7 @@
"section": "def-public.ErrorEmbeddable", "section": "def-public.ErrorEmbeddable",
"text": "ErrorEmbeddable" "text": "ErrorEmbeddable"
}, },
" | TEmbeddable | undefined>" " | undefined>"
], ],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts", "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
"deprecated": false, "deprecated": false,
@ -13409,7 +13409,7 @@
"section": "def-public.EmbeddableFactory", "section": "def-public.EmbeddableFactory",
"text": "EmbeddableFactory" "text": "EmbeddableFactory"
}, },
"<I, O, E, T>, \"type\" | \"create\" | \"latestVersion\" | \"isEditable\" | \"getDisplayName\"> & Partial<Pick<", "<I, O, E, T>, \"type\" | \"create\" | \"getDisplayName\" | \"latestVersion\" | \"isEditable\"> & Partial<Pick<",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "public", "scope": "public",
@ -13417,7 +13417,7 @@
"section": "def-public.EmbeddableFactory", "section": "def-public.EmbeddableFactory",
"text": "EmbeddableFactory" "text": "EmbeddableFactory"
}, },
"<I, O, E, T>, \"telemetry\" | \"inject\" | \"extract\" | \"migrations\" | \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"grouping\" | \"getIconType\" | \"getDescription\">>" "<I, O, E, T>, \"telemetry\" | \"inject\" | \"extract\" | \"migrations\" | \"getIconType\" | \"grouping\" | \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"getDescription\">>"
], ],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory_definition.ts", "path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory_definition.ts",
"deprecated": false, "deprecated": false,
@ -14512,22 +14512,6 @@
"plugin": "lens", "plugin": "lens",
"path": "x-pack/plugins/lens/public/plugin.ts" "path": "x-pack/plugins/lens/public/plugin.ts"
}, },
{
"plugin": "controls",
"path": "src/plugins/controls/public/plugin.ts"
},
{
"plugin": "controls",
"path": "src/plugins/controls/public/plugin.ts"
},
{
"plugin": "controls",
"path": "src/plugins/controls/public/plugin.ts"
},
{
"plugin": "controls",
"path": "src/plugins/controls/public/plugin.ts"
},
{ {
"plugin": "dashboard", "plugin": "dashboard",
"path": "src/plugins/dashboard/public/plugin.tsx" "path": "src/plugins/dashboard/public/plugin.tsx"
@ -14924,7 +14908,7 @@
}, },
{ {
"plugin": "controls", "plugin": "controls",
"path": "src/plugins/controls/public/services/embeddable/embeddable.story.ts" "path": "src/plugins/controls/public/services/embeddable/embeddable.stub.ts"
}, },
{ {
"plugin": "dashboard", "plugin": "dashboard",

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet
title: "fleet" title: "fleet"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the fleet plugin description: API docs for the fleet plugin
date: 2024-09-17 date: 2024-09-18
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
--- ---
import fleetObj from './fleet.devdocs.json'; import fleetObj from './fleet.devdocs.json';

View file

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

View file

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

View file

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

View file

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

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement
title: "indexLifecycleManagement" title: "indexLifecycleManagement"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the indexLifecycleManagement plugin description: API docs for the indexLifecycleManagement plugin
date: 2024-09-17 date: 2024-09-18
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
--- ---
import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json'; import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json';

View file

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

View file

@ -208,35 +208,15 @@
"label": "naturalLanguageToEsql", "label": "naturalLanguageToEsql",
"description": [], "description": [],
"signature": [ "signature": [
"({\n client,\n connectorId,\n tools,\n toolChoice,\n logger,\n ...rest\n}: { client: Pick<", "({\n client,\n connectorId,\n tools,\n toolChoice,\n logger,\n ...rest\n}: ",
{ "NlToEsqlTaskParams",
"pluginId": "inference", "<TToolOptions>) => ",
"scope": "server",
"docId": "kibInferencePluginApi",
"section": "def-server.InferenceClient",
"text": "InferenceClient"
},
", \"output\" | \"chatComplete\">; connectorId: string; logger: Pick<",
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
},
", \"debug\">; } & TToolOptions & ({ input: string; } | { messages: ",
{
"pluginId": "inference",
"scope": "common",
"docId": "kibInferencePluginApi",
"section": "def-common.Message",
"text": "Message"
},
"[]; })) => ",
"Observable", "Observable",
"<NlToEsqlTaskEvent<TToolOptions>>" "<",
"NlToEsqlTaskEvent",
"<TToolOptions>>"
], ],
"path": "x-pack/plugins/inference/server/tasks/nl_to_esql/index.ts", "path": "x-pack/plugins/inference/server/tasks/nl_to_esql/task.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false, "trackAdoption": false,
"children": [ "children": [
@ -248,33 +228,10 @@
"label": "{\n client,\n connectorId,\n tools,\n toolChoice,\n logger,\n ...rest\n}", "label": "{\n client,\n connectorId,\n tools,\n toolChoice,\n logger,\n ...rest\n}",
"description": [], "description": [],
"signature": [ "signature": [
"{ client: Pick<", "NlToEsqlTaskParams",
{ "<TToolOptions>"
"pluginId": "inference",
"scope": "server",
"docId": "kibInferencePluginApi",
"section": "def-server.InferenceClient",
"text": "InferenceClient"
},
", \"output\" | \"chatComplete\">; connectorId: string; logger: Pick<",
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
},
", \"debug\">; } & TToolOptions & ({ input: string; } | { messages: ",
{
"pluginId": "inference",
"scope": "common",
"docId": "kibInferencePluginApi",
"section": "def-common.Message",
"text": "Message"
},
"[]; })"
], ],
"path": "x-pack/plugins/inference/server/tasks/nl_to_esql/index.ts", "path": "x-pack/plugins/inference/server/tasks/nl_to_esql/task.ts",
"deprecated": false, "deprecated": false,
"trackAdoption": false, "trackAdoption": false,
"isRequired": true "isRequired": true

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inference
title: "inference" title: "inference"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the inference plugin description: API docs for the inference plugin
date: 2024-09-17 date: 2024-09-18
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inference'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inference']
--- ---
import inferenceObj from './inference.devdocs.json'; import inferenceObj from './inference.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/appex-ai-infra](https://github.com/orgs/elastic/teams/appex-ai
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 49 | 0 | 44 | 12 | | 49 | 0 | 44 | 14 |
## Client ## Client

View file

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

View file

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

View file

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

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/integrationAssistant
title: "integrationAssistant" title: "integrationAssistant"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the integrationAssistant plugin description: API docs for the integrationAssistant plugin
date: 2024-09-17 date: 2024-09-18
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'integrationAssistant'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'integrationAssistant']
--- ---
import integrationAssistantObj from './integration_assistant.devdocs.json'; import integrationAssistantObj from './integration_assistant.devdocs.json';

View file

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

View file

@ -50,7 +50,7 @@
"label": "InventoryServerRouteRepository", "label": "InventoryServerRouteRepository",
"description": [], "description": [],
"signature": [ "signature": [
"{ \"GET /internal/inventory/entity_types\": ", "{ \"GET /internal/inventory/entities\": ",
{ {
"pluginId": "@kbn/server-route-repository-utils", "pluginId": "@kbn/server-route-repository-utils",
"scope": "common", "scope": "common",
@ -58,10 +58,10 @@
"section": "def-common.ServerRoute", "section": "def-common.ServerRoute",
"text": "ServerRoute" "text": "ServerRoute"
}, },
"<\"GET /internal/inventory/entity_types\", undefined, ", "<\"GET /internal/inventory/entities\", undefined, ",
"InventoryRouteHandlerResources", "InventoryRouteHandlerResources",
", { definitions: ", ", { entities: ",
"EntityTypeDefinition", "LatestEntity",
"[]; }, ", "[]; }, ",
"InventoryRouteCreateOptions", "InventoryRouteCreateOptions",
">; }" ">; }"

View file

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

View file

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

View file

@ -74,6 +74,18 @@
"InvestigateAppRouteHandlerResources", "InvestigateAppRouteHandlerResources",
", { count: Partial<Record<\"active\" | \"triage\" | \"mitigated\" | \"resolved\" | \"cancelled\", number>>; total: number; }, ", ", { count: Partial<Record<\"active\" | \"triage\" | \"mitigated\" | \"resolved\" | \"cancelled\", number>>; total: number; }, ",
"InvestigateAppRouteCreateOptions", "InvestigateAppRouteCreateOptions",
">; \"GET /api/observability/events 2023-10-31\": ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<\"GET /api/observability/events 2023-10-31\", Zod.ZodObject<{ query: Zod.ZodOptional<Zod.ZodObject<{ rangeFrom: Zod.ZodOptional<Zod.ZodString>; rangeTo: Zod.ZodOptional<Zod.ZodString>; filter: Zod.ZodOptional<Zod.ZodString>; }, \"strip\", Zod.ZodTypeAny, { filter?: string | undefined; rangeFrom?: string | undefined; rangeTo?: string | undefined; }, { filter?: string | undefined; rangeFrom?: string | undefined; rangeTo?: string | undefined; }>>; }, \"strip\", Zod.ZodTypeAny, { query?: { filter?: string | undefined; rangeFrom?: string | undefined; rangeTo?: string | undefined; } | undefined; }, { query?: { filter?: string | undefined; rangeFrom?: string | undefined; rangeTo?: string | undefined; } | undefined; }>, ",
"InvestigateAppRouteHandlerResources",
", ({ id: string; timestamp: number; title: string; description: string; eventType: \"alert\" | \"annotation\" | \"latency\" | \"error_rate\" | \"anomaly\"; source?: Record<string, any> | undefined; } & ({ eventType: \"annotation\"; annotationType?: string | undefined; } | { alertStatus: \"flapping\" | \"recovered\" | \"active\" | \"untracked\"; eventType: \"alert\"; }))[], ",
"InvestigateAppRouteCreateOptions",
">; \"GET /api/observability/investigations/{investigationId}/items 2023-10-31\": ", ">; \"GET /api/observability/investigations/{investigationId}/items 2023-10-31\": ",
{ {
"pluginId": "@kbn/server-route-repository-utils", "pluginId": "@kbn/server-route-repository-utils",

View file

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

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ace
title: "@kbn/ace" title: "@kbn/ace"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ace plugin description: API docs for the @kbn/ace plugin
date: 2024-09-17 date: 2024-09-18
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace'] tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace']
--- ---
import kbnAceObj from './kbn_ace.devdocs.json'; import kbnAceObj from './kbn_ace.devdocs.json';

View file

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

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