mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
[api-docs] 2024-06-05 Daily api_docs build (#184793)
Generated by https://buildkite.com/elastic/kibana-api-docs-daily/builds/728
This commit is contained in:
parent
ce47a73e84
commit
0ecc3d4228
701 changed files with 1349 additions and 755 deletions
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
|
||||
---
|
||||
import actionsObj from './actions.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
|
||||
---
|
||||
import advancedSettingsObj from './advanced_settings.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection']
|
||||
---
|
||||
import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
|
||||
---
|
||||
import aiopsObj from './aiops.devdocs.json';
|
||||
|
|
|
@ -6584,7 +6584,7 @@
|
|||
"tags": [],
|
||||
"label": "ActionVariable",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
|
@ -6595,7 +6595,7 @@
|
|||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
@ -6606,7 +6606,7 @@
|
|||
"tags": [],
|
||||
"label": "description",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
@ -6620,7 +6620,7 @@
|
|||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
@ -6634,7 +6634,7 @@
|
|||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
@ -6648,7 +6648,7 @@
|
|||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
|
||||
---
|
||||
import alertingObj from './alerting.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
|
||||
---
|
||||
import apmObj from './apm.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
|
||||
---
|
||||
import apmDataAccessObj from './apm_data_access.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager']
|
||||
---
|
||||
import assetManagerObj from './asset_manager.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetsDataAccess']
|
||||
---
|
||||
import assetsDataAccessObj from './assets_data_access.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
|
||||
---
|
||||
import bannersObj from './banners.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
|
||||
---
|
||||
import bfetchObj from './bfetch.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
|
||||
---
|
||||
import canvasObj from './canvas.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
|
||||
---
|
||||
import casesObj from './cases.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
|
||||
---
|
||||
import chartsObj from './charts.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
|
||||
---
|
||||
import cloudObj from './cloud.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
|
||||
---
|
||||
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
|
||||
---
|
||||
import cloudDefendObj from './cloud_defend.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments']
|
||||
---
|
||||
import cloudExperimentsObj from './cloud_experiments.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
|
||||
---
|
||||
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
|
||||
---
|
||||
import consoleObj from './console.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
|
||||
---
|
||||
import contentManagementObj from './content_management.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
|
||||
---
|
||||
import controlsObj from './controls.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
|
||||
---
|
||||
import customIntegrationsObj from './custom_integrations.devdocs.json';
|
||||
|
|
|
@ -1691,6 +1691,77 @@
|
|||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-common.prefixReferencesFromPanel",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "prefixReferencesFromPanel",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(id: string, references: ",
|
||||
{
|
||||
"pluginId": "@kbn/content-management-utils",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnContentManagementUtilsPluginApi",
|
||||
"section": "def-common.Reference",
|
||||
"text": "Reference"
|
||||
},
|
||||
"[]) => ",
|
||||
{
|
||||
"pluginId": "@kbn/content-management-utils",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnContentManagementUtilsPluginApi",
|
||||
"section": "def-common.Reference",
|
||||
"text": "Reference"
|
||||
},
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/dashboard/common/dashboard_container/persistable_state/dashboard_container_references.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-common.prefixReferencesFromPanel.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/dashboard/common/dashboard_container/persistable_state/dashboard_container_references.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-common.prefixReferencesFromPanel.$2",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "references",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/content-management-utils",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnContentManagementUtilsPluginApi",
|
||||
"section": "def-common.Reference",
|
||||
"text": "Reference"
|
||||
},
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/dashboard/common/dashboard_container/persistable_state/dashboard_container_references.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [
|
||||
|
@ -2254,6 +2325,29 @@
|
|||
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-common.DashboardPanelState.references",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "references",
|
||||
"description": [
|
||||
"\nReact embeddables are serialized and may pass references that are later used in factory's deserialize method."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/content-management-utils",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnContentManagementUtilsPluginApi",
|
||||
"section": "def-common.Reference",
|
||||
"text": "Reference"
|
||||
},
|
||||
"[] | undefined"
|
||||
],
|
||||
"path": "src/plugins/dashboard/common/dashboard_container/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
|
||||
---
|
||||
import dashboardObj from './dashboard.devdocs.json';
|
||||
|
@ -21,7 +21,7 @@ Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kib
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 116 | 0 | 113 | 13 |
|
||||
| 120 | 0 | 116 | 13 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
|
||||
---
|
||||
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
|
||||
---
|
||||
import dataObj from './data.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataQuality']
|
||||
---
|
||||
import dataQualityObj from './data_quality.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
|
||||
---
|
||||
import dataQueryObj from './data_query.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
|
||||
---
|
||||
import dataSearchObj from './data_search.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
|
||||
---
|
||||
import dataViewEditorObj from './data_view_editor.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
|
||||
---
|
||||
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
|
||||
---
|
||||
import dataViewManagementObj from './data_view_management.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
|
||||
---
|
||||
import dataViewsObj from './data_views.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
|
||||
---
|
||||
import dataVisualizerObj from './data_visualizer.devdocs.json';
|
||||
|
|
|
@ -201,7 +201,7 @@
|
|||
"Type",
|
||||
"<number, string, unknown>; }>; }> | undefined; handler: ({}: ",
|
||||
"DatasetQualityRouteHandlerResources",
|
||||
" & { params: { path: { dataStream: string; }; query: { start: number; end: number; }; }; }) => Promise<{ degradedFields: { name: string; count: number; lastOccurrence: number | null; }[]; }>; } & ",
|
||||
" & { params: { path: { dataStream: string; }; query: { start: number; end: number; }; }; }) => Promise<{ degradedFields: { name: string; count: number; lastOccurrence: number | null; timeSeries: { x: number; y: number; }[]; }[]; }>; } & ",
|
||||
"DatasetQualityRouteCreateOptions",
|
||||
"; \"GET /internal/dataset_quality/data_streams/non_aggregatable\": { endpoint: \"GET /internal/dataset_quality/data_streams/non_aggregatable\"; params?: ",
|
||||
"TypeC",
|
||||
|
@ -356,7 +356,7 @@
|
|||
"Type",
|
||||
"<number, string, unknown>; }>; }> | undefined; handler: ({}: ",
|
||||
"DatasetQualityRouteHandlerResources",
|
||||
" & { params: { path: { dataStream: string; }; query: { start: number; end: number; }; }; }) => Promise<{ degradedFields: { name: string; count: number; lastOccurrence: number | null; }[]; }>; } & ",
|
||||
" & { params: { path: { dataStream: string; }; query: { start: number; end: number; }; }; }) => Promise<{ degradedFields: { name: string; count: number; lastOccurrence: number | null; timeSeries: { x: number; y: number; }[]; }[]; }>; } & ",
|
||||
"DatasetQualityRouteCreateOptions",
|
||||
"; \"GET /internal/dataset_quality/data_streams/non_aggregatable\": { endpoint: \"GET /internal/dataset_quality/data_streams/non_aggregatable\"; params?: ",
|
||||
"TypeC",
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality']
|
||||
---
|
||||
import datasetQualityObj from './dataset_quality.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
@ -105,6 +105,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| <DocLink id="kibSavedObjectsFinderPluginApi" section="def-public.SavedObjectMetaData.includeFields" text="includeFields"/> | visualizations, graph | - |
|
||||
| <DocLink id="kibTimelinesPluginApi" section="def-public.TimelinesUIStart.getHoverActions" text="getHoverActions"/> | kubernetesSecurity, osquery, threatIntelligence | - |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsBrowserMocksPluginApi" section="def-common.simpleSavedObjectMock" text="simpleSavedObjectMock"/> | @kbn/core, lens, savedObjects | - |
|
||||
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddablePanel" text="EmbeddablePanel"/> | lens, dashboard, canvas | - |
|
||||
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableStart.getEmbeddableFactory" text="getEmbeddableFactory"/> | lens, controls, dashboard, observabilityShared | - |
|
||||
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableStart.getEmbeddableFactories" text="getEmbeddableFactories"/> | dashboard, canvas | - |
|
||||
| <DocLink id="kibKbnPresentationPublishingPluginApi" section="def-common.apiHasLegacyLibraryTransforms" text="apiHasLegacyLibraryTransforms"/> | dashboard | - |
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
@ -510,6 +510,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.component.tsx#:~:text=title), [es_data_view_select.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.tsx#:~:text=title), [es_data_view_select.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/es_data_view_select/es_data_view_select.tsx#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [data_views.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/data_views.ts#:~:text=title), [datasource_component.js](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/components/datasource/datasource_component.js#:~:text=title) | - |
|
||||
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddablePanel" text="EmbeddablePanel"/> | [embeddable.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/renderers/embeddable/embeddable.tsx#:~:text=EmbeddablePanel), [embeddable.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/renderers/embeddable/embeddable.tsx#:~:text=EmbeddablePanel) | - |
|
||||
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableStart.getEmbeddableFactories" text="getEmbeddableFactories"/> | [embeddable.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/renderers/embeddable/embeddable.tsx#:~:text=getEmbeddableFactories), [embeddables.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/services/kibana/embeddables.ts#:~:text=getEmbeddableFactories) | - |
|
||||
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionFunctionDefinition.context" text="context"/> | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context) | - |
|
||||
| <DocLink id="kibExpressionsPluginApi" section="def-public.ExpressionsServiceSetup.getFunction" text="getFunction"/> | [setup_expressions.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getFunction) | - |
|
||||
|
@ -592,6 +593,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/data/types.ts#:~:text=fieldFormats), [data_service.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/data/data_service.ts#:~:text=fieldFormats) | - |
|
||||
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddablePanel" text="EmbeddablePanel"/> | [dashboard_grid_item.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/component/grid/dashboard_grid_item.tsx#:~:text=EmbeddablePanel), [dashboard_grid_item.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/component/grid/dashboard_grid_item.tsx#:~:text=EmbeddablePanel) | - |
|
||||
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableSetup.registerEmbeddableFactory" text="registerEmbeddableFactory"/> | [plugin.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/plugin.tsx#:~:text=registerEmbeddableFactory) | - |
|
||||
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableStart.getEmbeddableFactory" text="getEmbeddableFactory"/> | [migrate_dashboard_input.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/dashboard_content_management/lib/migrate_dashboard_input.ts#:~:text=getEmbeddableFactory), [migrate_dashboard_input.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/dashboard_content_management/lib/migrate_dashboard_input.ts#:~:text=getEmbeddableFactory), [create_dashboard.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/create/create_dashboard.ts#:~:text=getEmbeddableFactory), [dashboard_container.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx#:~:text=getEmbeddableFactory), [dashboard_container.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/dashboard_container.tsx#:~:text=getEmbeddableFactory), [dashboard_renderer.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/external_api/dashboard_renderer.tsx#:~:text=getEmbeddableFactory), [embeddable.stub.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/embeddable/embeddable.stub.ts#:~:text=getEmbeddableFactory), [duplicate_dashboard_panel.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/api/duplicate_dashboard_panel.test.ts#:~:text=getEmbeddableFactory), [create_dashboard.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/create/create_dashboard.test.ts#:~:text=getEmbeddableFactory), [create_dashboard.test.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/create/create_dashboard.test.ts#:~:text=getEmbeddableFactory)+ 10 more | - |
|
||||
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableStart.getEmbeddableFactories" text="getEmbeddableFactories"/> | [editor_menu.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_app/top_nav/editor_menu.tsx#:~:text=getEmbeddableFactories), [embeddable.stub.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/embeddable/embeddable.stub.ts#:~:text=getEmbeddableFactories), [embeddable.stub.ts](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/services/embeddable/embeddable.stub.ts#:~:text=getEmbeddableFactories) | - |
|
||||
|
@ -930,6 +932,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
|||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibDataViewsPluginApi" section="def-common.AbstractDataView.title" text="title"/> | [loader.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/data_views_service/loader.ts#:~:text=title), [lens_top_nav.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/app_plugin/lens_top_nav.tsx#:~:text=title) | - |
|
||||
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddablePanel" text="EmbeddablePanel"/> | [embeddable_component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/embeddable/embeddable_component.tsx#:~:text=EmbeddablePanel), [embeddable_component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/embeddable/embeddable_component.tsx#:~:text=EmbeddablePanel) | - |
|
||||
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableSetup.registerSavedObjectToPanelMethod" text="registerSavedObjectToPanelMethod"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/plugin.ts#:~:text=registerSavedObjectToPanelMethod) | - |
|
||||
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableSetup.registerEmbeddableFactory" text="registerEmbeddableFactory"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/plugin.ts#:~:text=registerEmbeddableFactory) | - |
|
||||
| <DocLink id="kibEmbeddablePluginApi" section="def-public.EmbeddableStart.getEmbeddableFactory" text="getEmbeddableFactory"/> | [embeddable_component.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/lens/public/embeddable/embeddable_component.tsx#:~:text=getEmbeddableFactory) | - |
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
|
||||
---
|
||||
import devToolsObj from './dev_tools.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
|
||||
---
|
||||
import discoverObj from './discover.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
|
||||
---
|
||||
import discoverEnhancedObj from './discover_enhanced.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverShared']
|
||||
---
|
||||
import discoverSharedObj from './discover_shared.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
|
||||
---
|
||||
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistant']
|
||||
---
|
||||
import elasticAssistantObj from './elastic_assistant.devdocs.json';
|
||||
|
|
|
@ -629,6 +629,22 @@
|
|||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.Container.getPanelCount",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getPanelCount",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => number"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/lib/containers/container.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.Container.removePanel",
|
||||
|
@ -7937,19 +7953,45 @@
|
|||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddablePanel",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "EmbeddablePanel",
|
||||
"description": [
|
||||
"\nLoads and renders a legacy embeddable.\n\nAncestry chain must use 'key' attribute to reset DOM and state when embeddable changes\nFor example <Parent key={embeddableId}><EmbeddablePanel/></Parent>"
|
||||
"tags": [
|
||||
"deprecated"
|
||||
],
|
||||
"label": "EmbeddablePanel",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(props: ",
|
||||
"EmbeddablePanelProps",
|
||||
") => JSX.Element"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/embeddable_panel/embeddable_panel.tsx",
|
||||
"deprecated": false,
|
||||
"deprecated": true,
|
||||
"trackAdoption": false,
|
||||
"references": [
|
||||
{
|
||||
"plugin": "lens",
|
||||
"path": "x-pack/plugins/lens/public/embeddable/embeddable_component.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "lens",
|
||||
"path": "x-pack/plugins/lens/public/embeddable/embeddable_component.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "dashboard",
|
||||
"path": "src/plugins/dashboard/public/dashboard_container/component/grid/dashboard_grid_item.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "dashboard",
|
||||
"path": "src/plugins/dashboard/public/dashboard_container/component/grid/dashboard_grid_item.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "canvas",
|
||||
"path": "x-pack/plugins/canvas/canvas_plugin_src/renderers/embeddable/embeddable.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "canvas",
|
||||
"path": "x-pack/plugins/canvas/canvas_plugin_src/renderers/embeddable/embeddable.tsx"
|
||||
}
|
||||
],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
|
@ -10749,6 +10791,29 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddablePackageState.references",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "references",
|
||||
"description": [
|
||||
"\nCopy dashboard panel transfers serialized panel state for React embeddables.\nThe rawState will be passed into the input and references are passed separately\nso the container can update its references array and the updated references\nare correctly passed to the factory's deserialize method.\n\nLegacy embeddables have already injected the references\ninto the input state, so they will not pass references."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/content-management-utils",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnContentManagementUtilsPluginApi",
|
||||
"section": "def-common.Reference",
|
||||
"text": "Reference"
|
||||
},
|
||||
"[] | undefined"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/lib/state_transfer/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.EmbeddablePackageState.searchSessionId",
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
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 |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 554 | 1 | 444 | 8 |
|
||||
| 556 | 1 | 446 | 8 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
|
||||
---
|
||||
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
|
||||
---
|
||||
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
|
||||
---
|
||||
import enterpriseSearchObj from './enterprise_search.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
|
||||
---
|
||||
import esUiSharedObj from './es_ui_shared.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
|
||||
---
|
||||
import eventAnnotationObj from './event_annotation.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotationListing']
|
||||
---
|
||||
import eventAnnotationListingObj from './event_annotation_listing.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
|
||||
---
|
||||
import eventLogObj from './event_log.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
|
||||
---
|
||||
import exploratoryViewObj from './exploratory_view.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
|
||||
---
|
||||
import expressionErrorObj from './expression_error.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
|
||||
---
|
||||
import expressionGaugeObj from './expression_gauge.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
|
||||
---
|
||||
import expressionHeatmapObj from './expression_heatmap.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
|
||||
---
|
||||
import expressionImageObj from './expression_image.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
|
||||
---
|
||||
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
|
||||
---
|
||||
import expressionMetricObj from './expression_metric.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
|
||||
---
|
||||
import expressionMetricVisObj from './expression_metric_vis.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
|
||||
---
|
||||
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
|
||||
---
|
||||
import expressionRepeatImageObj from './expression_repeat_image.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
|
||||
---
|
||||
import expressionRevealImageObj from './expression_reveal_image.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
|
||||
---
|
||||
import expressionShapeObj from './expression_shape.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
|
||||
---
|
||||
import expressionTagcloudObj from './expression_tagcloud.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
|
||||
---
|
||||
import expressionXYObj from './expression_x_y.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
|
||||
---
|
||||
import expressionsObj from './expressions.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
|
||||
---
|
||||
import featuresObj from './features.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
|
||||
---
|
||||
import fieldFormatsObj from './field_formats.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
|
||||
---
|
||||
import fileUploadObj from './file_upload.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
|
||||
---
|
||||
import filesObj from './files.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
|
||||
---
|
||||
import filesManagementObj from './files_management.devdocs.json';
|
||||
|
|
|
@ -8453,6 +8453,91 @@
|
|||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-server.PackageClient.getAgentPolicyInputs",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getAgentPolicyInputs",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(pkgName: string, pkgVersion?: string | undefined, prerelease?: false | undefined, ignoreUnverified?: boolean | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.TemplateAgentPolicyInput",
|
||||
"text": "TemplateAgentPolicyInput"
|
||||
},
|
||||
"[]>"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/server/services/epm/package_service.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-server.PackageClient.getAgentPolicyInputs.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "pkgName",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/server/services/epm/package_service.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-server.PackageClient.getAgentPolicyInputs.$2",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "pkgVersion",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/server/services/epm/package_service.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-server.PackageClient.getAgentPolicyInputs.$3",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "prerelease",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"false | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/server/services/epm/package_service.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-server.PackageClient.getAgentPolicyInputs.$4",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "ignoreUnverified",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | 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.reinstallEsAssets",
|
||||
|
@ -27278,6 +27363,29 @@
|
|||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.TemplateAgentPolicyInput",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "TemplateAgentPolicyInput",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ id: string; type: string; streams?: ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.FullAgentPolicyInputStream",
|
||||
"text": "FullAgentPolicyInputStream"
|
||||
},
|
||||
"[] | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.UNINSTALL_TOKENS_SAVED_OBJECT_TYPE",
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
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 |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 1323 | 5 | 1202 | 69 |
|
||||
| 1329 | 5 | 1208 | 69 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
|
||||
---
|
||||
import globalSearchObj from './global_search.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
|
||||
---
|
||||
import guidedOnboardingObj from './guided_onboarding.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
|
||||
---
|
||||
import homeObj from './home.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
|
||||
---
|
||||
import imageEmbeddableObj from './image_embeddable.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
|
||||
---
|
||||
import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
|
||||
---
|
||||
import indexManagementObj from './index_management.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
|
||||
---
|
||||
import infraObj from './infra.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ingestPipelines']
|
||||
---
|
||||
import ingestPipelinesObj from './ingest_pipelines.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
|
||||
---
|
||||
import inspectorObj from './inspector.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
|
||||
---
|
||||
import interactiveSetupObj from './interactive_setup.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace']
|
||||
---
|
||||
import kbnAceObj from './kbn_ace.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/actions-types']
|
||||
---
|
||||
import kbnActionsTypesObj from './kbn_actions_types.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components']
|
||||
---
|
||||
import kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-log-pattern-analysis']
|
||||
---
|
||||
import kbnAiopsLogPatternAnalysisObj from './kbn_aiops_log_pattern_analysis.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-log-rate-analysis']
|
||||
---
|
||||
import kbnAiopsLogRateAnalysisObj from './kbn_aiops_log_rate_analysis.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-api-integration-helpers']
|
||||
---
|
||||
import kbnAlertingApiIntegrationHelpersObj from './kbn_alerting_api_integration_helpers.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-comparators']
|
||||
---
|
||||
import kbnAlertingComparatorsObj from './kbn_alerting_comparators.devdocs.json';
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-state-types']
|
||||
---
|
||||
import kbnAlertingStateTypesObj from './kbn_alerting_state_types.devdocs.json';
|
||||
|
|
|
@ -20,6 +20,197 @@
|
|||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "ActionContextVariables",
|
||||
"description": [
|
||||
"\nAll valid action context variables"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables.alertId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "alertId",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables.alertName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "alertName",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables.alertInstanceId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "alertInstanceId",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables.alertActionGroup",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "alertActionGroup",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables.alertActionGroupName",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "alertActionGroupName",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables.tags",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "tags",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string[] | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables.spaceId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "spaceId",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [x: string]: unknown; }"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables.context",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [x: string]: unknown; }"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables.date",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "date",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables.state",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [x: string]: unknown; }"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables.kibanaBaseUrl",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "kibanaBaseUrl",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables.rule",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "rule",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ id: string; name: string; spaceId: string; type: string; params: Record<string, unknown>; tags?: string[] | undefined; url?: string | undefined; }"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariables.alert",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "alert",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ id: string; uuid: string; actionGroup: string; actionGroupName: string; flapping: boolean; consecutiveMatches?: number | undefined; }"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionGroup",
|
||||
|
@ -76,7 +267,7 @@
|
|||
"tags": [],
|
||||
"label": "ActionVariable",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
|
@ -87,7 +278,7 @@
|
|||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
@ -98,7 +289,7 @@
|
|||
"tags": [],
|
||||
"label": "description",
|
||||
"description": [],
|
||||
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
@ -112,7 +303,7 @@
|
|||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
@ -126,7 +317,7 @@
|
|||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
|
@ -140,7 +331,7 @@
|
|||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/rule_type_types.ts",
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
|
@ -2314,6 +2505,23 @@
|
|||
}
|
||||
],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionContextVariablesFlatten",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "ActionContextVariablesFlatten",
|
||||
"description": [
|
||||
"\nThis type takes a deep nested object and returns all flattened keys as a union.\nThis is needed for the UI where the context variables are used as flattened keys.\nWe need to remove params and add it ourselves because FlattenKeys\nproduces `params.${string}` for the params which leads to a TS error\nin the UI when the key of the record is `params`"
|
||||
],
|
||||
"signature": [
|
||||
"\"params\" | \"spaceId\" | \"date\" | \"tags\" | \"alertId\" | \"alertInstanceId\" | \"rule.id\" | \"rule.name\" | \"alert.uuid\" | \"alert.flapping\" | \"rule.tags\" | \"rule.type\" | \"alertName\" | \"alertActionGroup\" | \"alertActionGroupName\" | \"kibanaBaseUrl\" | \"rule.spaceId\" | \"rule.url\" | `rule.params.${string}` | \"alert.id\" | \"alert.actionGroup\" | \"alert.actionGroupName\" | \"alert.consecutiveMatches\" | \"rule.params\""
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.ActionGroupIdsOf",
|
||||
|
@ -2662,6 +2870,45 @@
|
|||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.SummaryActionContextVariables",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "SummaryActionContextVariables",
|
||||
"description": [
|
||||
"\nAll valid summarized action context variables"
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/alerting-types",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnAlertingTypesPluginApi",
|
||||
"section": "def-common.ActionContextVariables",
|
||||
"text": "ActionContextVariables"
|
||||
},
|
||||
" & { alerts: { new: { count: number; data: unknown[]; }; ongoing: { count: number; data: unknown[]; }; recovered: { count: number; data: unknown[]; }; all: { count: number; data: unknown[]; }; }; }"
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/alerting-types",
|
||||
"id": "def-common.SummaryActionContextVariablesFlatten",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "SummaryActionContextVariablesFlatten",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"params\" | \"spaceId\" | \"date\" | \"tags\" | \"alertId\" | \"alertInstanceId\" | \"rule.id\" | \"rule.name\" | \"alert.uuid\" | \"alert.flapping\" | \"rule.tags\" | \"rule.type\" | \"alertName\" | \"alertActionGroup\" | \"alertActionGroupName\" | \"kibanaBaseUrl\" | \"rule.spaceId\" | \"rule.url\" | `rule.params.${string}` | \"alert.id\" | \"alert.actionGroup\" | \"alert.actionGroupName\" | \"alert.consecutiveMatches\" | \"rule.params\" | \"alerts.recovered.count\" | \"alerts.recovered.data\" | \"alerts.new.count\" | \"alerts.new.data\" | \"alerts.all.count\" | \"alerts.all.data\" | \"alerts.ongoing.count\" | \"alerts.ongoing.data\""
|
||||
],
|
||||
"path": "packages/kbn-alerting-types/action_variable.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": [
|
||||
|
|
|
@ -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-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-types']
|
||||
---
|
||||
import kbnAlertingTypesObj from './kbn_alerting_types.devdocs.json';
|
||||
|
@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 161 | 0 | 161 | 0 |
|
||||
| 179 | 0 | 176 | 0 |
|
||||
|
||||
## Common
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-as-data-utils
|
|||
title: "@kbn/alerts-as-data-utils"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/alerts-as-data-utils plugin
|
||||
date: 2024-06-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-as-data-utils']
|
||||
---
|
||||
import kbnAlertsAsDataUtilsObj from './kbn_alerts_as_data_utils.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-ui-shared
|
|||
title: "@kbn/alerts-ui-shared"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/alerts-ui-shared plugin
|
||||
date: 2024-06-04
|
||||
date: 2024-06-05
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-ui-shared']
|
||||
---
|
||||
import kbnAlertsUiSharedObj from './kbn_alerts_ui_shared.devdocs.json';
|
||||
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue