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

[api-docs] Daily api_docs build (#139783)

Browse source
This commit is contained in:
Kibana Machine 2022-08-31 00:48:17 -04:00 • committed by GitHub
parent 1bc7fdaf96
commit 75566a6e82
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
404 changed files with 7915 additions and 3285 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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the actions plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the advancedSettings plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
---
import advancedSettingsObj from './advanced_settings.devdocs.json';

2
api_docs/aiops.mdx
View file

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

2
api_docs/alerting.mdx
View file

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

2
api_docs/apm.mdx
View file

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

2
api_docs/banners.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/banners
title: "banners"
image: https://source.unsplash.com/400x175/?github
description: API docs for the banners plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the bfetch plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the canvas plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
---
import canvasObj from './canvas.devdocs.json';

16
api_docs/cases.devdocs.json
View file

@ -307,21 +307,9 @@
"description": [],
"signature": [
"<T extends ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.AppDeepLink",
"text": "AppDeepLink"
},
"AppDeepLink",
" = ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.AppDeepLink",
"text": "AppDeepLink"
},
"AppDeepLink",
">({ basePath, extend, }: { basePath?: string | undefined; extend?: Partial<Record<",
{
"pluginId": "cases",

2
api_docs/cases.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases
title: "cases"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cases plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the charts plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloud plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
---
import cloudObj from './cloud.devdocs.json';

2
api_docs/cloud_security_posture.mdx
View file

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

2
api_docs/console.mdx
View file

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

2
api_docs/controls.mdx
View file

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

1838
api_docs/core.devdocs.json
View file

File diff suppressed because it is too large Load diff

10
api_docs/core.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/core
title: "core"
image: https://source.unsplash.com/400x175/?github
description: API docs for the core plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core']
---
import coreObj from './core.devdocs.json';
@ -21,16 +21,22 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2674 | 1 | 136 | 5 |
| 2656 | 1 | 103 | 3 |
## Client
### Objects
<DocDefinitionList data={coreObj.client.objects}/>
### Classes
<DocDefinitionList data={coreObj.client.classes}/>
### Interfaces
<DocDefinitionList data={coreObj.client.interfaces}/>
### Enums
<DocDefinitionList data={coreObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={coreObj.client.misc}/>

39
api_docs/core_application.mdx
View file

@ -1,39 +0,0 @@
---
####
#### 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: kibCoreApplicationPluginApi
slug: /kibana-dev-docs/api/core-application
title: "core.application"
image: https://source.unsplash.com/400x175/?github
description: API docs for the core.application plugin
date: 2022-08-30
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application']
---
import coreApplicationObj from './core_application.devdocs.json';
Contact [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 |
|-------------------|-----------|------------------------|-----------------|
| 2674 | 1 | 136 | 5 |
## Client
### Classes
<DocDefinitionList data={coreApplicationObj.client.classes}/>
### Interfaces
<DocDefinitionList data={coreApplicationObj.client.interfaces}/>
### Enums
<DocDefinitionList data={coreApplicationObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={coreApplicationObj.client.misc}/>

4
api_docs/core_chrome.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/core-chrome
title: "core.chrome"
image: https://source.unsplash.com/400x175/?github
description: API docs for the core.chrome plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome']
---
import coreChromeObj from './core_chrome.devdocs.json';
@ -21,7 +21,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2674 | 1 | 136 | 5 |
| 2656 | 1 | 103 | 3 |
## Client

2
api_docs/custom_integrations.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/customIntegrations
title: "customIntegrations"
image: https://source.unsplash.com/400x175/?github
description: API docs for the customIntegrations plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboard plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboardEnhanced plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
---
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';

8
api_docs/data.devdocs.json
View file

@ -7116,13 +7116,7 @@
"label": "application",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.ApplicationStart",
"text": "ApplicationStart"
}
"ApplicationStart"
],
"path": "src/plugins/data/public/types.ts",
"deprecated": false

2
api_docs/data.mdx
View file

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

2
api_docs/data_query.mdx
View file

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

2
api_docs/data_search.mdx
View file

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

2
api_docs/data_view_editor.mdx
View file

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

2
api_docs/data_view_field_editor.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor
title: "dataViewFieldEditor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewFieldEditor plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewManagement plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
---
import dataViewManagementObj from './data_view_management.devdocs.json';

2
api_docs/data_views.mdx
View file

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

2
api_docs/data_visualizer.mdx
View file

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

11
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
title: Deprecated API usage by API
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -70,8 +70,8 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | apm, security, securitySolution | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | apm, security, securitySolution | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | visualizations, dashboard, lens, maps, ml, securitySolution, security | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | securitySolution | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | visualizations, dashboard, lens, maps, ml, securitySolution, security, @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | securitySolution, @kbn/core-application-browser-internal | 8.8.0 |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | savedObjectsTaggingOss, dashboard | 8.8.0 |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectsStart.SavedObjectClass" text="SavedObjectClass"/> | dashboard | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsMigrationLogger.warning" text="warning"/> | maps, dashboard, @kbn/core-saved-objects-migration-server-internal | 8.8.0 |
@ -79,7 +79,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibFeaturesPluginApi" section="def-public.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 |
| <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 |
| <DocLink id="kibFeaturesPluginApi" section="def-server.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | management, fleet, security, kibanaOverview | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | management, fleet, security, kibanaOverview, @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks | 8.8.0 |
| <DocLink id="kibHomePluginApi" section="def-public.HomePublicPluginSetup.environment" text="environment"/> | cloud, apm | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | security, licenseManagement, ml, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | 8.8.0 |
| <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getElasticsearchFeatures" text="getElasticsearchFeatures"/> | security | 8.8.0 |
@ -138,6 +138,9 @@ Safe to remove.
| <DocLink id="kibTaskManagerPluginApi" section="def-server.ConcreteTaskInstance.interval" text="interval"/> | taskManager |
| <DocLink id="kibCorePluginApi" section="def-server.AsyncPlugin" text="AsyncPlugin"/> | core |
| <DocLink id="kibCorePluginApi" section="def-server.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> | core |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppLeaveHandler" text="AppLeaveHandler"/> | @kbn/core-application-browser |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | @kbn/core-application-browser |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.onAppLeave" text="onAppLeave"/> | @kbn/core-application-browser |
| <DocLink id="kibKbnCoreElasticsearchServerPluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | @kbn/core-elasticsearch-server |
| <DocLink id="kibKbnCoreHttpBrowserPluginApi" section="def-common.IHttpFetchError.req" text="req"/> | @kbn/core-http-browser |
| <DocLink id="kibKbnCoreHttpBrowserPluginApi" section="def-common.IHttpFetchError.res" text="res"/> | @kbn/core-http-browser |

21
api_docs/deprecations_by_plugin.mdx
View file

@ -7,11 +7,30 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
title: Deprecated API usage by plugin
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
## @kbn/core-application-browser-internal
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=appBasePath) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=onAppLeave) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_container.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler) | 8.8.0 |
## @kbn/core-application-browser-mocks
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application_service.mock.ts](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=appBasePath) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [application_service.mock.ts](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=onAppLeave) | 8.8.0 |
## @kbn/core-elasticsearch-server-internal
| Deprecated API | Reference location(s) | Remove By |

