[api-docs] 2024-06-06 Daily api_docs build (#184891)

Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/729
This commit is contained in:
Kibana Machine 2024-06-06 15:08:00 +10:00 committed by GitHub
parent df0a2dae17
commit f52adaf779
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
715 changed files with 2919 additions and 901 deletions

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
import actionsObj from './actions.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
---
import advancedSettingsObj from './advanced_settings.devdocs.json';

View file

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

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

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

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.devdocs.json';

View file

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

View file

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

View file

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

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

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

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

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
---
import casesObj from './cases.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
import chartsObj from './charts.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
---
import cloudObj from './cloud.devdocs.json';

View file

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

View file

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

View file

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

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
---
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
---
import consoleObj from './console.devdocs.json';

View file

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

View file

@ -196,7 +196,13 @@
" | undefined) => void; setControlStyle: (payload: ",
"ControlStyle",
") => void; setChainingSystem: (payload: ",
"ControlGroupChainingSystem",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.ControlGroupChainingSystem",
"text": "ControlGroupChainingSystem"
},
") => void; setDefaultControlWidth: (payload: ",
{
"pluginId": "controls",
@ -1432,6 +1438,38 @@
],
"returnComment": []
},
{
"parentPluginId": "controls",
"id": "def-public.ControlGroupContainer.removePanel",
"type": "Function",
"tags": [],
"label": "removePanel",
"description": [],
"signature": [
"(id: string) => void"
],
"path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "controls",
"id": "def-public.ControlGroupContainer.removePanel.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "controls",
"id": "def-public.ControlGroupContainer.onRemoveEmbeddable",
@ -2111,10 +2149,13 @@
"text": "ControlOutput"
},
", any> implements ",
"IClearableControl",
"<",
"ControlInput",
">"
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.CanClearSelections",
"text": "CanClearSelections"
}
],
"path": "src/plugins/controls/public/options_list/embeddable/options_list_embeddable.tsx",
"deprecated": false,
@ -2913,7 +2954,7 @@
{
"parentPluginId": "controls",
"id": "def-public.OptionsListEmbeddableFactory.presaveTransformFunction.$2",
"type": "CompoundType",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
@ -3296,10 +3337,13 @@
"text": "ControlOutput"
},
", any> implements ",
"IClearableControl",
"<",
"ControlInput",
">"
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.CanClearSelections",
"text": "CanClearSelections"
}
],
"path": "src/plugins/controls/public/range_slider/embeddable/range_slider_embeddable.tsx",
"deprecated": false,
@ -4206,7 +4250,7 @@
{
"parentPluginId": "controls",
"id": "def-public.RangeSliderEmbeddableFactory.presaveTransformFunction.$2",
"type": "CompoundType",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
@ -4574,6 +4618,36 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-public.CanClearSelections",
"type": "Interface",
"tags": [],
"label": "CanClearSelections",
"description": [],
"path": "src/plugins/controls/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "controls",
"id": "def-public.CanClearSelections.clearSelections",
"type": "Function",
"tags": [],
"label": "clearSelections",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/controls/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-public.ControlEditorProps",
@ -4687,6 +4761,104 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-public.ControlEmbeddable",
"type": "Interface",
"tags": [],
"label": "ControlEmbeddable",
"description": [],
"signature": [
{
"pluginId": "controls",
"scope": "public",
"docId": "kibControlsPluginApi",
"section": "def-public.ControlEmbeddable",
"text": "ControlEmbeddable"
},
"<TControlEmbeddableInput, TControlEmbeddableOutput> extends ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<TControlEmbeddableInput, TControlEmbeddableOutput, any>"
],
"path": "src/plugins/controls/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "controls",
"id": "def-public.ControlEmbeddable.isChained",
"type": "Function",
"tags": [],
"label": "isChained",
"description": [],
"signature": [
"(() => boolean) | undefined"
],
"path": "src/plugins/controls/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "controls",
"id": "def-public.ControlEmbeddable.renderPrepend",
"type": "Function",
"tags": [],
"label": "renderPrepend",
"description": [],
"signature": [
"(() => React.ReactNode) | undefined"
],
"path": "src/plugins/controls/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "controls",
"id": "def-public.ControlEmbeddable.selectionsToFilters",
"type": "Function",
"tags": [],
"label": "selectionsToFilters",
"description": [],
"signature": [
"((input: Partial<TControlEmbeddableInput>) => Promise<",
"ControlGroupFilterOutput",
">) | undefined"
],
"path": "src/plugins/controls/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "controls",
"id": "def-public.ControlEmbeddable.selectionsToFilters.$1",
"type": "Object",
"tags": [],
"label": "input",
"description": [],
"signature": [
"Partial<TControlEmbeddableInput>"
],
"path": "src/plugins/controls/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-public.ControlGroupInput",
@ -5245,7 +5417,7 @@
{
"parentPluginId": "controls",
"id": "def-public.IEditableControlFactory.presaveTransformFunction.$2",
"type": "CompoundType",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
@ -5787,24 +5959,15 @@
},
{
"parentPluginId": "controls",
"id": "def-public.ControlEmbeddable",
"type": "Type",
"id": "def-public.CONTROL_WIDTH_OPTIONS",
"type": "Array",
"tags": [],
"label": "ControlEmbeddable",
"label": "CONTROL_WIDTH_OPTIONS",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<TControlEmbeddableInput, TControlEmbeddableOutput, any> & { isChained?: (() => boolean) | undefined; renderPrepend?: (() => React.ReactNode) | undefined; selectionsToFilters?: ((input: Partial<TControlEmbeddableInput>) => Promise<",
"ControlGroupFilterOutput",
">) | undefined; }"
"{ id: string; 'data-test-subj': string; label: string; }[]"
],
"path": "src/plugins/controls/public/types.ts",
"path": "src/plugins/controls/public/control_group/editor/editor_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
@ -6624,7 +6787,13 @@
"; ignoreParentSettings?: ",
"ParentIgnoreSettings",
" | undefined; chainingSystem: ",
"ControlGroupChainingSystem",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.ControlGroupChainingSystem",
"text": "ControlGroupChainingSystem"
},
"; showApplySelections?: boolean | undefined; } | undefined"
],
"path": "src/plugins/controls/common/control_group/control_group_persistence.ts",
@ -7551,6 +7720,21 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-common.ControlGroupChainingSystem",
"type": "Type",
"tags": [],
"label": "ControlGroupChainingSystem",
"description": [],
"signature": [
"\"HIERARCHICAL\" | \"NONE\""
],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-common.ControlInputTransform",
@ -7667,6 +7851,18 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-common.DEFAULT_CONTROL_GROW",
"type": "boolean",
"tags": [],
"label": "DEFAULT_CONTROL_GROW",
"description": [],
"path": "src/plugins/controls/common/control_group/control_group_constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "controls",
"id": "def-common.DEFAULT_CONTROL_STYLE",
@ -7733,7 +7929,13 @@
"text": "ControlsPanels"
},
"; chainingSystem: ",
"ControlGroupChainingSystem",
{
"pluginId": "controls",
"scope": "common",
"docId": "kibControlsPluginApi",
"section": "def-common.ControlGroupChainingSystem",
"text": "ControlGroupChainingSystem"
},
"; showApplySelections?: boolean | undefined; }"
],
"path": "src/plugins/controls/common/control_group/types.ts",

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
---
import controlsObj from './controls.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 340 | 0 | 332 | 20 |
| 351 | 0 | 343 | 18 |
## Client

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
---
import customIntegrationsObj from './custom_integrations.devdocs.json';

