github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source 
Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/605
This commit is contained in:
Kibana Machine 2024-02-06 01:35:31 -05:00 • committed by GitHub
parent 7e805a4086
commit cf6ef5c2ef
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
684 changed files with 3023 additions and 1622 deletions
Download patch file Download diff file Expand all files Collapse all files

2
api_docs/actions.mdx
View file

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

2
api_docs/advanced_settings.mdx
View file

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

2
api_docs/ai_assistant_management_observability.mdx
View file

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

2
api_docs/ai_assistant_management_selection.mdx
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-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection']
---
import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json';

2
api_docs/aiops.mdx
View file

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

22
api_docs/alerting.devdocs.json
View file

@ -4071,6 +4071,28 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.RuleType.schemas",
"type": "Object",
"tags": [],
"label": "schemas",
"description": [],
"signature": [
"{ params?: { type: \"zod\"; schema: Zod.ZodObject<Zod.ZodRawShape, Zod.UnknownKeysParam, Zod.ZodTypeAny, { [x: string]: any; }, { [x: string]: any; }> | Zod.ZodIntersection<Zod.ZodTypeAny, Zod.ZodTypeAny>; } | { type: \"config-schema\"; schema: ",
{
"pluginId": "@kbn/config-schema",
"scope": "common",
"docId": "kibKbnConfigSchemaPluginApi",
"section": "def-common.ObjectType",
"text": "ObjectType"
},
"<any>; } | undefined; } | undefined"
],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.RuleType.actionGroups",

4
api_docs/alerting.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting
title: "alerting"
image: https://source.unsplash.com/400x175/?github
description: API docs for the alerting plugin
date: 2024-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.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 |
|-------------------|-----------|------------------------|-----------------|
| 834 | 1 | 803 | 51 |
| 835 | 1 | 804 | 51 |
## Client

2
api_docs/apm.mdx
View file

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

2
api_docs/apm_data_access.mdx
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-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
---
import apmDataAccessObj from './apm_data_access.devdocs.json';

2
api_docs/asset_manager.mdx
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-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager']
---
import assetManagerObj from './asset_manager.devdocs.json';

2
api_docs/banners.mdx
View file

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

2
api_docs/bfetch.mdx
View file

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

2
api_docs/canvas.mdx
View file

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

2
api_docs/cases.mdx
View file

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

2
api_docs/charts.mdx
View file

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

2
api_docs/cloud.mdx
View file

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

2
api_docs/cloud_data_migration.mdx
View file

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

2
api_docs/cloud_defend.mdx
View file

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

2
api_docs/cloud_experiments.mdx
View file

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

2
api_docs/cloud_security_posture.mdx
View file

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

2
api_docs/console.mdx
View file

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

18
api_docs/content_management.devdocs.json
View file