6
api_docs/deprecations_by_team.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
title: Deprecated APIs due to be removed, by team
description: Lists the teams that are referencing deprecated APIs with a remove by date.
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -67,8 +67,10 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------|
| cloud | <DocLink id="kibHomePluginApi" section="def-public.HomePublicPluginSetup.environment" text="environment"/> | [plugin.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud/public/plugin.tsx#:~:text=environment) | 8.8.0 |
| kibanaOverview | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath) | 8.8.0 |
| kibanaOverview | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath), [app_container.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=appBasePath), [application_service.mock.ts](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=appBasePath) | 8.8.0 |
| savedObjectsTaggingOss | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | [api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject) | 8.8.0 |
| @kbn/core-application-browser-internal | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=onAppLeave), [application_service.mock.ts](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=onAppLeave) | 8.8.0 |
| @kbn/core-application-browser-internal | <DocLink id="kibCorePluginApi" section="def-public.AppLeaveHandler" text="AppLeaveHandler"/> | [app_container.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_container.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [app_router.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/ui/app_router.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_leave.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/application_leave.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler), [application_service.tsx](https://github.com/elastic/kibana/tree/master/packages/core/application/core-application-browser-internal/src/application_service.tsx#:~:text=AppLeaveHandler) | 8.8.0 |
| @kbn/core-http-browser-internal | <DocLink id="kibCorePluginApi" section="def-public.IHttpFetchError.req" text="req"/> | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=req) | 8.8.0
Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block,

2
api_docs/dev_tools.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/devTools
title: "devTools"
image: https://source.unsplash.com/400x175/?github
description: API docs for the devTools plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discover plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discoverEnhanced plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
---
import discoverEnhancedObj from './discover_enhanced.devdocs.json';

24
api_docs/embeddable.devdocs.json
View file

@ -2004,13 +2004,7 @@
"label": "application",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.ApplicationStart",
"text": "ApplicationStart"
}
"ApplicationStart"
],
"path": "src/plugins/embeddable/public/lib/actions/edit_panel_action.ts",
"deprecated": false,
@ -3654,13 +3648,7 @@
"description": [],
"signature": [
"(appId: string, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
"NavigateToAppOptions",
" | undefined) => Promise<void>"
],
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",
@ -3691,13 +3679,7 @@
"description": [],
"signature": [
"ReadonlyMap<string, ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.PublicAppInfo",
"text": "PublicAppInfo"
},
"PublicAppInfo",
"> | undefined"
],
"path": "src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts",

