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 (#139158)

Browse source
This commit is contained in:
Kibana Machine 2022-08-19 00:41:51 -04:00 • committed by GitHub
parent 4c5043c779
commit 2b15e2a4f3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
386 changed files with 4592 additions and 4179 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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
---
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"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cases plugin
date: 2022-08-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
---
import casesObj from './cases.devdocs.json';

285
api_docs/charts.devdocs.json
View file

@ -280,279 +280,6 @@
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "charts",
"id": "def-public.getBrushFromChartBrushEventFn",
"type": "Function",
"tags": [],
"label": "getBrushFromChartBrushEventFn",
"description": [
"\nHelper function to transform `@elastic/charts` brush event into brush action event"
],
"signature": [
"(table: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
", xAccessor: ",
"Accessor",
"<D> | ",
"AccessorFn",
"<D, any>) => ({ x: selectedRange }: ",
"XYBrushEvent",
") => ",
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.BrushTriggerEvent",
"text": "BrushTriggerEvent"
}
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "charts",
"id": "def-public.getBrushFromChartBrushEventFn.$1",
"type": "Object",
"tags": [],
"label": "table",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
}
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "charts",
"id": "def-public.getBrushFromChartBrushEventFn.$2",
"type": "CompoundType",
"tags": [],
"label": "xAccessor",
"description": [],
"signature": [
"Accessor",
"<D> | ",
"AccessorFn",
"<D, any>"
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "charts",
"id": "def-public.getFilterFromChartClickEventFn",
"type": "Function",
"tags": [],
"label": "getFilterFromChartClickEventFn",
"description": [
"\nHelper function to transform `@elastic/charts` click event into filter action event\n"
],
"signature": [
"(table: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
", xAccessor: ",
"Accessor",
"<never> | ",
"AccessorFn",
"<any, any>, splitSeriesAccessorFnMap?: Map<string | number, ",
"AccessorFn",
"<any, any>> | undefined, splitChartAccessor?: ",
"Accessor",
"<never> | ",
"AccessorFn",
"<any, any> | undefined, negate?: boolean) => (points: [",
"GeometryValue",
", ",
"XYChartSeriesIdentifier",
"<any>][]) => ",
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ClickTriggerEvent",
"text": "ClickTriggerEvent"
}
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "charts",
"id": "def-public.getFilterFromChartClickEventFn.$1",
"type": "Object",
"tags": [],
"label": "table",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
}
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "charts",
"id": "def-public.getFilterFromChartClickEventFn.$2",
"type": "CompoundType",
"tags": [],
"label": "xAccessor",
"description": [],
"signature": [
"Accessor",
"<never> | ",
"AccessorFn",
"<any, any>"
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "charts",
"id": "def-public.getFilterFromChartClickEventFn.$3",
"type": "Object",
"tags": [],
"label": "splitSeriesAccessorFnMap",
"description": [
"needed when using `splitSeriesAccessors` as `AccessorFn`"
],
"signature": [
"Map<string | number, ",
"AccessorFn",
"<any, any>> | undefined"
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "charts",
"id": "def-public.getFilterFromChartClickEventFn.$4",
"type": "CompoundType",
"tags": [],
"label": "splitChartAccessor",
"description": [],
"signature": [
"Accessor",
"<never> | ",
"AccessorFn",
"<any, any> | undefined"
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"deprecated": false,
"isRequired": false
},
{
"parentPluginId": "charts",
"id": "def-public.getFilterFromChartClickEventFn.$5",
"type": "boolean",
"tags": [],
"label": "negate",
"description": [],
"signature": [
"boolean"
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "charts",
"id": "def-public.getFilterFromSeriesFn",
"type": "Function",
"tags": [],
"label": "getFilterFromSeriesFn",
"description": [
"\nHelper function to get filter action event from series"
],
"signature": [
"(table: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
") => ({ splitAccessors, ...rest }: ",
"XYChartSeriesIdentifier",
"<any>, splitSeriesAccessorFnMap?: Map<string | number, ",
"AccessorFn",
"<any, any>> | undefined, splitChartAccessor?: ",
"Accessor",
"<never> | ",
"AccessorFn",
"<any, any> | undefined, negate?: boolean) => ",
{
"pluginId": "charts",
"scope": "public",
"docId": "kibChartsPluginApi",
"section": "def-public.ClickTriggerEvent",
"text": "ClickTriggerEvent"
}
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "charts",
"id": "def-public.getFilterFromSeriesFn.$1",
"type": "Object",
"tags": [],
"label": "table",
"description": [],
"signature": [
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
}
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "charts",
"id": "def-public.getHeatmapColors",
@ -914,7 +641,7 @@
"tags": [],
"label": "BrushTriggerEvent",
"description": [],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"path": "src/plugins/charts/public/index.ts",
"deprecated": false,
"children": [
{
@ -927,7 +654,7 @@
"signature": [
"\"brush\""
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"path": "src/plugins/charts/public/index.ts",
"deprecated": false
},
{
@ -948,7 +675,7 @@
},
"; column: number; range: number[]; timeFieldName?: string | undefined; }"
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"path": "src/plugins/charts/public/index.ts",
"deprecated": false
}
],
@ -961,7 +688,7 @@
"tags": [],
"label": "ClickTriggerEvent",
"description": [],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"path": "src/plugins/charts/public/index.ts",
"deprecated": false,
"children": [
{
@ -974,7 +701,7 @@
"signature": [
"\"filter\""
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"path": "src/plugins/charts/public/index.ts",
"deprecated": false
},
{
@ -995,7 +722,7 @@
},
", \"rows\" | \"columns\">; column: number; row: number; value: any; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }"
],
"path": "src/plugins/charts/public/static/utils/transform_click_event.ts",
"path": "src/plugins/charts/public/index.ts",
"deprecated": false
}
],

4
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
import chartsObj from './charts.devdocs.json';
@ -21,7 +21,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 272 | 2 | 253 | 9 |
| 261 | 2 | 246 | 9 |
## Client

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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
---
import controlsObj from './controls.devdocs.json';

2
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core']
---
import coreObj from './core.devdocs.json';

2
api_docs/core_application.mdx
View file

@ -8,7 +8,7 @@ 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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application']
---
import coreApplicationObj from './core_application.devdocs.json';

2
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome']
---
import coreChromeObj from './core_chrome.devdocs.json';

2
api_docs/core_saved_objects.mdx
View file

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

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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
---
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';

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-18
date: 2022-08-19
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
---
import dataQueryObj from './data_query.devdocs.json';

2
api_docs/data_search.devdocs.json
View file

@ -28641,7 +28641,7 @@
"label": "GeoPoint",
"description": [],
"signature": [
"string | [number, number] | Point"
"string | Point | [number, number]"
],
"path": "src/plugins/data/common/search/expressions/geo_point.ts",
"deprecated": false,

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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
---
import dataVisualizerObj from './data_visualizer.devdocs.json';

10
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -49,16 +49,16 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibDiscoverPluginApi" section="def-public.DiscoverAppLocatorParams.indexPatternId" text="indexPatternId"/> | lens, observability, dataVisualizer, fleet, cloudSecurityPosture, discoverEnhanced, osquery, synthetics | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.RedirectAppLinks" text="RedirectAppLinks"/> | esUiShared, home, data, spaces, fleet, observability, ml, apm, indexLifecycleManagement, synthetics, upgradeAssistant, ux, savedObjectsManagement, kibanaOverview | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaPageTemplate" text="KibanaPageTemplate"/> | management, spaces, ml, canvas, enterpriseSearch, osquery, home | - |
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionFunctionDefinition.context" text="context"/> | canvas, visTypeXy | - |
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionFunctionDefinition.context" text="context"/> | canvas | - |
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionsServiceSetup.getFunction" text="getFunction"/> | canvas | - |
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionsServiceSetup.getFunctions" text="getFunctions"/> | canvas | - |
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionsServiceSetup.getTypes" text="getTypes"/> | canvas | - |
| <DocLink id="kibExpressionsPluginApi" section="def-common.Render" text="Render"/> | canvas, visTypeXy | - |
| <DocLink id="kibExpressionsPluginApi" section="def-common.ExpressionFunctionDefinition.context" text="context"/> | canvas, visTypeXy | - |
| <DocLink id="kibExpressionsPluginApi" section="def-common.Render" text="Render"/> | canvas | - |
| <DocLink id="kibExpressionsPluginApi" section="def-common.ExpressionFunctionDefinition.context" text="context"/> | canvas | - |
| <DocLink id="kibExpressionsPluginApi" section="def-common.ExpressionsServiceSetup.getFunction" text="getFunction"/> | canvas | - |
| <DocLink id="kibExpressionsPluginApi" section="def-common.ExpressionsServiceSetup.getFunctions" text="getFunctions"/> | canvas | - |
| <DocLink id="kibExpressionsPluginApi" section="def-common.ExpressionsServiceSetup.getTypes" text="getTypes"/> | canvas | - |
| <DocLink id="kibExpressionsPluginApi" section="def-server.ExpressionFunctionDefinition.context" text="context"/> | canvas, visTypeXy | - |
| <DocLink id="kibExpressionsPluginApi" section="def-server.ExpressionFunctionDefinition.context" text="context"/> | canvas | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaPageTemplateProps" text="KibanaPageTemplateProps"/> | management, enterpriseSearch | - |
| <DocLink id="kibSecurityPluginApi" section="def-public.SecurityPluginStart.uiApi" text="uiApi"/> | enterpriseSearch | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | actions, ml, savedObjectsTagging, enterpriseSearch | - |

13
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
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -676,17 +676,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
## visTypeXy
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionFunctionDefinition.context" text="context"/> | [xy_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/xy/public/expression_functions/xy_vis_fn.ts#:~:text=context) | - |
| <DocLink id="kibExpressionsPluginApi" section="def-common.Render" text="Render"/> | [xy_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/xy/public/expression_functions/xy_vis_fn.ts#:~:text=Render), [xy_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/xy/public/expression_functions/xy_vis_fn.ts#:~:text=Render) | - |
| <DocLink id="kibExpressionsPluginApi" section="def-common.ExpressionFunctionDefinition.context" text="context"/> | [xy_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/xy/public/expression_functions/xy_vis_fn.ts#:~:text=context) | - |
| <DocLink id="kibExpressionsPluginApi" section="def-server.ExpressionFunctionDefinition.context" text="context"/> | [xy_vis_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/xy/public/expression_functions/xy_vis_fn.ts#:~:text=context) | - |
## visualizations
| Deprecated API | Reference location(s) | Remove By |

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

45
api_docs/elastic_apm_synthtrace.mdx
View file

@ -1,45 +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: kibElasticApmSynthtracePluginApi
slug: /kibana-dev-docs/api/elastic-apm-synthtrace
title: "@elastic/apm-synthtrace"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @elastic/apm-synthtrace plugin
date: 2022-08-18
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/apm-synthtrace']
---
import elasticApmSynthtraceObj from './elastic_apm_synthtrace.devdocs.json';
Elastic APM trace data generator
Contact [Owner missing] for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 74 | 0 | 74 | 11 |
## Server
### Objects
<DocDefinitionList data={elasticApmSynthtraceObj.server.objects}/>
### Functions
<DocDefinitionList data={elasticApmSynthtraceObj.server.functions}/>
### Classes
<DocDefinitionList data={elasticApmSynthtraceObj.server.classes}/>
### Interfaces
<DocDefinitionList data={elasticApmSynthtraceObj.server.interfaces}/>
### Enums
<DocDefinitionList data={elasticApmSynthtraceObj.server.enums}/>
### Consts, variables and types
<DocDefinitionList data={elasticApmSynthtraceObj.server.misc}/>

32
api_docs/embeddable.devdocs.json
View file

@ -8422,6 +8422,38 @@
],
"returnComment": []
},
{
"parentPluginId": "embeddable",
"id": "def-public.IEmbeddable.updateOutput",
"type": "Function",
"tags": [],
"label": "updateOutput",
"description": [
"\nUpdates output state with the given changes."
],
"signature": [
"(changes: Partial<O>) => void"
],
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "embeddable",
"id": "def-public.IEmbeddable.updateOutput.$1",
"type": "Object",
"tags": [],
"label": "changes",
"description": [],
"signature": [
"Partial<O>"
],
"path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "embeddable",
"id": "def-public.IEmbeddable.getInput$",

4
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
---
import embeddableObj from './embeddable.devdocs.json';
@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 512 | 0 | 413 | 4 |
| 514 | 0 | 414 | 4 |
## Client

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-18
date: 2022-08-19
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
---
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';

28
api_docs/enterprise_search.devdocs.json
View file

@ -14,6 +14,34 @@
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "enterpriseSearch",
"id": "def-server.ANALYTICS_COLLECTIONS_INDEX",
"type": "string",
"tags": [],
"label": "ANALYTICS_COLLECTIONS_INDEX",
"description": [],
"signature": [
"\".elastic-analytics-collections\""
],
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "enterpriseSearch",
"id": "def-server.ANALYTICS_VERSION",
"type": "string",
"tags": [],
"label": "ANALYTICS_VERSION",
"description": [],
"signature": [
"\"1\""
],
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "enterpriseSearch",
"id": "def-server.ConfigType",

4
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
---
import enterpriseSearchObj from './enterprise_search.devdocs.json';
@ -21,7 +21,7 @@ Contact [Enterprise Search](https://github.com/orgs/elastic/teams/enterprise-sea
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 6 | 0 | 6 | 0 |
| 8 | 0 | 8 | 0 |
## Server

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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
---
import expressionXYObj from './expression_x_y.devdocs.json';

20
api_docs/expressions.devdocs.json
View file

@ -7966,10 +7966,6 @@
{
"plugin": "canvas",
"path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts"
},
{
"plugin": "visTypeXy",
"path": "src/plugins/vis_types/xy/public/expression_functions/xy_vis_fn.ts"
}
]
}
@ -18404,10 +18400,6 @@
{
"plugin": "canvas",
"path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts"
},
{
"plugin": "visTypeXy",
"path": "src/plugins/vis_types/xy/public/expression_functions/xy_vis_fn.ts"
}
]
}
@ -30224,10 +30216,6 @@
{
"plugin": "canvas",
"path": "x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts"
},
{
"plugin": "visTypeXy",
"path": "src/plugins/vis_types/xy/public/expression_functions/xy_vis_fn.ts"
}
]
}
@ -34915,14 +34903,6 @@
{
"plugin": "canvas",
"path": "x-pack/plugins/canvas/canvas_plugin_src/functions/common/table.ts"
},
{
"plugin": "visTypeXy",
"path": "src/plugins/vis_types/xy/public/expression_functions/xy_vis_fn.ts"
},
{
"plugin": "visTypeXy",
"path": "src/plugins/vis_types/xy/public/expression_functions/xy_vis_fn.ts"
}
],
"initialIsOpen": false

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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
---
import fileUploadObj from './file_upload.devdocs.json';

