github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-28 11:05:39 -04:00
Code Issues Projects Releases Packages Wiki Activity

[api-docs] 2024-08-07 Daily api_docs build (#190021)

Browse source 
Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/792
This commit is contained in:
Kibana Machine 2024-08-07 14:58:47 +10:00 • committed by GitHub
parent ae1ff9edbf
commit 199d0f60f9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
737 changed files with 2665 additions and 910 deletions
Download patch file Download diff file Expand all files Collapse all files

2
api_docs/actions.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions
title: "actions" 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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
--- ---
import actionsObj from './actions.devdocs.json'; import actionsObj from './actions.devdocs.json';

2
api_docs/advanced_settings.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings
title: "advancedSettings" 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-08-06 date: 2024-08-07
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';

2
api_docs/ai_assistant_management_selection.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/aiops.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
--- ---
import aiopsObj from './aiops.devdocs.json'; import aiopsObj from './aiops.devdocs.json';

10
api_docs/alerting.devdocs.json
View file

@ -4128,7 +4128,15 @@
"section": "def-common.DataViewLazy", "section": "def-common.DataViewLazy",
"text": "DataViewLazy" "text": "DataViewLazy"
}, },
">; createDataViewLazy: (spec: ", ">; getDataViewLazyFromCache: (id: string) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
" | undefined>; createDataViewLazy: (spec: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",

2
api_docs/alerting.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
--- ---
import alertingObj from './alerting.devdocs.json'; import alertingObj from './alerting.devdocs.json';

128
api_docs/apm.devdocs.json
View file