2
api_docs/embeddable.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable
title: "embeddable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddable plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddableEnhanced plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the encryptedSavedObjects plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the enterpriseSearch plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
---
import enterpriseSearchObj from './enterprise_search.devdocs.json';

2
api_docs/es_ui_shared.mdx
View file

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

2
api_docs/event_annotation.mdx
View file

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

2
api_docs/event_log.mdx
View file

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

2
api_docs/expression_error.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionError
title: "expressionError"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionError plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionGauge plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionHeatmap plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionImage plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionLegacyMetricVis plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetric plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetricVis plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionPartitionVis plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRepeatImage plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRevealImage plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionShape plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionTagcloud plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionXY plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressions plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the features plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fieldFormats plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
---
import fieldFormatsObj from './field_formats.devdocs.json';

2
api_docs/file_upload.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fileUpload
title: "fileUpload"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fileUpload plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the files plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
---
import filesObj from './files.devdocs.json';

32
api_docs/fleet.devdocs.json
View file

@ -200,13 +200,7 @@
],
"signature": [
"[appId: string, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
"NavigateToAppOptions",
" | undefined] | undefined"
],
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
@ -297,13 +291,7 @@
],
"signature": [
"[appId: string, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
"NavigateToAppOptions",
" | undefined] | undefined"
],
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
@ -335,13 +323,7 @@
],
"signature": [
"[appId: string, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
"NavigateToAppOptions",
" | undefined] | undefined"
],
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",
@ -358,13 +340,7 @@
],
"signature": [
"[appId: string, options?: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.NavigateToAppOptions",
"text": "NavigateToAppOptions"
},
"NavigateToAppOptions",
" | undefined] | undefined"
],
"path": "x-pack/plugins/fleet/public/types/intra_app_route_state.ts",

2
api_docs/fleet.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet
title: "fleet"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fleet plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the globalSearch plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
---
import globalSearchObj from './global_search.devdocs.json';

2
api_docs/home.mdx
View file

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

2
api_docs/index_lifecycle_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement
title: "indexLifecycleManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexLifecycleManagement plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexManagement plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
---
import indexManagementObj from './index_management.devdocs.json';

2
api_docs/infra.mdx
View file

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