View file

@ -212,23 +212,15 @@
"section": "def-common.PublishesTimeRange",
"text": "PublishesTimeRange"
},
" & { isCompatibleWithUnifiedSearch?: (() => boolean) | undefined; filters$: ",
" & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-common.PublishingSubject",
"text": "PublishingSubject"
"section": "def-common.PublishesFilters",
"text": "PublishesFilters"
},
"<",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined>; query$: ",
" & { isCompatibleWithUnifiedSearch?: (() => boolean) | undefined; query$: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
@ -306,23 +298,15 @@
"section": "def-common.PublishesTimeRange",
"text": "PublishesTimeRange"
},
" & { isCompatibleWithUnifiedSearch?: (() => boolean) | undefined; filters$: ",
" & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-common.PublishingSubject",
"text": "PublishingSubject"
"section": "def-common.PublishesFilters",
"text": "PublishesFilters"
},
"<",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined>; query$: ",
" & { isCompatibleWithUnifiedSearch?: (() => boolean) | undefined; query$: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
@ -858,23 +842,15 @@
"section": "def-common.PublishesTimeRange",
"text": "PublishesTimeRange"
},
" & { isCompatibleWithUnifiedSearch?: (() => boolean) | undefined; filters$: ",
" & ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-common.PublishingSubject",
"text": "PublishingSubject"
"section": "def-common.PublishesFilters",
"text": "PublishesFilters"
},
"<",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined>; query$: ",
" & { isCompatibleWithUnifiedSearch?: (() => boolean) | undefined; query$: ",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "common",

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

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

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
---
import dataObj from './data.devdocs.json';