@ -6135,97 +6135,7 @@
"Type", "Type",
"<number, string, unknown>; end: ", "<number, string, unknown>; end: ",
"Type", "Type",
"<number, string, unknown>; }>, ", "<number, string, unknown>; }>]>; body: ",
"IntersectionC",
"<[",
"PartialC",
"<{ offset: ",
"StringC",
"; }>, ",
"TypeC",
"<{ probability: ",
"Type",
"<number, number, unknown>; }>, ",
"TypeC",
"<{ documentType: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "apmDataAccess",
"scope": "common",
"docId": "kibApmDataAccessPluginApi",
"section": "def-common.ApmDocumentType",
"text": "ApmDocumentType"
},
".ServiceTransactionMetric>, ",
"LiteralC",
"<",
{
"pluginId": "apmDataAccess",
"scope": "common",
"docId": "kibApmDataAccessPluginApi",
"section": "def-common.ApmDocumentType",
"text": "ApmDocumentType"
},
".TransactionMetric>, ",
"LiteralC",
"<",
{
"pluginId": "apmDataAccess",
"scope": "common",
"docId": "kibApmDataAccessPluginApi",
"section": "def-common.ApmDocumentType",
"text": "ApmDocumentType"
},
".TransactionEvent>]>; rollupInterval: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "apmDataAccess",
"scope": "common",
"docId": "kibApmDataAccessPluginApi",
"section": "def-common.RollupInterval",
"text": "RollupInterval"
},
".OneMinute>, ",
"LiteralC",
"<",
{
"pluginId": "apmDataAccess",
"scope": "common",
"docId": "kibApmDataAccessPluginApi",
"section": "def-common.RollupInterval",
"text": "RollupInterval"
},
".TenMinutes>, ",
"LiteralC",
"<",
{
"pluginId": "apmDataAccess",
"scope": "common",
"docId": "kibApmDataAccessPluginApi",
"section": "def-common.RollupInterval",
"text": "RollupInterval"
},
".SixtyMinutes>, ",
"LiteralC",
"<",
{
"pluginId": "apmDataAccess",
"scope": "common",
"docId": "kibApmDataAccessPluginApi",
"section": "def-common.RollupInterval",
"text": "RollupInterval"
},
".None>]>; }>]>, ",
"TypeC",
"<{ bucketSizeInSeconds: ",
"Type",
"<number, number, unknown>; }>]>; body: ",
"TypeC", "TypeC",
"<{ serviceNames: ", "<{ serviceNames: ",
"Type", "Type",
@ -6241,41 +6151,7 @@
"section": "def-common.NonEmptyStringBrand", "section": "def-common.NonEmptyStringBrand",
"text": "NonEmptyStringBrand" "text": "NonEmptyStringBrand"
}, },
">; } & { kuery: string; } & { start: number; end: number; } & { offset?: string | undefined; } & { probability: number; } & { documentType: ", ">; } & { kuery: string; } & { start: number; end: number; }; body: { serviceNames: string[]; }; }; }) => Promise<{ currentPeriod: { [x: string]: { serviceName: string; latency: { x: number; y: number | null; }[]; logErrorRate: { x: number; y: number | null; }[]; logRate: { x: number; y: number | null; }[]; throughput: { x: number; y: number | null; }[]; failedTransactionRate: { x: number; y: number | null; }[]; }; }; }>; } & ",
{
"pluginId": "apmDataAccess",
"scope": "common",
"docId": "kibApmDataAccessPluginApi",
"section": "def-common.ApmDocumentType",
"text": "ApmDocumentType"
},
".TransactionMetric | ",
{
"pluginId": "apmDataAccess",
"scope": "common",
"docId": "kibApmDataAccessPluginApi",
"section": "def-common.ApmDocumentType",
"text": "ApmDocumentType"
},
".ServiceTransactionMetric | ",
{
"pluginId": "apmDataAccess",
"scope": "common",
"docId": "kibApmDataAccessPluginApi",
"section": "def-common.ApmDocumentType",
"text": "ApmDocumentType"
},
".TransactionEvent; rollupInterval: ",
{
"pluginId": "apmDataAccess",
"scope": "common",
"docId": "kibApmDataAccessPluginApi",
"section": "def-common.RollupInterval",
"text": "RollupInterval"
},
"; } & { bucketSizeInSeconds: number; }; body: { serviceNames: string[]; }; }; }) => Promise<{ currentPeriod: { apm: { [x: string]: ",
"ServiceTransactionDetailedStat",
"; }; logErrorRate: { [x: string]: { x: number; y: number | null; }[]; }; logRate: { [x: string]: { x: number; y: number | null; }[]; }; }; }>; } & ",
"APMRouteCreateOptions", "APMRouteCreateOptions",
"; \"GET /internal/apm/entities/services/{serviceName}/logs_error_rate_timeseries\": { endpoint: \"GET /internal/apm/entities/services/{serviceName}/logs_error_rate_timeseries\"; params?: ", "; \"GET /internal/apm/entities/services/{serviceName}/logs_error_rate_timeseries\": { endpoint: \"GET /internal/apm/entities/services/{serviceName}/logs_error_rate_timeseries\"; params?: ",
"TypeC", "TypeC",

4
api_docs/apm.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
--- ---
import apmObj from './apm.devdocs.json'; import apmObj from './apm.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-infra_services-team](https://github.com/orgs/elastic/te
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 29 | 0 | 29 | 119 | | 29 | 0 | 29 | 118 |
## Client ## Client

2
api_docs/apm_data_access.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/assets_data_access.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/assetsDataAccess
title: "assetsDataAccess" title: "assetsDataAccess"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the assetsDataAccess plugin description: API docs for the assetsDataAccess plugin
date: 2024-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetsDataAccess'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetsDataAccess']
--- ---
import assetsDataAccessObj from './assets_data_access.devdocs.json'; import assetsDataAccessObj from './assets_data_access.devdocs.json';

2
api_docs/banners.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
--- ---
import bannersObj from './banners.devdocs.json'; import bannersObj from './banners.devdocs.json';

2
api_docs/bfetch.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
--- ---
import bfetchObj from './bfetch.devdocs.json'; import bfetchObj from './bfetch.devdocs.json';

2
api_docs/canvas.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
--- ---
import canvasObj from './canvas.devdocs.json'; import canvasObj from './canvas.devdocs.json';

2
api_docs/cases.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases
title: "cases" 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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
--- ---
import casesObj from './cases.devdocs.json'; import casesObj from './cases.devdocs.json';

2
api_docs/charts.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts
title: "charts" 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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
--- ---
import chartsObj from './charts.devdocs.json'; import chartsObj from './charts.devdocs.json';