2
api_docs/inspector.mdx
View file

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

2
api_docs/interactive_setup.mdx
View file

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

2
api_docs/kbn_ace.mdx
View file

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

2
api_docs/kbn_aiops_components.mdx
View file

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

2
api_docs/kbn_aiops_utils.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils
title: "@kbn/aiops-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/aiops-utils plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils']
---
import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json';

2
api_docs/kbn_alerts.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts
title: "@kbn/alerts"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerts plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts']
---
import kbnAlertsObj from './kbn_alerts.devdocs.json';

53
api_docs/kbn_analytics.devdocs.json
View file

@ -1048,6 +1048,59 @@
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/analytics",
"id": "def-common.UserAgentMetric",
"type": "Interface",
"tags": [],
"label": "UserAgentMetric",
"description": [],
"path": "packages/kbn-analytics/src/metrics/user_agent.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/analytics",
"id": "def-common.UserAgentMetric.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "@kbn/analytics",
"scope": "common",
"docId": "kibKbnAnalyticsPluginApi",
"section": "def-common.METRIC_TYPE",
"text": "METRIC_TYPE"
},
".USER_AGENT"
],
"path": "packages/kbn-analytics/src/metrics/user_agent.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/analytics",
"id": "def-common.UserAgentMetric.appName",
"type": "string",
"tags": [],
"label": "appName",
"description": [],
"path": "packages/kbn-analytics/src/metrics/user_agent.ts",
"deprecated": false
},
{
"parentPluginId": "@kbn/analytics",
"id": "def-common.UserAgentMetric.userAgent",
"type": "string",
"tags": [],
"label": "userAgent",
"description": [],
"path": "packages/kbn-analytics/src/metrics/user_agent.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [

4
api_docs/kbn_analytics.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics
title: "@kbn/analytics"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics']
---
import kbnAnalyticsObj from './kbn_analytics.devdocs.json';
@ -21,7 +21,7 @@ Contact Kibana Core for questions regarding this plugin.
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 69 | 0 | 69 | 2 |
| 73 | 0 | 73 | 2 |
## Common

4
api_docs/kbn_analytics_client.devdocs.json
View file

@ -46,7 +46,7 @@
"text": "IAnalyticsClient"
}
],
"path": "packages/analytics/client/src/index.ts",
"path": "packages/analytics/client/index.ts",
"deprecated": false,
"children": [
{
@ -67,7 +67,7 @@
"text": "AnalyticsClientInitContext"
}
],
"path": "packages/analytics/client/src/index.ts",
"path": "packages/analytics/client/index.ts",
"deprecated": false,
"isRequired": true
}

2
api_docs/kbn_analytics_client.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client
title: "@kbn/analytics-client"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-client plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client']
---
import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json';

2
api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-browser
title: "@kbn/analytics-shippers-elastic-v3-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser']
---
import kbnAnalyticsShippersElasticV3BrowserObj from './kbn_analytics_shippers_elastic_v3_browser.devdocs.json';

2
api_docs/kbn_analytics_shippers_elastic_v3_common.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-common
title: "@kbn/analytics-shippers-elastic-v3-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common']
---
import kbnAnalyticsShippersElasticV3CommonObj from './kbn_analytics_shippers_elastic_v3_common.devdocs.json';

2
api_docs/kbn_analytics_shippers_elastic_v3_server.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-server
title: "@kbn/analytics-shippers-elastic-v3-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server']
---
import kbnAnalyticsShippersElasticV3ServerObj from './kbn_analytics_shippers_elastic_v3_server.devdocs.json';

2
api_docs/kbn_analytics_shippers_fullstory.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory
title: "@kbn/analytics-shippers-fullstory"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-shippers-fullstory plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory']
---
import kbnAnalyticsShippersFullstoryObj from './kbn_analytics_shippers_fullstory.devdocs.json';

2
api_docs/kbn_apm_config_loader.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader
title: "@kbn/apm-config-loader"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-config-loader plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader']
---
import kbnApmConfigLoaderObj from './kbn_apm_config_loader.devdocs.json';