@ -1283,7 +1283,7 @@
"section": "def-server.StorageContext",
"text": "StorageContext"
},
", id: string, options?: object | undefined) => Promise<{ item: T; } | { item: T; meta: any; }>"
", id: string, options?: object | undefined) => Promise<{ item: T; meta?: undefined; } | { item: T; meta: any; }>"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
@ -1361,7 +1361,7 @@
"section": "def-server.StorageContext",
"text": "StorageContext"
},
", ids: string[], options?: object | undefined) => Promise<{ hits: ({ item: T; } | { item: T; meta: any; })[]; }>"
", ids: string[], options?: object | undefined) => Promise<{ hits: ({ item: T; meta?: undefined; } | { item: T; meta: any; })[]; }>"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
@ -1439,7 +1439,7 @@
"section": "def-server.StorageContext",
"text": "StorageContext"
},
", data: object, options?: object | undefined) => Promise<{ item: T; } | { item: T; meta: any; }>"
", data: object, options?: object | undefined) => Promise<{ item: T; meta?: undefined; } | { item: T; meta: any; }>"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
@ -1517,7 +1517,7 @@
"section": "def-server.StorageContext",
"text": "StorageContext"
},
", id: string, data: object, options?: object | undefined) => Promise<{ item: U; } | { item: U; meta: any; }>"
", id: string, data: object, options?: object | undefined) => Promise<{ item: U; meta?: undefined; } | { item: U; meta: any; }>"
],
"path": "src/plugins/content_management/server/core/types.ts",
"deprecated": false,
@ -1941,7 +1941,9 @@
"type": "Object",
"tags": [],
"label": "requestHandlerContext",
"description": [],
"description": [
"The Core HTTP request handler context"
],
"signature": [
{
"pluginId": "@kbn/core-http-request-handler-context-server",
@ -2833,7 +2835,7 @@
"label": "CreateResult",
"description": [],
"signature": [
"M extends void ? { item: T; } : { item: T; meta: M; }"
"M extends void ? { item: T; meta?: undefined; } : { item: T; meta: M; }"
],
"path": "src/plugins/content_management/common/rpc/create.ts",
"deprecated": false,
@ -2848,7 +2850,7 @@
"label": "GetResult",
"description": [],
"signature": [
"M extends void ? { item: T; } : { item: T; meta: M; }"
"M extends void ? { item: T; meta?: undefined; } : { item: T; meta: M; }"
],
"path": "src/plugins/content_management/common/rpc/get.ts",
"deprecated": false,
@ -2944,7 +2946,7 @@
"label": "UpdateResult",
"description": [],
"signature": [
"M extends void ? { item: T; } : { item: T; meta: M; }"
"M extends void ? { item: T; meta?: undefined; } : { item: T; meta: M; }"
],
"path": "src/plugins/content_management/common/rpc/update.ts",
"deprecated": false,

4
api_docs/content_management.mdx
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-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
---
import contentManagementObj from './content_management.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sh
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 149 | 0 | 126 | 6 |
| 149 | 0 | 125 | 6 |
## Client

2
api_docs/controls.mdx
View file

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

2
api_docs/custom_integrations.mdx
View file

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

2
api_docs/dashboard.mdx
View file

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

2
api_docs/dashboard_enhanced.mdx
View file

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

2
api_docs/data.mdx
View file

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

2
api_docs/data_query.mdx
View file

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

2
api_docs/data_search.mdx
View file

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

2
api_docs/data_view_editor.mdx
View file

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

2
api_docs/data_view_field_editor.mdx
View file

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

2
api_docs/data_view_management.mdx
View file

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

2
api_docs/data_views.mdx
View file

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

2
api_docs/data_visualizer.mdx
View file

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

2
api_docs/dataset_quality.mdx
View file

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

2
api_docs/deprecations_by_api.mdx
View file

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

4
api_docs/deprecations_by_plugin.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
title: Deprecated API usage by plugin
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2024-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -1339,7 +1339,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=KibanaThemeProvider), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=KibanaThemeProvider), [app.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/app/app.tsx#:~:text=KibanaThemeProvider) | - |
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode)+ 7 more | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode)+ 7 more | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts#:~:text=license%24), [threshold.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/threshold.ts#:~:text=license%24) | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [create_threat_signal.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/indicator_match/threat_mapping/create_threat_signal.ts#:~:text=license%24), [create_event_signal.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/indicator_match/threat_mapping/create_event_signal.ts#:~:text=license%24), [query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts#:~:text=license%24), [threshold.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/threshold.ts#:~:text=license%24) | 8.8.0 |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | [request_context_factory.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts#:~:text=authc), [create_signals_migration_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts#:~:text=authc), [delete_signals_migration_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts#:~:text=authc), [finalize_signals_migration_route.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts#:~:text=authc), [common.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts#:~:text=authc) | - |
| <DocLink id="kibTimelinesPluginApi" section="def-common.DeprecatedCellValueElementProps" text="DeprecatedCellValueElementProps"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx#:~:text=DeprecatedCellValueElementProps), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx#:~:text=DeprecatedCellValueElementProps) | - |
| <DocLink id="kibTimelinesPluginApi" section="def-common.DeprecatedRowRenderer" text="DeprecatedRowRenderer"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx#:~:text=DeprecatedRowRenderer), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/public/common/components/events_viewer/index.tsx#:~:text=DeprecatedRowRenderer) | - |