View file

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

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

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
---
import dataSearchObj from './data_search.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
---
import dataViewEditorObj from './data_view_editor.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
---
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
---
import dataViewManagementObj from './data_view_management.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
---
import dataViewsObj from './data_views.devdocs.json';

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

View file

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

View file

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

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
---
import devToolsObj from './dev_tools.devdocs.json';

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

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
---
import discoverEnhancedObj from './discover_enhanced.devdocs.json';

View file

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

View file

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

View file

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

View file

@ -12900,7 +12900,7 @@
],
"signature": [
"(initialState: RuntimeState, buildApi: (apiRegistration: ",
"ReactEmbeddableApiRegistration",
"BuildReactEmbeddableApiRegistration",
"<SerializedState, Api>, comparators: ",
{
"pluginId": "@kbn/presentation-publishing",
@ -12909,7 +12909,9 @@
"section": "def-common.StateComparators",
"text": "StateComparators"
},
"<RuntimeState>) => Api, uuid: string, parentApi?: unknown) => Promise<{ Component: React.FC<{}>; api: Api; }>"
"<RuntimeState>) => Api, uuid: string, parentApi: unknown, setApi: (api: ",
"SetReactEmbeddableApiRegistration",
"<SerializedState, Api>) => Api) => Promise<{ Component: React.FC<{}>; api: Api; }>"
],
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
"deprecated": false,
@ -12939,7 +12941,7 @@
"description": [],
"signature": [
"(apiRegistration: ",
"ReactEmbeddableApiRegistration",
"BuildReactEmbeddableApiRegistration",
"<SerializedState, Api>, comparators: ",
{
"pluginId": "@kbn/presentation-publishing",
@ -12984,6 +12986,23 @@
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "embeddable",
"id": "def-public.ReactEmbeddableFactory.buildEmbeddable.$5",
"type": "Function",
"tags": [],
"label": "setApi",
"description": [],
"signature": [
"(api: ",
"SetReactEmbeddableApiRegistration",
"<SerializedState, Api>) => Api"
],
"path": "src/plugins/embeddable/public/react_embeddable_system/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
---
import embeddableObj from './embeddable.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 556 | 1 | 446 | 8 |
| 557 | 1 | 447 | 9 |
## Client

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
---
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';

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

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
---
import enterpriseSearchObj from './enterprise_search.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
---
import esUiSharedObj from './es_ui_shared.devdocs.json';

View file

@ -0,0 +1,61 @@
{
"id": "esqlDataGrid",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "esqlDataGrid",
"id": "def-public.ESQLDataGrid",
"type": "Function",
"tags": [],
"label": "ESQLDataGrid",
"description": [],
"signature": [
"(props: ESQLDataGridProps) => JSX.Element"
],
"path": "src/plugins/esql_datagrid/public/create_datagrid.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "esqlDataGrid",
"id": "def-public.ESQLDataGrid.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"ESQLDataGridProps"
],
"path": "src/plugins/esql_datagrid/public/create_datagrid.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

View file

@ -0,0 +1,30 @@
---
####
#### 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: kibEsqlDataGridPluginApi
slug: /kibana-dev-docs/api/esqlDataGrid
title: "esqlDataGrid"
image: https://source.unsplash.com/400x175/?github
description: API docs for the esqlDataGrid plugin
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esqlDataGrid']
---
import esqlDataGridObj from './esql_data_grid.devdocs.json';
Contact [@elastic/kibana-esql](https://github.com/orgs/elastic/teams/kibana-esql) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2 | 0 | 2 | 0 |
## Client
### Functions
<DocDefinitionList data={esqlDataGridObj.client.functions}/>

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
---
import eventAnnotationObj from './event_annotation.devdocs.json';

View file

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

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
---
import eventLogObj from './event_log.devdocs.json';

View file

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

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
---
import expressionErrorObj from './expression_error.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
---
import expressionGaugeObj from './expression_gauge.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
---
import expressionHeatmapObj from './expression_heatmap.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
---
import expressionImageObj from './expression_image.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
---
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
---
import expressionMetricObj from './expression_metric.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
---
import expressionMetricVisObj from './expression_metric_vis.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
---
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
---
import expressionRepeatImageObj from './expression_repeat_image.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
---
import expressionRevealImageObj from './expression_reveal_image.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
---
import expressionShapeObj from './expression_shape.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
---
import expressionTagcloudObj from './expression_tagcloud.devdocs.json';

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

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

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
---
import featuresObj from './features.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
---
import fieldFormatsObj from './field_formats.devdocs.json';

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,61 @@
---
####
#### 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: kibFieldsMetadataPluginApi
slug: /kibana-dev-docs/api/fieldsMetadata
title: "fieldsMetadata"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fieldsMetadata plugin
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldsMetadata']
---
import fieldsMetadataObj from './fields_metadata.devdocs.json';
Exposes services for async usage and search of fields metadata.
Contact [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux-logs-team) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 39 | 0 | 39 | 7 |
## Client
### Setup
<DocDefinitionList data={[fieldsMetadataObj.client.setup]}/>
### Start
<DocDefinitionList data={[fieldsMetadataObj.client.start]}/>
### Interfaces
<DocDefinitionList data={fieldsMetadataObj.client.interfaces}/>
## Server
### Setup
<DocDefinitionList data={[fieldsMetadataObj.server.setup]}/>
### Start
<DocDefinitionList data={[fieldsMetadataObj.server.start]}/>
### Consts, variables and types
<DocDefinitionList data={fieldsMetadataObj.server.misc}/>
## Common
### Objects
<DocDefinitionList data={fieldsMetadataObj.common.objects}/>
### Classes
<DocDefinitionList data={fieldsMetadataObj.common.classes}/>
### Interfaces
<DocDefinitionList data={fieldsMetadataObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={fieldsMetadataObj.common.misc}/>

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

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

View file

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

View file

@ -7480,6 +7480,26 @@
"path": "x-pack/plugins/fleet/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-server.FleetSetupDeps.fieldsMetadata",
"type": "Object",
"tags": [],
"label": "fieldsMetadata",
"description": [],
"signature": [
{
"pluginId": "fieldsMetadata",
"scope": "server",
"docId": "kibFieldsMetadataPluginApi",
"section": "def-server.FieldsMetadataServerSetup",
"text": "FieldsMetadataServerSetup"
}
],
"path": "x-pack/plugins/fleet/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -8326,7 +8346,7 @@
"label": "getPackage",
"description": [],
"signature": [
"(packageName: string, packageVersion: string) => Promise<{ packageInfo: ",
"(packageName: string, packageVersion: string, options?: { ignoreUnverified?: boolean | undefined; } | undefined) => Promise<{ paths: string[]; packageInfo: ",
{
"pluginId": "fleet",
"scope": "common",
@ -8334,7 +8354,11 @@
"section": "def-common.ArchivePackage",
"text": "ArchivePackage"
},
"; paths: string[]; }>"
"; assetsMap: ",
"AssetsMap",
"; verificationResult?: ",
"PackageVerificationResult",
" | undefined; }>"
],
"path": "x-pack/plugins/fleet/server/services/epm/package_service.ts",
"deprecated": false,
@ -8369,6 +8393,76 @@
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fleet",
"id": "def-server.PackageClient.getPackage.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ ignoreUnverified?: boolean | undefined; } | undefined"
],
"path": "x-pack/plugins/fleet/server/services/epm/package_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-server.PackageClient.getPackageFieldsMetadata",
"type": "Function",
"tags": [],
"label": "getPackageFieldsMetadata",
"description": [],
"signature": [
"(params: { packageName: string; datasetName?: string | undefined; }, options?: { excludedFieldsAssets?: string[] | undefined; } | undefined) => Promise<",
{
"pluginId": "fieldsMetadata",
"scope": "server",
"docId": "kibFieldsMetadataPluginApi",
"section": "def-server.ExtractedIntegrationFields",
"text": "ExtractedIntegrationFields"
},
">"
],
"path": "x-pack/plugins/fleet/server/services/epm/package_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-server.PackageClient.getPackageFieldsMetadata.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ packageName: string; datasetName?: string | undefined; }"
],
"path": "x-pack/plugins/fleet/server/services/epm/package_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fleet",
"id": "def-server.PackageClient.getPackageFieldsMetadata.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ excludedFieldsAssets?: string[] | undefined; } | undefined"
],
"path": "x-pack/plugins/fleet/server/services/epm/package_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
@ -19453,6 +19547,20 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.AgentPolicy.space_id",
"type": "string",
"tags": [],
"label": "space_id",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.AgentPolicy.status",
@ -21158,6 +21266,20 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.FullAgentPolicy.namespaces",
"type": "Array",
"tags": [],
"label": "namespaces",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.FullAgentPolicy.outputs",
@ -26400,21 +26522,6 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.FLEET_SERVER_SERVERS_INDEX",
"type": "string",
"tags": [],
"label": "FLEET_SERVER_SERVERS_INDEX",
"description": [],
"signature": [
"\".fleet-servers\""
],
"path": "x-pack/plugins/fleet/common/constants/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.FLEET_SYNTHETICS_PACKAGE",

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
---
import fleetObj from './fleet.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) for questi
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 1329 | 5 | 1208 | 69 |
| 1335 | 5 | 1214 | 71 |
## Client

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
---
import globalSearchObj from './global_search.devdocs.json';

View file

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

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

View file

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

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
---
import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
---
import indexManagementObj from './index_management.devdocs.json';

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

View file

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

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

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
---
import interactiveSetupObj from './interactive_setup.devdocs.json';

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace']
---
import kbnAceObj from './kbn_ace.devdocs.json';

View file

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

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: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components']
---
import kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-log-pattern-analysis
title: "@kbn/aiops-log-pattern-analysis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/aiops-log-pattern-analysis plugin
date: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-log-pattern-analysis']
---
import kbnAiopsLogPatternAnalysisObj from './kbn_aiops_log_pattern_analysis.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-log-rate-analysis
title: "@kbn/aiops-log-rate-analysis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/aiops-log-rate-analysis plugin
date: 2024-06-05
date: 2024-06-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-log-rate-analysis']
---
import kbnAiopsLogRateAnalysisObj from './kbn_aiops_log_rate_analysis.devdocs.json';

View file

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

View file

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

View file

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

View file

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

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