2
api_docs/kbn_apm_synthtrace.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace
title: "@kbn/apm-synthtrace"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-synthtrace plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace']
---
import kbnApmSynthtraceObj from './kbn_apm_synthtrace.devdocs.json';

22
api_docs/kbn_apm_utils.devdocs.json
View file

@ -36,7 +36,7 @@
"text": "SpanOptions"
}
],
"path": "packages/kbn-apm-utils/src/index.ts",
"path": "packages/kbn-apm-utils/index.ts",
"deprecated": false,
"children": [
{
@ -56,7 +56,7 @@
"text": "SpanOptions"
}
],
"path": "packages/kbn-apm-utils/src/index.ts",
"path": "packages/kbn-apm-utils/index.ts",
"deprecated": false,
"isRequired": true
}
@ -84,7 +84,7 @@
"Span",
" | undefined) => Promise<T>) => Promise<T>"
],
"path": "packages/kbn-apm-utils/src/index.ts",
"path": "packages/kbn-apm-utils/index.ts",
"deprecated": false,
"children": [
{
@ -104,7 +104,7 @@
"text": "SpanOptions"
}
],
"path": "packages/kbn-apm-utils/src/index.ts",
"path": "packages/kbn-apm-utils/index.ts",
"deprecated": false,
"isRequired": true
},
@ -120,7 +120,7 @@
"Span",
" | undefined) => Promise<T>"
],
"path": "packages/kbn-apm-utils/src/index.ts",
"path": "packages/kbn-apm-utils/index.ts",
"deprecated": false,
"isRequired": true
}
@ -137,7 +137,7 @@
"tags": [],
"label": "SpanOptions",
"description": [],
"path": "packages/kbn-apm-utils/src/index.ts",
"path": "packages/kbn-apm-utils/index.ts",
"deprecated": false,
"children": [
{
@ -147,7 +147,7 @@
"tags": [],
"label": "name",
"description": [],
"path": "packages/kbn-apm-utils/src/index.ts",
"path": "packages/kbn-apm-utils/index.ts",
"deprecated": false
},
{
@ -160,7 +160,7 @@
"signature": [
"string | undefined"
],
"path": "packages/kbn-apm-utils/src/index.ts",
"path": "packages/kbn-apm-utils/index.ts",
"deprecated": false
},
{
@ -173,7 +173,7 @@
"signature": [
"string | undefined"
],
"path": "packages/kbn-apm-utils/src/index.ts",
"path": "packages/kbn-apm-utils/index.ts",
"deprecated": false
},
{
@ -186,7 +186,7 @@
"signature": [
"Record<string, string> | undefined"
],
"path": "packages/kbn-apm-utils/src/index.ts",
"path": "packages/kbn-apm-utils/index.ts",
"deprecated": false
},
{
@ -199,7 +199,7 @@
"signature": [
"boolean | undefined"
],
"path": "packages/kbn-apm-utils/src/index.ts",
"path": "packages/kbn-apm-utils/index.ts",
"deprecated": false
}
],

2
api_docs/kbn_apm_utils.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils
title: "@kbn/apm-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-utils plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils']
---
import kbnApmUtilsObj from './kbn_apm_utils.devdocs.json';

20
api_docs/kbn_axe_config.devdocs.json
View file