4
api_docs/deprecations_by_team.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
title: Deprecated APIs due to be removed, by team
description: Lists the teams that are referencing deprecated APIs with a remove by date.
date: 2024-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -165,4 +165,4 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| --------|-------|-----------|-----------|
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode)+ 7 more | 8.8.0 |
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode)+ 7 more | 8.8.0 |
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts#:~:text=license%24), [threshold.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/threshold.ts#:~:text=license%24) | 8.8.0 |
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [create_threat_signal.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/indicator_match/threat_mapping/create_threat_signal.ts#:~:text=license%24), [create_event_signal.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/indicator_match/threat_mapping/create_event_signal.ts#:~:text=license%24), [query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/query/query.ts#:~:text=license%24), [threshold.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/rule_types/threshold/threshold.ts#:~:text=license%24) | 8.8.0 |

2
api_docs/dev_tools.mdx
View file

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

304
api_docs/discover.devdocs.json
View file

@ -24,10 +24,10 @@
},
{
"parentPluginId": "discover",
"id": "def-public.LogExplorerTabs",
"id": "def-public.LogsExplorerTabs",
"type": "Function",
"tags": [],
"label": "LogExplorerTabs",
"label": "LogsExplorerTabs",
"description": [],
"signature": [
"React.ForwardRefExoticComponent<",
@ -35,8 +35,8 @@
"pluginId": "discover",
"scope": "public",
"docId": "kibDiscoverPluginApi",
"section": "def-public.LogExplorerTabsProps",
"text": "LogExplorerTabsProps"
"section": "def-public.LogsExplorerTabsProps",
"text": "LogsExplorerTabsProps"
},
" & ",
{
@ -48,14 +48,14 @@
},
" & React.RefAttributes<{}>>"
],
"path": "src/plugins/discover/public/components/log_explorer_tabs/index.ts",
"path": "src/plugins/discover/public/components/logs_explorer_tabs/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "discover",
"id": "def-public.LogExplorerTabs.$1",
"id": "def-public.LogsExplorerTabs.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
@ -1163,18 +1163,18 @@
},
{
"parentPluginId": "discover",
"id": "def-public.LogExplorerTabsProps",
"id": "def-public.LogsExplorerTabsProps",
"type": "Interface",
"tags": [],
"label": "LogExplorerTabsProps",
"label": "LogsExplorerTabsProps",
"description": [],
"path": "src/plugins/discover/public/components/log_explorer_tabs/log_explorer_tabs.tsx",
"path": "src/plugins/discover/public/components/logs_explorer_tabs/logs_explorer_tabs.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.LogExplorerTabsProps.services",
"id": "def-public.LogsExplorerTabsProps.services",
"type": "Object",
"tags": [],
"label": "services",
@ -1190,21 +1190,21 @@
},
" | undefined; }"
],
"path": "src/plugins/discover/public/components/log_explorer_tabs/log_explorer_tabs.tsx",
"path": "src/plugins/discover/public/components/logs_explorer_tabs/logs_explorer_tabs.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.LogExplorerTabsProps.selectedTab",
"id": "def-public.LogsExplorerTabsProps.selectedTab",
"type": "CompoundType",
"tags": [],
"label": "selectedTab",
"description": [],
"signature": [
"\"discover\" | \"log-explorer\""
"\"discover\" | \"logs-explorer\""
],
"path": "src/plugins/discover/public/components/log_explorer_tabs/log_explorer_tabs.tsx",
"path": "src/plugins/discover/public/components/logs_explorer_tabs/logs_explorer_tabs.tsx",
"deprecated": false,
"trackAdoption": false
}
@ -1722,10 +1722,10 @@
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverSetup.showLogExplorerTabs",
"id": "def-public.DiscoverSetup.showLogsExplorerTabs",
"type": "Function",
"tags": [],
"label": "showLogExplorerTabs",
"label": "showLogsExplorerTabs",
"description": [],
"signature": [
"() => void"
@ -2318,7 +2318,7 @@
},
">"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
@ -2332,7 +2332,7 @@
"signature": [
"\"DISCOVER_APP_LOCATOR\""
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2346,7 +2346,7 @@
"signature": [
"any"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
@ -2360,7 +2360,7 @@
"signature": [
"DiscoverAppLocatorDependencies"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
@ -2385,10 +2385,16 @@
"text": "DiscoverAppLocatorParams"
},
") => Promise<{ app: string; path: string; state: ",
"MainHistoryLocationState",
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.MainHistoryLocationState",
"text": "MainHistoryLocationState"
},
"; }>"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
@ -2408,7 +2414,7 @@
"text": "DiscoverAppLocatorParams"
}
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
@ -2418,6 +2424,110 @@
}
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverESQLLocatorDefinition",
"type": "Class",
"tags": [],
"label": "DiscoverESQLLocatorDefinition",
"description": [],
"signature": [
{
"pluginId": "discover",
"scope": "common",
"docId": "kibDiscoverPluginApi",
"section": "def-common.DiscoverESQLLocatorDefinition",
"text": "DiscoverESQLLocatorDefinition"
},
" implements ",
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorDefinition",
"text": "LocatorDefinition"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
">"
],
"path": "src/plugins/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-common.DiscoverESQLLocatorDefinition.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"DISCOVER_ESQL_LOCATOR\""
],
"path": "src/plugins/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverESQLLocatorDefinition.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-common.DiscoverESQLLocatorDefinition.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "deps",
"description": [],
"signature": [
"DiscoverESQLLocatorDependencies"
],
"path": "src/plugins/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverESQLLocatorDefinition.getLocation",
"type": "Function",
"tags": [],
"label": "getLocation",
"description": [],
"signature": [
"() => Promise<",
"KibanaLocation",
"<object>>"
],
"path": "src/plugins/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
@ -2446,7 +2556,7 @@
"text": "SerializableRecord"
}
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
@ -2462,7 +2572,7 @@
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2478,7 +2588,7 @@
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2496,7 +2606,7 @@
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
@ -2563,7 +2673,7 @@
},
" | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2586,7 +2696,7 @@
},
" | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2618,7 +2728,7 @@
},
") | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2641,7 +2751,7 @@
},
"[] | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2672,7 +2782,7 @@
},
" | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2688,7 +2798,7 @@
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2704,7 +2814,7 @@
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2720,7 +2830,7 @@
"signature": [
"string[] | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2743,7 +2853,7 @@
},
" | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2759,7 +2869,7 @@
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2775,7 +2885,7 @@
"signature": [
"string[][] | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2791,7 +2901,7 @@
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2808,7 +2918,7 @@
"VIEW_MODE",
" | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2824,7 +2934,7 @@
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2840,7 +2950,7 @@
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2856,7 +2966,7 @@
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
@ -2872,7 +2982,58 @@
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.MainHistoryLocationState",
"type": "Interface",
"tags": [],
"label": "MainHistoryLocationState",
"description": [
"\nLocation state of scoped history (history instance of Kibana Platform application service)"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-common.MainHistoryLocationState.dataViewSpec",
"type": "Object",
"tags": [],
"label": "dataViewSpec",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewSpec",
"text": "DataViewSpec"
},
" | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-common.MainHistoryLocationState.isAlertResults",
"type": "CompoundType",
"tags": [],
"label": "isAlertResults",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
}
@ -2907,7 +3068,7 @@
"signature": [
"\"DISCOVER_APP_LOCATOR\""
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
@ -2937,7 +3098,58 @@
},
">"
],
"path": "src/plugins/discover/common/locator.ts",
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverESQLLocator",
"type": "Type",
"tags": [],
"label": "DiscoverESQLLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
},
">"
],
"path": "src/plugins/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.DiscoverESQLLocatorParams",
"type": "Type",
"tags": [],
"label": "DiscoverESQLLocatorParams",
"description": [],
"signature": [
{
"pluginId": "@kbn/utility-types",
"scope": "common",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-common.SerializableRecord",
"text": "SerializableRecord"
}
],
"path": "src/plugins/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false