434
api_docs/files.devdocs.json
View file

@ -2218,22 +2218,12 @@
"children": [
{
"parentPluginId": "files",
"id": "def-server.DeleteForFileArgs.file",
"type": "Object",
"id": "def-server.DeleteForFileArgs.id",
"type": "string",
"tags": [],
"label": "file",
"label": "id",
"description": [
"\nThe file object to delete the shares for."
],
"signature": [
{
"pluginId": "files",
"scope": "common",
"docId": "kibFilesPluginApi",
"section": "def-common.File",
"text": "File"
},
"<unknown>"
"\nThe file id to delete the shares for."
],
"path": "x-pack/plugins/files/server/file_share_service/internal_file_share_service.ts",
"deprecated": false
@ -2250,7 +2240,7 @@
"description": [
"\nWraps the {@link FileMetadataClient} and {@link BlobStorageClient} client\nto provide basic file CRUD functionality.\n\nFor now this is just a shallow type of the implementation for export purposes."
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"children": [
{
@ -2262,7 +2252,7 @@
"description": [
"See {@link FileMetadata.FileKind}."
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false
},
{
@ -2275,19 +2265,19 @@
"\nSee {@link FileMetadataClient.create}.\n"
],
"signature": [
"(arg: ",
"<M = unknown>(arg: ",
"CreateArgs",
") => Promise<",
{
"pluginId": "files",
"scope": "server",
"scope": "common",
"docId": "kibFilesPluginApi",
"section": "def-server.FileDescriptor",
"text": "FileDescriptor"
"section": "def-common.File",
"text": "File"
},
"<unknown>>"
"<M>>"
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"children": [
{
@ -2302,7 +2292,7 @@
"signature": [
"CreateArgs"
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"isRequired": true
}
@ -2319,7 +2309,7 @@
"\nSee {@link FileMetadataClient.get}\n"
],
"signature": [
"(arg: ",
"<M = unknown>(arg: ",
{
"pluginId": "files",
"scope": "server",
@ -2330,16 +2320,15 @@
") => Promise<",
{
"pluginId": "files",
"scope": "server",
"scope": "common",
"docId": "kibFilesPluginApi",
"section": "def-server.FileDescriptor",
"text": "FileDescriptor"
"section": "def-common.File",
"text": "File"
},
"<unknown>>"
"<M>>"
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "files",
@ -2359,10 +2348,12 @@
"text": "GetArg"
}
],
"path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts",
"deprecated": false
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"isRequired": true
}
]
],
"returnComment": []
},
{
"parentPluginId": "files",
@ -2374,51 +2365,60 @@
"\n{@link FileMetadataClient.update}\n"
],
"signature": [
"(arg: ",
"<M = unknown>(id: string, metadata: ",
{
"pluginId": "files",
"scope": "server",
"scope": "common",
"docId": "kibFilesPluginApi",
"section": "def-server.UpdateArgs",
"text": "UpdateArgs"
"section": "def-common.UpdatableFileMetadata",
"text": "UpdatableFileMetadata"
},
"<unknown>) => Promise<",
{
"pluginId": "files",
"scope": "server",
"docId": "kibFilesPluginApi",
"section": "def-server.FileDescriptor",
"text": "FileDescriptor"
},
"<unknown>>"
"<M>) => Promise<void>"
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "files",
"id": "def-server.FileClient.update.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [
"- File id"
],
"signature": [
"string"
],
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "files",
"id": "def-server.FileClient.update.$2",
"type": "Object",
"tags": [],
"label": "arg",
"label": "metadata",
"description": [
"- Argument to get a file"
"- new file metadata"
],
"signature": [
{
"pluginId": "files",
"scope": "server",
"scope": "common",
"docId": "kibFilesPluginApi",
"section": "def-server.UpdateArgs",
"text": "UpdateArgs"
"section": "def-common.UpdatableFileMetadata",
"text": "UpdatableFileMetadata"
},
"<unknown>"
"<M>"
],
"path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts",
"deprecated": false
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"isRequired": true
}
]
],
"returnComment": []
},
{
"parentPluginId": "files",
@ -2440,7 +2440,7 @@
},
") => Promise<void>"
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"children": [
{
@ -2461,43 +2461,13 @@
"text": "DeleteArgs"
}
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "files",
"id": "def-server.FileClient.deleteContent",
"type": "Function",
"tags": [],
"label": "deleteContent",
"description": [
"\nSee {@link BlobStorageClient.delete}\n"
],
"signature": [
"(id: string) => Promise<void>"
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "files",
"id": "def-server.FileClient.deleteContent.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [
"- Argument to delete a file"
],
"path": "x-pack/plugins/files/server/blob_storage_service/types.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "files",
"id": "def-server.FileClient.list",
@ -2519,16 +2489,15 @@
" | undefined) => Promise<",
{
"pluginId": "files",
"scope": "server",
"scope": "common",
"docId": "kibFilesPluginApi",
"section": "def-server.FileDescriptor",
"text": "FileDescriptor"
"section": "def-common.File",
"text": "File"
},
"<unknown>[]>"
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "files",
@ -2549,10 +2518,12 @@
},
" | undefined"
],
"path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts",
"deprecated": false
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"isRequired": false
}
]
],
"returnComment": []
},
{
"parentPluginId": "files",
@ -2575,16 +2546,15 @@
") => Promise<",
{
"pluginId": "files",
"scope": "server",
"scope": "common",
"docId": "kibFilesPluginApi",
"section": "def-server.FileDescriptor",
"text": "FileDescriptor"
"section": "def-common.File",
"text": "File"
},
"<unknown>[]>"
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "files",
@ -2604,113 +2574,147 @@
"text": "FindFileArgs"
}
],
"path": "x-pack/plugins/files/server/file_client/file_metadata_client/file_metadata_client.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "files",
"id": "def-server.FileClient.upload",
"type": "Function",
"tags": [],
"label": "upload",
"description": [
"\nSee {@link BlobStorageClient.upload}\n"
],
"signature": [
"(id: string, rs: ",
"Readable",
", opts?: ",
"UploadOptions",
" | undefined) => Promise<{ id: string; size: number; }>"
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "files",
"id": "def-server.FileClient.upload.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [
"- Readable stream to upload"
],
"signature": [
"string"
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "files",
"id": "def-server.FileClient.upload.$2",
"type": "Object",
"tags": [],
"label": "rs",
"description": [
"- Readable stream to upload"
],
"signature": [
"Readable"
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "files",
"id": "def-server.FileClient.upload.$3",
"type": "Object",
"tags": [],
"label": "opts",
"description": [
"- Argument for uploads"
],
"signature": [
"UploadOptions",
" | undefined"
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "files",
"id": "def-server.FileClient.download",
"id": "def-server.FileClient.share",
"type": "Function",
"tags": [],
"label": "download",
"tags": [
"note"
],
"label": "share",
"description": [
"\nSee {@link BlobStorageClient.download}\n"
"\nCreate a file share instance for this file.\n"
],
"signature": [
"(args: { id: string; size?: number | undefined; }) => Promise<",
"Readable",
"(args: ",
"ShareArgs",
") => Promise<",
{
"pluginId": "files",
"scope": "common",
"docId": "kibFilesPluginApi",
"section": "def-common.FileShareJSONWithToken",
"text": "FileShareJSONWithToken"
},
">"
],
"path": "x-pack/plugins/files/server/file_client/file_client.ts",
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "files",
"id": "def-server.FileClient.share.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [
"- Arguments to create a file share"
],
"signature": [
"ShareArgs"
],
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "files",
"id": "def-server.FileClient.unshare",
"type": "Function",
"tags": [
"note"
],
"label": "unshare",
"description": [
"\nCreate a file share instance for this file.\n"
],
"signature": [
"(args: IdArg) => Promise<void>"
],
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "files",
"id": "def-server.FileClient.download.$1",
"id": "def-server.FileClient.unshare.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [
"- to download a file"
"- Arguments to remove a file share"
],
"signature": [
"{ id: string; size?: number | undefined; }"
"IdArg"
],
"path": "x-pack/plugins/files/server/blob_storage_service/types.ts",
"path": "x-pack/plugins/files/server/file_share_service/types.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "files",
"id": "def-server.FileClient.listShares",
"type": "Function",
"tags": [
"note"
],
"label": "listShares",
"description": [
"\nCreate a file share instance for this file.\n"
],
"signature": [
"(arg: ",
{
"pluginId": "files",
"scope": "server",
"docId": "kibFilesPluginApi",
"section": "def-server.ListArgs",
"text": "ListArgs"
},
") => Promise<{ shares: ",
{
"pluginId": "files",
"scope": "common",
"docId": "kibFilesPluginApi",
"section": "def-common.FileShareJSON",
"text": "FileShareJSON"
},
"[]; }>"
],
"path": "x-pack/plugins/files/server/file_client/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "files",
"id": "def-server.FileClient.listShares.$1",
"type": "Object",
"tags": [],
"label": "arg",
"description": [
"- Arguments to remove a file share"
],
"signature": [
{
"pluginId": "files",
"scope": "server",
"docId": "kibFilesPluginApi",
"section": "def-server.ListArgs",
"text": "ListArgs"
}
],
"path": "x-pack/plugins/files/server/file_share_service/types.ts",
"deprecated": false
}
]
@ -3352,7 +3356,7 @@
"\nUpdate updatable file attributes like name and meta.\n"
],
"signature": [
"<M>(args: ",
"(args: ",
{
"pluginId": "files",
"scope": "server",
@ -3360,15 +3364,7 @@
"section": "def-server.UpdateFileArgs",
"text": "UpdateFileArgs"
},
") => Promise<",
{
"pluginId": "files",
"scope": "common",
"docId": "kibFilesPluginApi",
"section": "def-common.File",
"text": "File"
},
"<M>>"
") => Promise<void>"
],
"path": "x-pack/plugins/files/server/file_service/file_service.ts",
"deprecated": false,
@ -4803,19 +4799,45 @@
"section": "def-common.File",
"text": "File"
},
"<Meta> extends ",
{
"pluginId": "files",
"scope": "common",
"docId": "kibFilesPluginApi",
"section": "def-common.FileJSON",
"text": "FileJSON"
},
"<Meta>"
],
"path": "x-pack/plugins/files/common/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "files",
"id": "def-common.File.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nThe file ID"
],
"path": "x-pack/plugins/files/common/types.ts",
"deprecated": false
},
{
"parentPluginId": "files",
"id": "def-common.File.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [
"\nFile metadata in camelCase form."
],
"signature": [
{
"pluginId": "files",
"scope": "common",
"docId": "kibFilesPluginApi",
"section": "def-common.FileJSON",
"text": "FileJSON"
},
"<Meta>"
],
"path": "x-pack/plugins/files/common/types.ts",
"deprecated": false
},
{
"parentPluginId": "files",
"id": "def-common.File.update",
@ -4886,7 +4908,15 @@
"signature": [
"(content: ",
"Readable",
") => Promise<void>"
") => Promise<",
{
"pluginId": "files",
"scope": "common",
"docId": "kibFilesPluginApi",
"section": "def-common.File",
"text": "File"
},
"<Meta>>"
],
"path": "x-pack/plugins/files/common/types.ts",
"deprecated": false,

4
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
---
import filesObj from './files.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-app-services](https://github.com/orgs/elastic/teams/tea
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 236 | 0 | 3 | 2 |
| 237 | 0 | 3 | 2 |
## Client

55
api_docs/fleet.devdocs.json
View file

@ -3933,7 +3933,7 @@
"signature": [
"(soClient: ",
"SavedObjectsClientContract",
", ids: string[], options?: { fields?: string[] | undefined; }) => Promise<",
", ids: string[], options?: { fields?: string[] | undefined; withPackagePolicies?: boolean | undefined; ignoreMissing?: boolean | undefined; }) => Promise<",
{
"pluginId": "fleet",
"scope": "common",
@ -3981,7 +3981,7 @@
"label": "options",
"description": [],
"signature": [
"{ fields?: string[] | undefined; }"
"{ fields?: string[] | undefined; withPackagePolicies?: boolean | undefined; ignoreMissing?: boolean | undefined; }"
],
"path": "x-pack/plugins/fleet/server/services/agent_policy.ts",
"deprecated": false
@ -5312,7 +5312,7 @@
"signature": [
"(soClient: ",
"SavedObjectsClientContract",
", ids: string[]) => Promise<",
", ids: string[], options?: { ignoreMissing?: boolean | undefined; } | undefined) => Promise<",
{
"pluginId": "fleet",
"scope": "common",
@ -5352,6 +5352,31 @@
"path": "x-pack/plugins/fleet/server/services/package_policy.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "fleet",
"id": "def-server.PackagePolicyServiceInterface.getByIDs.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/plugins/fleet/server/services/package_policy.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-server.PackagePolicyServiceInterface.getByIDs.$3.ignoreMissing",
"type": "CompoundType",
"tags": [],
"label": "ignoreMissing",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/fleet/server/services/package_policy.ts",
"deprecated": false
}
]
}
],
"returnComment": []
@ -9768,7 +9793,7 @@
"label": "install_source",
"description": [],
"signature": [
"\"upload\" | \"registry\" | \"bundled\""
"\"registry\" | \"upload\" | \"bundled\""
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false
@ -9918,7 +9943,7 @@
"label": "installSource",
"description": [],
"signature": [
"\"upload\" | \"registry\" | \"bundled\""
"\"registry\" | \"upload\" | \"bundled\""
],
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
"deprecated": false
@ -14292,6 +14317,16 @@
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"deprecated": false
},
{
"parentPluginId": "fleet",
"id": "def-common.AGENT_POLICY_API_ROUTES.BULK_GET_PATTERN",
"type": "string",
"tags": [],
"label": "BULK_GET_PATTERN",
"description": [],
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"deprecated": false
},
{
"parentPluginId": "fleet",
"id": "def-common.AGENT_POLICY_API_ROUTES.INFO_PATTERN",
@ -15641,6 +15676,16 @@
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"deprecated": false
},
{
"parentPluginId": "fleet",
"id": "def-common.PACKAGE_POLICY_API_ROUTES.BULK_GET_PATTERN",
"type": "string",
"tags": [],
"label": "BULK_GET_PATTERN",
"description": [],
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"deprecated": false
},
{
"parentPluginId": "fleet",
"id": "def-common.PACKAGE_POLICY_API_ROUTES.INFO_PATTERN",

4
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
---
import fleetObj from './fleet.devdocs.json';
@ -21,7 +21,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 957 | 3 | 862 | 9 |
| 961 | 3 | 866 | 9 |
## Client

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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts']
---
import kbnAlertsObj from './kbn_alerts.devdocs.json';

2
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics']
---
import kbnAnalyticsObj from './kbn_analytics.devdocs.json';

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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader']
---
import kbnApmConfigLoaderObj from './kbn_apm_config_loader.devdocs.json';

426
api_docs/elastic_apm_synthtrace.devdocs.json → api_docs/kbn_apm_synthtrace.devdocs.json
View file

File diff suppressed because it is too large Load diff

45
api_docs/kbn_apm_synthtrace.mdx Normal file
View file

@ -0,0 +1,45 @@
---
####
#### 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: kibKbnApmSynthtracePluginApi
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-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace']
---
import kbnApmSynthtraceObj from './kbn_apm_synthtrace.devdocs.json';
Elastic APM trace data generator
Contact [Owner missing] for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 74 | 0 | 74 | 11 |
## Server
### Objects
<DocDefinitionList data={kbnApmSynthtraceObj.server.objects}/>
### Functions
<DocDefinitionList data={kbnApmSynthtraceObj.server.functions}/>
### Classes
<DocDefinitionList data={kbnApmSynthtraceObj.server.classes}/>
### Interfaces
<DocDefinitionList data={kbnApmSynthtraceObj.server.interfaces}/>
### Enums
<DocDefinitionList data={kbnApmSynthtraceObj.server.enums}/>
### Consts, variables and types
<DocDefinitionList data={kbnApmSynthtraceObj.server.misc}/>

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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils']
---
import kbnApmUtilsObj from './kbn_apm_utils.devdocs.json';

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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config']
---
import kbnAxeConfigObj from './kbn_axe_config.devdocs.json';

2
api_docs/kbn_bazel_packages.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-packages
title: "@kbn/bazel-packages"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/bazel-packages plugin
date: 2022-08-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-packages']
---
import kbnBazelPackagesObj from './kbn_bazel_packages.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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
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-18
date: 2022-08-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-mocks']
---
import kbnConfigMocksObj from './kbn_config_mocks.devdocs.json';

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