@ -30,7 +30,7 @@
"tags": [],
"label": "AXE_CONFIG",
"description": [],
"path": "packages/kbn-axe-config/src/index.ts",
"path": "packages/kbn-axe-config/index.ts",
"deprecated": false,
"children": [
{
@ -43,7 +43,7 @@
"signature": [
"{ id: string; selector: string; }[]"
],
"path": "packages/kbn-axe-config/src/index.ts",
"path": "packages/kbn-axe-config/index.ts",
"deprecated": false
}
],
@ -56,7 +56,7 @@
"tags": [],
"label": "AXE_OPTIONS",
"description": [],
"path": "packages/kbn-axe-config/src/index.ts",
"path": "packages/kbn-axe-config/index.ts",
"deprecated": false,
"children": [
{
@ -69,7 +69,7 @@
"signature": [
"\"raw\" | \"v2\" | \"v1\" | \"raw-env\" | \"no-passes\""
],
"path": "packages/kbn-axe-config/src/index.ts",
"path": "packages/kbn-axe-config/index.ts",
"deprecated": false
},
{
@ -82,7 +82,7 @@
"signature": [
"string[]"
],
"path": "packages/kbn-axe-config/src/index.ts",
"path": "packages/kbn-axe-config/index.ts",
"deprecated": false
},
{
@ -92,7 +92,7 @@
"tags": [],
"label": "rules",
"description": [],
"path": "packages/kbn-axe-config/src/index.ts",
"path": "packages/kbn-axe-config/index.ts",
"deprecated": false,
"children": [
{
@ -102,7 +102,7 @@
"tags": [],
"label": "'color-contrast'",
"description": [],
"path": "packages/kbn-axe-config/src/index.ts",
"path": "packages/kbn-axe-config/index.ts",
"deprecated": false,
"children": [
{
@ -112,7 +112,7 @@
"tags": [],
"label": "enabled",
"description": [],
"path": "packages/kbn-axe-config/src/index.ts",
"path": "packages/kbn-axe-config/index.ts",
"deprecated": false
}
]
@ -124,7 +124,7 @@
"tags": [],
"label": "bypass",
"description": [],
"path": "packages/kbn-axe-config/src/index.ts",
"path": "packages/kbn-axe-config/index.ts",
"deprecated": false,
"children": [
{
@ -134,7 +134,7 @@
"tags": [],
"label": "enabled",
"description": [],
"path": "packages/kbn-axe-config/src/index.ts",
"path": "packages/kbn-axe-config/index.ts",
"deprecated": false
}
]

2
api_docs/kbn_axe_config.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config
title: "@kbn/axe-config"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/axe-config plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config']
---
import kbnAxeConfigObj from './kbn_axe_config.devdocs.json';

2
api_docs/kbn_chart_icons.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-chart-icons
title: "@kbn/chart-icons"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/chart-icons plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/chart-icons']
---
import kbnChartIconsObj from './kbn_chart_icons.devdocs.json';

2
api_docs/kbn_ci_stats_core.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core
title: "@kbn/ci-stats-core"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ci-stats-core plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core']
---
import kbnCiStatsCoreObj from './kbn_ci_stats_core.devdocs.json';

2
api_docs/kbn_ci_stats_performance_metrics.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-performance-metrics
title: "@kbn/ci-stats-performance-metrics"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ci-stats-performance-metrics plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-performance-metrics']
---
import kbnCiStatsPerformanceMetricsObj from './kbn_ci_stats_performance_metrics.devdocs.json';

2
api_docs/kbn_ci_stats_reporter.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter
title: "@kbn/ci-stats-reporter"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ci-stats-reporter plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter']
---
import kbnCiStatsReporterObj from './kbn_ci_stats_reporter.devdocs.json';

2
api_docs/kbn_cli_dev_mode.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode
title: "@kbn/cli-dev-mode"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/cli-dev-mode plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode']
---
import kbnCliDevModeObj from './kbn_cli_dev_mode.devdocs.json';

2
api_docs/kbn_coloring.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-coloring
title: "@kbn/coloring"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/coloring plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring']
---
import kbnColoringObj from './kbn_coloring.devdocs.json';

2
api_docs/kbn_config.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config
title: "@kbn/config"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/config plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config']
---
import kbnConfigObj from './kbn_config.devdocs.json';

2
api_docs/kbn_config_mocks.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config-mocks
title: "@kbn/config-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/config-mocks plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-mocks']
---
import kbnConfigMocksObj from './kbn_config_mocks.devdocs.json';

108
api_docs/kbn_config_schema.devdocs.json
View file

@ -2156,7 +2156,7 @@
},
"<string>; }"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"initialIsOpen": false
},
@ -2183,7 +2183,7 @@
"tags": [],
"label": "schema",
"description": [],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"children": [
{
@ -2205,7 +2205,7 @@
"text": "AnyType"
}
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -2220,7 +2220,7 @@
"TypeOptions",
"<any> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -2253,7 +2253,7 @@
},
"<T[]>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -2274,7 +2274,7 @@
},
"<T>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
},
{
@ -2288,7 +2288,7 @@
"ArrayOptions",
"<T> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -2313,7 +2313,7 @@
},
"<boolean>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -2328,7 +2328,7 @@
"TypeOptions",
"<boolean> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -2353,7 +2353,7 @@
},
"<Buffer>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -2368,7 +2368,7 @@
"TypeOptions",
"<Buffer> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -2401,7 +2401,7 @@
},
">"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -2416,7 +2416,7 @@
"ByteSizeOptions",
" | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -2471,7 +2471,7 @@
},
"<A, B, C>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -2486,7 +2486,7 @@
"Reference",
"<A>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
},
{
@ -2508,7 +2508,7 @@
"Reference",
"<A>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
},
{
@ -2528,7 +2528,7 @@
},
"<B>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
},
{
@ -2548,7 +2548,7 @@
},
"<C>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
},
{
@ -2562,7 +2562,7 @@
"TypeOptions",
"<B | C> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -2579,7 +2579,7 @@
"ContextReference",
"<T>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -2590,7 +2590,7 @@
"tags": [],
"label": "key",
"description": [],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -2615,7 +2615,7 @@
},
"<moment.Duration>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -2630,7 +2630,7 @@
"DurationOptions",
" | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -2655,7 +2655,7 @@
},
"<string>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -2670,7 +2670,7 @@
"IpOptions",
" | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -2693,7 +2693,7 @@
},
"<T>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -2707,7 +2707,7 @@
"signature": [
"T"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -2748,7 +2748,7 @@
},
"<Map<K, V>>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -2769,7 +2769,7 @@
},
"<K>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
},
{
@ -2789,7 +2789,7 @@
},
"<V>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
},
{
@ -2803,7 +2803,7 @@
"MapOfOptions",
"<K, V> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -2834,7 +2834,7 @@
},
"<V | undefined>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -2855,7 +2855,7 @@
},
"<V>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -2886,7 +2886,7 @@
},
"<V | null>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -2907,7 +2907,7 @@
},
"<V>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -2930,7 +2930,7 @@
},
"<never>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": []
@ -2955,7 +2955,7 @@
},
"<number>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -2970,7 +2970,7 @@
"NumberOptions",
" | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -3003,7 +3003,7 @@
},
"<P>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -3017,7 +3017,7 @@
"signature": [
"P"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
},
{
@ -3031,7 +3031,7 @@
"ObjectTypeOptions",
"<P> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -3586,7 +3586,7 @@
},
"<A>; }"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
},
{
@ -3625,7 +3625,7 @@
},
"<Record<K, V>>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -3646,7 +3646,7 @@
},
"<K>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
},
{
@ -3666,7 +3666,7 @@
},
"<V>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
},
{
@ -3680,7 +3680,7 @@
"RecordOfOptions",
"<K, V> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -3709,7 +3709,7 @@
"Stream",
">"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -3726,7 +3726,7 @@
"Stream",
"> | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -3743,7 +3743,7 @@
"SiblingReference",
"<T>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -3754,7 +3754,7 @@
"tags": [],
"label": "key",
"description": [],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -3779,7 +3779,7 @@
},
"<string>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -3794,7 +3794,7 @@
"StringOptions",
" | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]
@ -3819,7 +3819,7 @@
},
"<string>"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -3834,7 +3834,7 @@
"URIOptions",
" | undefined"
],
"path": "packages/kbn-config-schema/src/index.ts",
"path": "packages/kbn-config-schema/index.ts",
"deprecated": false
}
]

2
api_docs/kbn_config_schema.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema
title: "@kbn/config-schema"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/config-schema plugin
date: 2022-08-30
date: 2022-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema']
---
import kbnConfigSchemaObj from './kbn_config_schema.devdocs.json';

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