4
api_docs/discover.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover
title: "discover"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discover plugin
date: 2024-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
---
import discoverObj from './discover.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 141 | 0 | 95 | 22 |
| 151 | 0 | 104 | 22 |
## Client

2
api_docs/discover_enhanced.mdx
View file

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

2
api_docs/ecs_data_quality_dashboard.mdx
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-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
---
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';

2
api_docs/elastic_assistant.mdx
View file

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

857
api_docs/embeddable.devdocs.json
View file

@ -5875,6 +5875,170 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.Embeddable.savedObjectId",
"type": "Object",
"tags": [],
"label": "savedObjectId",
"description": [],
"signature": [
"{ readonly value: string | undefined; source: ",
"Observable",
"<any> | undefined; error: (err: any) => void; forEach: { (next: (value: string | undefined) => void): Promise<void>; (next: (value: string | undefined) => void, promiseCtor: PromiseConstructorLike): Promise<void>; }; getValue: () => string | undefined; pipe: { (): ",
"Observable",
"<string | undefined>; <A>(op1: ",
"OperatorFunction",
"<string | undefined, A>): ",
"Observable",
"<A>; <A, B>(op1: ",
"OperatorFunction",
"<string | undefined, A>, op2: ",
"OperatorFunction",
"<A, B>): ",
"Observable",
"<B>; <A, B, C>(op1: ",
"OperatorFunction",
"<string | undefined, A>, op2: ",
"OperatorFunction",
"<A, B>, op3: ",
"OperatorFunction",
"<B, C>): ",
"Observable",
"<C>; <A, B, C, D>(op1: ",
"OperatorFunction",
"<string | undefined, A>, op2: ",
"OperatorFunction",
"<A, B>, op3: ",
"OperatorFunction",
"<B, C>, op4: ",
"OperatorFunction",
"<C, D>): ",
"Observable",
"<D>; <A, B, C, D, E>(op1: ",
"OperatorFunction",
"<string | undefined, A>, op2: ",
"OperatorFunction",
"<A, B>, op3: ",
"OperatorFunction",
"<B, C>, op4: ",
"OperatorFunction",
"<C, D>, op5: ",
"OperatorFunction",
"<D, E>): ",
"Observable",
"<E>; <A, B, C, D, E, F>(op1: ",
"OperatorFunction",
"<string | undefined, A>, op2: ",
"OperatorFunction",
"<A, B>, op3: ",
"OperatorFunction",
"<B, C>, op4: ",
"OperatorFunction",
"<C, D>, op5: ",
"OperatorFunction",
"<D, E>, op6: ",
"OperatorFunction",
"<E, F>): ",
"Observable",
"<F>; <A, B, C, D, E, F, G>(op1: ",
"OperatorFunction",
"<string | undefined, A>, op2: ",
"OperatorFunction",
"<A, B>, op3: ",
"OperatorFunction",
"<B, C>, op4: ",
"OperatorFunction",
"<C, D>, op5: ",
"OperatorFunction",
"<D, E>, op6: ",
"OperatorFunction",
"<E, F>, op7: ",
"OperatorFunction",
"<F, G>): ",
"Observable",
"<G>; <A, B, C, D, E, F, G, H>(op1: ",
"OperatorFunction",
"<string | undefined, A>, op2: ",
"OperatorFunction",
"<A, B>, op3: ",
"OperatorFunction",
"<B, C>, op4: ",
"OperatorFunction",
"<C, D>, op5: ",
"OperatorFunction",
"<D, E>, op6: ",
"OperatorFunction",
"<E, F>, op7: ",
"OperatorFunction",
"<F, G>, op8: ",
"OperatorFunction",
"<G, H>): ",
"Observable",
"<H>; <A, B, C, D, E, F, G, H, I>(op1: ",
"OperatorFunction",
"<string | undefined, A>, op2: ",
"OperatorFunction",
"<A, B>, op3: ",
"OperatorFunction",
"<B, C>, op4: ",
"OperatorFunction",
"<C, D>, op5: ",
"OperatorFunction",
"<D, E>, op6: ",
"OperatorFunction",
"<E, F>, op7: ",
"OperatorFunction",
"<F, G>, op8: ",
"OperatorFunction",
"<G, H>, op9: ",
"OperatorFunction",
"<H, I>): ",
"Observable",
"<I>; <A, B, C, D, E, F, G, H, I>(op1: ",
"OperatorFunction",
"<string | undefined, A>, op2: ",
"OperatorFunction",
"<A, B>, op3: ",
"OperatorFunction",
"<B, C>, op4: ",
"OperatorFunction",
"<C, D>, op5: ",
"OperatorFunction",
"<D, E>, op6: ",
"OperatorFunction",
"<E, F>, op7: ",
"OperatorFunction",
"<F, G>, op8: ",
"OperatorFunction",
"<G, H>, op9: ",
"OperatorFunction",
"<H, I>, ...operations: ",
"OperatorFunction",
"<any, any>[]): ",
"Observable",
"<unknown>; }; complete: () => void; closed: boolean; observers: ",
"Observer",
"<string | undefined>[]; isStopped: boolean; hasError: boolean; thrownError: any; lift: <R>(operator: ",
"Operator",
"<string | undefined, R>) => ",
"Observable",
"<R>; unsubscribe: () => void; readonly observed: boolean; asObservable: () => ",
"Observable",
"<string | undefined>; operator: ",
"Operator",
"<any, string | undefined> | undefined; subscribe: { (observerOrNext?: Partial<",
"Observer",
"<string | undefined>> | ((value: string | undefined) => void) | undefined): ",
"Subscription",
"; (next?: ((value: string | undefined) => void) | null | undefined, error?: ((error: any) => void) | null | undefined, complete?: (() => void) | null | undefined): ",
"Subscription",
"; }; toPromise: { (): Promise<string | undefined>; (PromiseCtor: PromiseConstructor): Promise<string | undefined>; (PromiseCtor: PromiseConstructorLike): Promise<string | undefined>; }; }"
],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.Embeddable.getEditHref",
@ -8041,63 +8205,14 @@
"section": "def-public.ChartActionContext",
"text": "ChartActionContext"
},
"<",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", any>>) => context is ",
") => context is ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.MultiValueClickContext",
"text": "MultiValueClickContext"
},
"<",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", any>>"
}
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
@ -8117,32 +8232,7 @@
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ChartActionContext",
"text": "ChartActionContext"
},
"<",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", any>>"
}
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
@ -8169,63 +8259,14 @@
"section": "def-public.ChartActionContext",
"text": "ChartActionContext"
},
"<",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", any>>) => context is ",
") => context is ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.RangeSelectContext",
"text": "RangeSelectContext"
},
"<",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", any>>"
}
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
@ -8245,32 +8286,7 @@
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ChartActionContext",
"text": "ChartActionContext"
},
"<",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", any>>"
}
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
@ -8330,31 +8346,7 @@
"section": "def-public.ChartActionContext",
"text": "ChartActionContext"
},
"<",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", any>>) => context is ",
") => context is ",
{
"pluginId": "@kbn/ui-actions-browser",
"scope": "common",
@ -8381,32 +8373,7 @@
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ChartActionContext",
"text": "ChartActionContext"
},
"<",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", any>>"
}
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
@ -8496,63 +8463,14 @@
"section": "def-public.ChartActionContext",
"text": "ChartActionContext"
},
"<",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", any>>) => context is ",
") => context is ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ValueClickContext",
"text": "ValueClickContext"
},
"<",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", any>>"
}
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
@ -8572,32 +8490,7 @@
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ChartActionContext",
"text": "ChartActionContext"
},
"<",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.IEmbeddable",
"text": "IEmbeddable"
},
"<",
{
"pluginId": "embeddable",
"scope": "common",
"docId": "kibEmbeddablePluginApi",
"section": "def-common.EmbeddableInput",
"text": "EmbeddableInput"
},
", ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.EmbeddableOutput",
"text": "EmbeddableOutput"
},
", any>>"
}
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
@ -9683,66 +9576,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.CellValueContext",
"type": "Interface",
"tags": [],
"label": "CellValueContext",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.CellValueContext",
"text": "CellValueContext"
},
"<T>"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "embeddable",
"id": "def-public.CellValueContext.embeddable",
"type": "Uncategorized",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
"T"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.CellValueContext.data",
"type": "Array",
"tags": [],
"label": "data",
"description": [],
"signature": [
"{ value?: any; eventId?: string | undefined; columnMeta?: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableColumnMeta",
"text": "DatatableColumnMeta"
},
" | undefined; }[]"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.ContainerInput",
@ -12825,74 +12658,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.MultiValueClickContext",
"type": "Interface",
"tags": [],
"label": "MultiValueClickContext",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.MultiValueClickContext",
"text": "MultiValueClickContext"
},
"<T>"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "embeddable",
"id": "def-public.MultiValueClickContext.embeddable",
"type": "Uncategorized",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
"T | undefined"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.MultiValueClickContext.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
"{ data: { table: Pick<",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
", \"rows\" | \"columns\">; cells: { column: number; row: number; }[]; relation?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.BooleanRelation",
"text": "BooleanRelation"
},
" | undefined; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.OutputSpec",
@ -13049,66 +12814,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.RangeSelectContext",
"type": "Interface",
"tags": [],
"label": "RangeSelectContext",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.RangeSelectContext",
"text": "RangeSelectContext"
},
"<T>"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "embeddable",
"id": "def-public.RangeSelectContext.embeddable",
"type": "Uncategorized",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
"T | undefined"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.RangeSelectContext.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
"{ table: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
"; column: number; range: number[]; timeFieldName?: string | undefined; }"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.ReactEmbeddableFactory",
@ -13477,66 +13182,6 @@
}
],
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.ValueClickContext",
"type": "Interface",
"tags": [],
"label": "ValueClickContext",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.ValueClickContext",
"text": "ValueClickContext"
},
"<T>"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "embeddable",
"id": "def-public.ValueClickContext.embeddable",
"type": "Uncategorized",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
"T | undefined"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.ValueClickContext.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
"{ data: { table: Pick<",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
", \"rows\" | \"columns\">; column: number; row: number; value: any; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [
@ -13586,6 +13231,37 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.CellValueContext",
"type": "Type",
"tags": [],
"label": "CellValueContext",
"description": [],
"signature": [
"Partial<",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-common.EmbeddableApiContext",
"text": "EmbeddableApiContext"
},
"> & { data: { value?: any; eventId?: string | undefined; columnMeta?: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.DatatableColumnMeta",
"text": "DatatableColumnMeta"
},
" | undefined; }[]; }"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.ChartActionContext",
@ -13601,15 +13277,7 @@
"section": "def-public.ValueClickContext",
"text": "ValueClickContext"
},
"<T> | ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.MultiValueClickContext",
"text": "MultiValueClickContext"
},
"<T> | ",
" | ",
{
"pluginId": "embeddable",
"scope": "public",
@ -13617,7 +13285,15 @@
"section": "def-public.RangeSelectContext",
"text": "RangeSelectContext"
},
"<T> | ",
" | ",
{
"pluginId": "embeddable",
"scope": "public",
"docId": "kibEmbeddablePluginApi",
"section": "def-public.MultiValueClickContext",
"text": "MultiValueClickContext"
},
" | ",
{
"pluginId": "@kbn/ui-actions-browser",
"scope": "common",
@ -13877,6 +13553,45 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.MultiValueClickContext",
"type": "Type",
"tags": [],
"label": "MultiValueClickContext",
"description": [],
"signature": [
"Partial<",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-common.EmbeddableApiContext",
"text": "EmbeddableApiContext"
},
"> & { data: { data: { table: Pick<",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
", \"rows\" | \"columns\">; cells: { column: number; row: number; }[]; relation?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.BooleanRelation",
"text": "BooleanRelation"
},
" | undefined; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }; }"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.PANEL_BADGE_TRIGGER",
@ -13922,6 +13637,37 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.RangeSelectContext",
"type": "Type",
"tags": [],
"label": "RangeSelectContext",
"description": [],
"signature": [
"Partial<",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-common.EmbeddableApiContext",
"text": "EmbeddableApiContext"
},
"> & { data: { table: ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
"; column: number; range: number[]; timeFieldName?: string | undefined; }; }"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.ReactEmbeddable",
@ -14045,6 +13791,37 @@
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "embeddable",
"id": "def-public.ValueClickContext",
"type": "Type",
"tags": [],
"label": "ValueClickContext",
"description": [],
"signature": [
"Partial<",
{
"pluginId": "@kbn/presentation-publishing",
"scope": "common",
"docId": "kibKbnPresentationPublishingPluginApi",
"section": "def-common.EmbeddableApiContext",
"text": "EmbeddableApiContext"
},
"> & { data: { data: { table: Pick<",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.Datatable",
"text": "Datatable"
},
", \"rows\" | \"columns\">; column: number; row: number; value: any; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }; }"
],
"path": "src/plugins/embeddable/public/lib/triggers/triggers.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [

4
api_docs/embeddable.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable
title: "embeddable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddable plugin
date: 2024-02-05
date: 2024-02-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 |
|-------------------|-----------|------------------------|-----------------|
| 564 | 1 | 459 | 8 |
| 557 | 1 | 452 | 8 |
## Client

2
api_docs/embeddable_enhanced.mdx
View file

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

2
api_docs/encrypted_saved_objects.mdx
View file

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

2
api_docs/enterprise_search.mdx
View file

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

2
api_docs/es_ui_shared.mdx
View file

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

2
api_docs/event_annotation.devdocs.json
View file

@ -1085,7 +1085,7 @@
"signature": [
"{ item: ",
"EventAnnotationGroupSavedObject",
"; }"
"; meta?: undefined; }"
],
"path": "src/plugins/event_annotation/common/content_management/v1/types.ts",
"deprecated": false,

2
api_docs/event_annotation.mdx
View file

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

2
api_docs/event_annotation_listing.mdx
View file

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

2
api_docs/event_log.mdx
View file

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

2
api_docs/exploratory_view.mdx
View file

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

2
api_docs/expression_error.mdx
View file

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

2
api_docs/expression_gauge.mdx
View file

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

2
api_docs/expression_heatmap.mdx
View file

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

2
api_docs/expression_image.mdx
View file

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