2
api_docs/cloud.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud
title: "cloud" 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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
--- ---
import cloudObj from './cloud.devdocs.json'; import cloudObj from './cloud.devdocs.json';

2
api_docs/cloud_data_migration.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration
title: "cloudDataMigration" 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-08-06 date: 2024-08-07
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';

2
api_docs/cloud_defend.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/cloud_experiments.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/cloud_security_posture.mdx
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-08-06 date: 2024-08-07
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';

18
api_docs/console.devdocs.json
View file

@ -761,6 +761,24 @@
], ],
"returnComment": [] "returnComment": []
}, },
{
"parentPluginId": "console",
"id": "def-public.ConsolePluginStart.openEmbeddedConsoleAlternateView",
"type": "Function",
"tags": [],
"label": "openEmbeddedConsoleAlternateView",
"description": [
"\nopenEmbeddedConsoleAlternateView is available if the embedded console can be rendered.\nCalling this function will open the embedded console to the alternative view. If there is no alternative view registered\nthis will open the embedded console."
],
"signature": [
"(() => void) | undefined"
],
"path": "src/plugins/console/public/types/plugin_dependencies.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{ {
"parentPluginId": "console", "parentPluginId": "console",
"id": "def-public.ConsolePluginStart.EmbeddableConsole", "id": "def-public.ConsolePluginStart.EmbeddableConsole",

4
api_docs/console.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
--- ---
import consoleObj from './console.devdocs.json'; import consoleObj from './console.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-management](https://github.com/orgs/elastic/teams/kiban
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 38 | 0 | 30 | 0 | | 39 | 0 | 30 | 0 |
## Client ## Client

2
api_docs/content_management.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/controls.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
--- ---
import controlsObj from './controls.devdocs.json'; import controlsObj from './controls.devdocs.json';

2
api_docs/custom_integrations.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/customIntegrations
title: "customIntegrations" 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-08-06 date: 2024-08-07
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';

2
api_docs/dashboard.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
--- ---
import dashboardObj from './dashboard.devdocs.json'; import dashboardObj from './dashboard.devdocs.json';

2
api_docs/dashboard_enhanced.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced
title: "dashboardEnhanced" 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-08-06 date: 2024-08-07
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';

90
api_docs/data.devdocs.json
View file

@ -14378,6 +14378,46 @@
], ],
"returnComment": [] "returnComment": []
}, },
{
"parentPluginId": "data",
"id": "def-server.DataViewsService.getDataViewLazyFromCache",
"type": "Function",
"tags": [],
"label": "getDataViewLazyFromCache",
"description": [],
"signature": [
"(id: string) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
" | undefined>"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.DataViewsService.getDataViewLazyFromCache.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{ {
"parentPluginId": "data", "parentPluginId": "data",
"id": "def-server.DataViewsService.get", "id": "def-server.DataViewsService.get",
@ -21787,6 +21827,46 @@
], ],
"returnComment": [] "returnComment": []
}, },
{
"parentPluginId": "data",
"id": "def-common.DataViewsService.getDataViewLazyFromCache",
"type": "Function",
"tags": [],
"label": "getDataViewLazyFromCache",
"description": [],
"signature": [
"(id: string) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
" | undefined>"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.DataViewsService.getDataViewLazyFromCache.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{ {
"parentPluginId": "data", "parentPluginId": "data",
"id": "def-common.DataViewsService.get", "id": "def-common.DataViewsService.get",
@ -25293,7 +25373,15 @@
"section": "def-common.DataViewLazy", "section": "def-common.DataViewLazy",
"text": "DataViewLazy" "text": "DataViewLazy"
}, },
">; createDataViewLazy: (spec: ", ">; getDataViewLazyFromCache: (id: string) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
" | undefined>; createDataViewLazy: (spec: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",

4
api_docs/data.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
--- ---
import dataObj from './data.devdocs.json'; import dataObj from './data.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 3205 | 31 | 2590 | 24 | | 3209 | 31 | 2594 | 24 |
## Client ## Client

2
api_docs/data_quality.mdx
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-08-06 date: 2024-08-07
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';

4
api_docs/data_query.mdx
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-08-06 date: 2024-08-07
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';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 3205 | 31 | 2590 | 24 | | 3209 | 31 | 2594 | 24 |
## Client ## Client

10
api_docs/data_search.devdocs.json
View file

@ -29664,7 +29664,15 @@
"section": "def-common.DataViewLazy", "section": "def-common.DataViewLazy",
"text": "DataViewLazy" "text": "DataViewLazy"
}, },
">; createDataViewLazy: (spec: ", ">; getDataViewLazyFromCache: (id: string) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
" | undefined>; createDataViewLazy: (spec: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",

4
api_docs/data_search.mdx
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-08-06 date: 2024-08-07
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';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 3205 | 31 | 2590 | 24 | | 3209 | 31 | 2594 | 24 |
## Client ## Client

2
api_docs/data_view_editor.mdx
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-08-06 date: 2024-08-07
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';

13
api_docs/data_view_field_editor.devdocs.json
View file

@ -558,6 +558,14 @@
"section": "def-common.DataView", "section": "def-common.DataView",
"text": "DataView" "text": "DataView"
}, },
" | ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewLazy",
"text": "DataViewLazy"
},
"; }" "; }"
], ],
"path": "src/plugins/data_view_field_editor/public/open_delete_modal.tsx", "path": "src/plugins/data_view_field_editor/public/open_delete_modal.tsx",
@ -1077,8 +1085,9 @@
"section": "def-public.OpenFieldDeleteModalOptions", "section": "def-public.OpenFieldDeleteModalOptions",
"text": "OpenFieldDeleteModalOptions" "text": "OpenFieldDeleteModalOptions"
}, },
") => ", ") => Promise<",
"CloseEditor" "CloseEditor",
">"
], ],
"path": "src/plugins/data_view_field_editor/public/types.ts", "path": "src/plugins/data_view_field_editor/public/types.ts",
"deprecated": false, "deprecated": false,

2
api_docs/data_view_field_editor.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/data_view_management.mdx
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-08-06 date: 2024-08-07
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';

1030
api_docs/data_views.devdocs.json
View file

File diff suppressed because it is too large Load diff

4
api_docs/data_views.mdx
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-08-06 date: 2024-08-07
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';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports | | Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------| |-------------------|-----------|------------------------|-----------------|
| 1170 | 0 | 401 | 3 | | 1224 | 0 | 443 | 3 |
## Client ## Client

2
api_docs/data_visualizer.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/dataset_quality.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/deprecations_by_api.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api 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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---

2
api_docs/deprecations_by_plugin.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin 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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---

2
api_docs/deprecations_by_team.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team 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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---

2
api_docs/dev_tools.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/devTools
title: "devTools" 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-08-06 date: 2024-08-07
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';

2
api_docs/discover.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
--- ---
import discoverObj from './discover.devdocs.json'; import discoverObj from './discover.devdocs.json';

2
api_docs/discover_enhanced.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/discover_shared.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/ecs_data_quality_dashboard.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/elastic_assistant.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/embeddable.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
--- ---
import embeddableObj from './embeddable.devdocs.json'; import embeddableObj from './embeddable.devdocs.json';

2
api_docs/embeddable_enhanced.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced
title: "embeddableEnhanced" 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-08-06 date: 2024-08-07
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';

2
api_docs/encrypted_saved_objects.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/enterprise_search.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/entity_manager.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/es_ui_shared.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/esql.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esql'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esql']
--- ---
import esqlObj from './esql.devdocs.json'; import esqlObj from './esql.devdocs.json';

2
api_docs/esql_data_grid.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esqlDataGrid
title: "esqlDataGrid" 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-08-06 date: 2024-08-07
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';

2
api_docs/event_annotation.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/event_annotation_listing.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/event_log.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/exploratory_view.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/expression_error.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/expression_gauge.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/expression_heatmap.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/expression_image.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/expression_legacy_metric_vis.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/expression_metric.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/expression_metric_vis.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/expression_partition_vis.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/expression_repeat_image.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/expression_reveal_image.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/expression_shape.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/expression_tagcloud.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/expression_x_y.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/expressions.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
--- ---
import expressionsObj from './expressions.devdocs.json'; import expressionsObj from './expressions.devdocs.json';

2
api_docs/features.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/features
title: "features" 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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
--- ---
import featuresObj from './features.devdocs.json'; import featuresObj from './features.devdocs.json';

2
api_docs/field_formats.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats
title: "fieldFormats" 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-08-06 date: 2024-08-07
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';

2
api_docs/fields_metadata.devdocs.json
View file

File diff suppressed because one or more lines are too long

2
api_docs/fields_metadata.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/file_upload.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/files.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
--- ---
import filesObj from './files.devdocs.json'; import filesObj from './files.devdocs.json';

2
api_docs/files_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/filesManagement
title: "filesManagement" 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-08-06 date: 2024-08-07
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';

2
api_docs/fleet.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
--- ---
import fleetObj from './fleet.devdocs.json'; import fleetObj from './fleet.devdocs.json';

2
api_docs/global_search.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/guided_onboarding.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/home.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
--- ---
import homeObj from './home.devdocs.json'; import homeObj from './home.devdocs.json';

2
api_docs/image_embeddable.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/imageEmbeddable
title: "imageEmbeddable" 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-08-06 date: 2024-08-07
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';

2
api_docs/index_lifecycle_management.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/index_management.mdx
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-08-06 date: 2024-08-07
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';

318
api_docs/inference.devdocs.json Normal file
View file

@ -0,0 +1,318 @@
{
"id": "inference",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "inference",
"id": "def-public.httpResponseIntoObservable",
"type": "Function",
"tags": [],
"label": "httpResponseIntoObservable",
"description": [],
"signature": [
"() => ",
"OperatorFunction",
"<",
"StreamedHttpResponse",
", T>"
],
"path": "x-pack/plugins/inference/public/util/http_response_into_observable.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "inference",
"id": "def-public.InferencePublicSetup",
"type": "Interface",
"tags": [],
"label": "InferencePublicSetup",
"description": [],
"path": "x-pack/plugins/inference/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "inference",
"id": "def-public.InferencePublicStart",
"type": "Interface",
"tags": [],
"label": "InferencePublicStart",
"description": [],
"path": "x-pack/plugins/inference/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "inference",
"id": "def-public.InferencePublicStart.chatComplete",
"type": "Function",
"tags": [],
"label": "chatComplete",
"description": [],
"signature": [
"(options: { connectorId: string; system?: string | undefined; messages: ",
"Message",
"[]; } & ",
"ToolOptions",
"<string>) => ",
"ChatCompletionResponse",
"<",
"ToolOptions",
"<string>>"
],
"path": "x-pack/plugins/inference/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "inference",
"id": "def-public.InferencePublicStart.chatComplete.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ connectorId: string; system?: string | undefined; messages: ",
"Message",
"[]; } & TToolOptions"
],
"path": "x-pack/plugins/inference/common/chat_complete/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "inference",
"id": "def-public.InferencePublicStart.output",
"type": "Function",
"tags": [],
"label": "output",
"description": [],
"signature": [
"<TId extends string = string, TOutputSchema extends ToolSchemaTypeObject | undefined = ToolSchemaTypeObject | undefined>(id: TId, options: { connectorId: string; system?: string | undefined; input: string; schema?: TOutputSchema | undefined; }) => ",
"Observable",
"<",
"OutputEvent",
"<TId, TOutputSchema extends ToolSchemaTypeObject ? ",
"FromToolSchema",
"<TOutputSchema> : undefined>>"
],
"path": "x-pack/plugins/inference/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "inference",
"id": "def-public.InferencePublicStart.output.$1",
"type": "Uncategorized",
"tags": [],
"label": "id",
"description": [],
"signature": [
"TId"
],
"path": "x-pack/plugins/inference/common/output/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "inference",
"id": "def-public.InferencePublicStart.output.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ connectorId: string; system?: string | undefined; input: string; schema?: TOutputSchema | undefined; }"
],
"path": "x-pack/plugins/inference/common/output/index.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "inference",
"id": "def-public.InferencePublicStart.getConnectors",
"type": "Function",
"tags": [],
"label": "getConnectors",
"description": [],
"signature": [
"() => Promise<",
"InferenceConnector",
"[]>"
],
"path": "x-pack/plugins/inference/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [
{
"parentPluginId": "inference",
"id": "def-server.withoutChunkEvents",
"type": "Function",
"tags": [],
"label": "withoutChunkEvents",
"description": [],
"signature": [
"() => ",
"OperatorFunction",
"<T, Exclude<T, ",
"ChatCompletionChunkEvent",
">>"
],
"path": "x-pack/plugins/inference/common/chat_complete/without_chunk_events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "inference",
"id": "def-server.withoutOutputUpdateEvents",
"type": "Function",
"tags": [],
"label": "withoutOutputUpdateEvents",
"description": [],
"signature": [
"() => ",
"OperatorFunction",
"<T, Exclude<T, ",
"OutputUpdateEvent",
"<string>>>"
],
"path": "x-pack/plugins/inference/common/output/without_output_update_events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "inference",
"id": "def-server.withoutTokenCountEvents",
"type": "Function",
"tags": [],
"label": "withoutTokenCountEvents",
"description": [],
"signature": [
"() => ",
"OperatorFunction",
"<T, Exclude<T, ",
"ChatCompletionTokenCountEvent",
">>"
],
"path": "x-pack/plugins/inference/common/chat_complete/without_token_count_events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "inference",
"id": "def-server.InferenceServerSetup",
"type": "Interface",
"tags": [],
"label": "InferenceServerSetup",
"description": [],
"path": "x-pack/plugins/inference/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "inference",
"id": "def-server.InferenceServerStart",
"type": "Interface",
"tags": [],
"label": "InferenceServerStart",
"description": [],
"path": "x-pack/plugins/inference/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "inference",
"id": "def-server.InferenceServerStart.getClient",
"type": "Function",
"tags": [],
"label": "getClient",
"description": [
"\nCreates an inference client, scoped to a request.\n"
],
"signature": [
"(options: InferenceClientCreateOptions) => ",
"InferenceClient"
],
"path": "x-pack/plugins/inference/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "inference",
"id": "def-server.InferenceServerStart.getClient.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [
"{@link InferenceClientCreateOptions }"
],
"signature": [
"InferenceClientCreateOptions"
],
"path": "x-pack/plugins/inference/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