2
api_docs/expression_legacy_metric_vis.mdx
View file

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

2
api_docs/expression_metric.mdx
View file

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

2
api_docs/expression_metric_vis.mdx
View file

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

2
api_docs/expression_partition_vis.mdx
View file

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

2
api_docs/expression_repeat_image.mdx
View file

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

2
api_docs/expression_reveal_image.mdx
View file

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

2
api_docs/expression_shape.mdx
View file

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

2
api_docs/expression_tagcloud.mdx
View file

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

2
api_docs/expression_x_y.mdx
View file

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

32
api_docs/expressions.devdocs.json
View file

@ -6829,7 +6829,7 @@
"label": "useExpressionRenderer",
"description": [],
"signature": [
"(nodeRef: React.RefObject<HTMLElement>, {\n debounce,\n expression,\n hasCustomErrorRenderer,\n onData$,\n onEvent,\n onRender$,\n reload$,\n ...loaderParams\n }: ",
"(nodeRef: React.RefObject<HTMLElement>, {\n debounce,\n expression,\n hasCustomErrorRenderer,\n onData$,\n onEvent,\n onRender$,\n reload$,\n abortController,\n ...loaderParams\n }: ",
{
"pluginId": "expressions",
"scope": "public",
@ -6863,7 +6863,7 @@
"id": "def-public.useExpressionRenderer.$2",
"type": "Object",
"tags": [],
"label": "{\n debounce,\n expression,\n hasCustomErrorRenderer,\n onData$,\n onEvent,\n onRender$,\n reload$,\n ...loaderParams\n }",
"label": "{\n debounce,\n expression,\n hasCustomErrorRenderer,\n onData$,\n onEvent,\n onRender$,\n reload$,\n abortController,\n ...loaderParams\n }",
"description": [],
"signature": [
{
@ -9593,6 +9593,20 @@
"path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressions",
"id": "def-public.ExpressionRendererParams.abortController",
"type": "Object",
"tags": [],
"label": "abortController",
"description": [],
"signature": [
"AbortController | undefined"
],
"path": "src/plugins/expressions/public/react_expression_renderer/use_expression_renderer.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -10984,6 +10998,20 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressions",
"id": "def-public.IExpressionLoaderParams.abortController",
"type": "Object",
"tags": [],
"label": "abortController",
"description": [],
"signature": [
"AbortController | undefined"
],
"path": "src/plugins/expressions/public/types/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "expressions",
"id": "def-public.IExpressionLoaderParams.partial",

4
api_docs/expressions.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions
title: "expressions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressions plugin
date: 2024-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
---
import expressionsObj from './expressions.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2222 | 17 | 1760 | 5 |
| 2224 | 17 | 1762 | 5 |
## Client

2
api_docs/features.mdx
View file

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

2
api_docs/field_formats.mdx
View file

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

2
api_docs/file_upload.mdx
View file

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

2
api_docs/files.mdx
View file

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

2
api_docs/files_management.mdx
View file

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

2
api_docs/fleet.mdx
View file

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

2
api_docs/global_search.mdx
View file

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

2
api_docs/guided_onboarding.mdx
View file

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

2
api_docs/home.mdx
View file

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

2
api_docs/image_embeddable.mdx
View file

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

2
api_docs/index_lifecycle_management.mdx
View file

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

112
api_docs/index_management.devdocs.json
View file

@ -829,6 +829,20 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.LegacyTemplateSerialized.deprecated",
"type": "CompoundType",
"tags": [],
"label": "deprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-server.LegacyTemplateSerialized.mappings",
@ -1138,6 +1152,20 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateDeserialized.isDeprecated",
"type": "CompoundType",
"tags": [],
"label": "isDeprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateDeserialized._kbnMeta",
@ -1279,6 +1307,20 @@
"path": "x-pack/plugins/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateListItem.isDeprecated",
"type": "CompoundType",
"tags": [],
"label": "isDeprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -1348,6 +1390,20 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateSerialized.deprecated",
"type": "CompoundType",
"tags": [],
"label": "deprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/index_management/common/types/component_templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateSerialized._meta",
@ -2427,6 +2483,20 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.LegacyTemplateSerialized.deprecated",
"type": "CompoundType",
"tags": [],
"label": "deprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.LegacyTemplateSerialized.mappings",
@ -2766,6 +2836,20 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized.deprecated",
"type": "CompoundType",
"tags": [],
"label": "deprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateDeserialized._meta",
@ -2977,6 +3061,20 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem.deprecated",
"type": "CompoundType",
"tags": [],
"label": "deprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateListItem.ilmPolicy",
@ -3083,6 +3181,20 @@
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateSerialized.deprecated",
"type": "CompoundType",
"tags": [],
"label": "deprecated",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/index_management/common/types/templates.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.TemplateSerialized.composed_of",

4
api_docs/index_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexManagement
title: "indexManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexManagement plugin
date: 2024-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
---
import indexManagementObj from './index_management.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/platform-deployment-management](https://github.com/orgs/elasti
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 215 | 0 | 210 | 4 |
| 223 | 0 | 218 | 4 |
## Client

2
api_docs/infra.mdx
View file

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

2
api_docs/ingest_pipelines.mdx
View file

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

2
api_docs/inspector.mdx
View file

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

2
api_docs/interactive_setup.mdx
View file

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

2
api_docs/kbn_ace.mdx
View file

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

2
api_docs/kbn_actions_types.mdx
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-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/actions-types']
---
import kbnActionsTypesObj from './kbn_actions_types.devdocs.json';

2
api_docs/kbn_aiops_components.mdx
View file

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

2
api_docs/kbn_aiops_utils.mdx
View file

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

2
api_docs/kbn_alerting_api_integration_helpers.mdx
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-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-api-integration-helpers']
---
import kbnAlertingApiIntegrationHelpersObj from './kbn_alerting_api_integration_helpers.devdocs.json';

2
api_docs/kbn_alerting_state_types.mdx
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-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-state-types']
---
import kbnAlertingStateTypesObj from './kbn_alerting_state_types.devdocs.json';

2
api_docs/kbn_alerting_types.mdx
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-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-types']
---
import kbnAlertingTypesObj from './kbn_alerting_types.devdocs.json';

2
api_docs/kbn_alerts_as_data_utils.mdx
View file

@ -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-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-as-data-utils']
---
import kbnAlertsAsDataUtilsObj from './kbn_alerts_as_data_utils.devdocs.json';

2
api_docs/kbn_alerts_ui_shared.mdx
View file

@ -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-02-05
date: 2024-02-06
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-ui-shared']
---
import kbnAlertsUiSharedObj from './kbn_alerts_ui_shared.devdocs.json';

2
api_docs/kbn_analytics.mdx
View file

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

2
api_docs/kbn_analytics_client.mdx
View file

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

2
api_docs/kbn_analytics_collection_utils.mdx
View file

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

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