47
api_docs/inference.mdx Normal file
View file

@ -0,0 +1,47 @@
---
####
#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
#### Reach out in #docs-engineering for more info.
####
id: kibInferencePluginApi
slug: /kibana-dev-docs/api/inference
title: "inference"
image: https://source.unsplash.com/400x175/?github
description: API docs for the inference plugin
date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inference']
---
import inferenceObj from './inference.devdocs.json';
Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 16 | 0 | 14 | 11 |
## Client
### Setup
<DocDefinitionList data={[inferenceObj.client.setup]}/>
### Start
<DocDefinitionList data={[inferenceObj.client.start]}/>
### Functions
<DocDefinitionList data={inferenceObj.client.functions}/>
## Server
### Setup
<DocDefinitionList data={[inferenceObj.server.setup]}/>
### Start
<DocDefinitionList data={[inferenceObj.server.start]}/>
### Functions
<DocDefinitionList data={inferenceObj.server.functions}/>

2
api_docs/infra.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
--- ---
import infraObj from './infra.devdocs.json'; import infraObj from './infra.devdocs.json';

2
api_docs/ingest_pipelines.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ingestPipelines
title: "ingestPipelines" 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-08-06 date: 2024-08-07
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';

2
api_docs/inspector.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
--- ---
import inspectorObj from './inspector.devdocs.json'; import inspectorObj from './inspector.devdocs.json';

2
api_docs/integration_assistant.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/interactive_setup.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/investigate.mdx
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-08-06 date: 2024-08-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'investigate'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'investigate']
--- ---
import investigateObj from './investigate.devdocs.json'; import investigateObj from './investigate.devdocs.json';

2
api_docs/investigate_app.mdx
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-08-06 date: 2024-08-07
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';

2
api_docs/kbn_ace.mdx
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-08-06 date: 2024-08-07
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';

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