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

[api-docs] 2024-02-23 Daily api_docs build (#177678)

Browse source 
Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/622
This commit is contained in:
Kibana Machine 2024-02-23 01:02:10 -05:00 • committed by GitHub
parent d5167ac447
commit 244ecc403d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
720 changed files with 9177 additions and 3230 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-22
date: 2024-02-23
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-22
date: 2024-02-23
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-22
date: 2024-02-23
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-22
date: 2024-02-23
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-22
date: 2024-02-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';

1450
api_docs/alerting.devdocs.json
View file

File diff suppressed because it is too large Load diff

2
api_docs/alerting.mdx
View file

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

2
api_docs/apm.mdx
View file

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

24
api_docs/cases.devdocs.json
View file

@ -219,7 +219,15 @@
"signature": [
"{ features?: Partial<",
"CasesContextFeatures",
"> | undefined; owner: string[]; permissions: ",
"> | undefined; onClose?: ((theCase?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseUI",
"text": "CaseUI"
},
" | undefined, isCreateCase?: boolean | undefined) => void) | undefined; owner: string[]; permissions: ",
{
"pluginId": "cases",
"scope": "common",
@ -245,15 +253,7 @@
"section": "def-common.CaseUI",
"text": "CaseUI"
},
" | undefined) => void) | undefined; onClose?: ((theCase?: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CaseUI",
"text": "CaseUI"
},
" | undefined, isCreateCase?: boolean | undefined) => void) | undefined; onCreateCaseClicked?: (() => void) | undefined; }"
" | undefined) => void) | undefined; onCreateCaseClicked?: (() => void) | undefined; }"
],
"path": "x-pack/plugins/cases/public/client/ui/get_all_cases_selector_modal.tsx",
"deprecated": false,
@ -270,7 +270,7 @@
"signature": [
"{ features?: Partial<",
"CasesContextFeatures",
"> | undefined; owner: string[]; permissions: ",
"> | undefined; onClose?: (() => void) | undefined; owner: string[]; permissions: ",
{
"pluginId": "cases",
"scope": "common",
@ -280,7 +280,7 @@
},
"; basePath?: string | undefined; releasePhase?: ",
"ReleasePhase",
" | undefined; onClose?: (() => void) | undefined; attachments?: ",
" | undefined; attachments?: ",
{
"pluginId": "cases",
"scope": "public",

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

2
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-22
date: 2024-02-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
---
import contentManagementObj from './content_management.devdocs.json';

2
api_docs/controls.mdx
View file

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

4
api_docs/data_views.devdocs.json
View file

File diff suppressed because one or more lines are too long

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

2
api_docs/dataset_quality.devdocs.json
View file

@ -341,4 +341,4 @@
],
"objects": []
}
}
}

3
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-22
date: 2024-02-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality']
---
import datasetQualityObj from './dataset_quality.devdocs.json';
@ -41,3 +41,4 @@ Contact [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux
### Consts, variables and types
<DocDefinitionList data={datasetQualityObj.common.misc}/>

9
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-22
date: 2024-02-23
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -17,7 +17,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Referencing plugin(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibAlertingPluginApi" section="def-public.PluginSetupContract.registerNavigation" text="registerNavigation"/> | ml, stackAlerts | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | share, uiActions, guidedOnboarding, home, serverless, management, spaces, savedObjects, indexManagement, devTools, console, visualizations, dashboard, savedObjectsTagging, expressionXY, lens, expressionMetricVis, expressionGauge, security, alerting, triggersActionsUi, cases, aiops, licenseManagement, maps, dataVisualizer, ml, exploratoryView, fleet, metricsDataAccess, osquery, ingestPipelines, profiling, apm, expressionImage, expressionMetric, expressionError, expressionRevealImage, expressionRepeatImage, expressionShape, crossClusterReplication, graph, grokdebugger, indexLifecycleManagement, infra, logstash, monitoring, observabilityOnboarding, painlessLab, remoteClusters, rollup, searchprofiler, newsfeed, securitySolution, snapshotRestore, synthetics, transform, upgradeAssistant, uptime, watcher, cloudDataMigration, ux, filesManagement, kibanaOverview, visDefaultEditor, expressionHeatmap, expressionLegacyMetricVis, expressionPartitionVis, expressionTagcloud, visTypeTable, visTypeTimelion, visTypeTimeseries, visTypeVega, visTypeVislib | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | share, uiActions, guidedOnboarding, home, serverless, management, spaces, savedObjects, indexManagement, devTools, console, visualizations, dashboard, savedObjectsTagging, expressionXY, lens, expressionMetricVis, expressionGauge, security, alerting, triggersActionsUi, cases, aiops, licenseManagement, maps, dataVisualizer, ml, exploratoryView, fleet, metricsDataAccess, ingestPipelines, osquery, profiling, apm, expressionImage, expressionMetric, expressionError, expressionRevealImage, expressionRepeatImage, expressionShape, crossClusterReplication, graph, grokdebugger, indexLifecycleManagement, infra, logstash, monitoring, painlessLab, remoteClusters, rollup, searchprofiler, newsfeed, securitySolution, snapshotRestore, transform, upgradeAssistant, watcher, cloudDataMigration, observabilityOnboarding, synthetics, uptime, ux, filesManagement, kibanaOverview, visDefaultEditor, expressionHeatmap, expressionLegacyMetricVis, expressionPartitionVis, expressionTagcloud, visTypeTable, visTypeTimelion, visTypeTimeseries, visTypeVega, visTypeVislib | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | encryptedSavedObjects, actions, data, ml, logstash, securitySolution, cloudChat | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | actions, ml, savedObjectsTagging, enterpriseSearch | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SimpleSavedObject" text="SimpleSavedObject"/> | @kbn/core-saved-objects-browser-internal, @kbn/core, savedObjects, visualizations, aiops, ml, dataVisualizer, dashboardEnhanced, graph, lens, securitySolution, eventAnnotation, @kbn/core-saved-objects-browser-mocks | - |
@ -28,7 +28,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | dashboard, dataVisualizer, stackAlerts, expressionPartitionVis | - |
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | - |
| <DocLink id="kibAlertingPluginApi" section="def-common.MaintenanceWindow" text="MaintenanceWindow"/> | triggersActionsUi | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | inspector, data, savedObjects, console, runtimeFields, indexManagement, dataViewEditor, unifiedSearch, embeddable, visualizations, dashboard, licensing, savedObjectsTagging, dataViewFieldEditor, lens, security, triggersActionsUi, cases, observabilityShared, telemetry, maps, exploratoryView, fleet, timelines, banners, reporting, cloudSecurityPosture, dashboardEnhanced, imageEmbeddable, graph, monitoring, securitySolution, synthetics, uptime, cloudLinks, dataViewManagement, eventAnnotationListing, filesManagement, uiActions, visTypeVislib | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | inspector, data, savedObjects, console, runtimeFields, indexManagement, dataViewEditor, unifiedSearch, embeddable, visualizations, dashboard, licensing, savedObjectsTagging, dataViewFieldEditor, lens, security, triggersActionsUi, cases, observabilityShared, telemetry, maps, exploratoryView, fleet, timelines, banners, @kbn/reporting-public, reporting, cloudSecurityPosture, dashboardEnhanced, imageEmbeddable, graph, monitoring, securitySolution, cloudLinks, synthetics, uptime, dataViewManagement, eventAnnotationListing, filesManagement, uiActions, visTypeVislib | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttribute" text="SavedObjectAttribute"/> | @kbn/core, visualizations, triggersActionsUi | - |
| <DocLink id="kibAlertingPluginApi" section="def-server.RuleExecutorServices.alertFactory" text="alertFactory"/> | ruleRegistry, observability, infra, securitySolution, synthetics, uptime | - |
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.create" text="create"/> | alerting, discover, securitySolution | - |
@ -96,7 +96,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnCoreSavedObjectsBrowserInternalPluginApi" section="def-common.SavedObjectsService" text="SavedObjectsService"/> | @kbn/core-root-browser-internal, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibKbnCoreSavedObjectsApiServerPluginApi" section="def-common.SavedObjectsIncrementCounterOptions.migrationVersion" text="migrationVersion"/> | @kbn/core-saved-objects-api-server-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsApiServerPluginApi" section="def-common.SavedObjectsBulkCreateObject.migrationVersion" text="migrationVersion"/> | @kbn/core-saved-objects-api-server-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectsType.schemas" text="schemas"/> | @kbn/core-saved-objects-api-server-internal, spaces, data, visualizations, savedSearch, cloudSecurityPosture, dashboard, @kbn/core-test-helpers-so-type-serializer | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectsType.schemas" text="schemas"/> | @kbn/core-saved-objects-api-server-internal, @kbn/core-saved-objects-migration-server-internal, spaces, data, visualizations, savedSearch, cloudSecurityPosture, dashboard, @kbn/core-test-helpers-so-type-serializer | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, dataViewManagement, dataViews | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, dataViewManagement, dataViews | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, dataViewManagement | - |
@ -201,7 +201,6 @@ Safe to remove.
| <DocLink id="kibListsPluginApi" section="def-server.ListClient.createListItemBootStrapIndex" text="createListItemBootStrapIndex"/> | lists |
| <DocLink id="kibListsPluginApi" section="def-server.ListClient.setListPolicy" text="setListPolicy"/> | lists |
| <DocLink id="kibListsPluginApi" section="def-server.ListClient.setListItemPolicy" text="setListItemPolicy"/> | lists |
| <DocLink id="kibReportingPluginApi" section="def-public.ReportingPublicComponents.ReportingPanelPDF" text="ReportingPanelPDF"/> | reporting |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectsStart.SavedObjectClass" text="SavedObjectClass"/> | savedObjects |
| <DocLink id="kibServerlessPluginApi" section="def-public.ServerlessPluginStart.setSideNavComponentDeprecated" text="setSideNavComponentDeprecated"/> | serverless |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.ConcreteTaskInstance.interval" text="interval"/> | taskManager |

15
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-22
date: 2024-02-23
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -257,6 +257,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectsType.migrations" text="migrations"/> | [validate_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts#:~:text=migrations), [validate_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts#:~:text=migrations), [validate_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts#:~:text=migrations), [validate_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts#:~:text=migrations), [validate_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts#:~:text=migrations), [build_active_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.ts#:~:text=migrations), [build_active_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.ts#:~:text=migrations), [build_active_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/build_active_migrations.ts#:~:text=migrations), [kibana_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/kibana_migrator.test.ts#:~:text=migrations), [kibana_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/kibana_migrator.test.ts#:~:text=migrations)+ 62 more | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectsType.schemas" text="schemas"/> | [validate_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts#:~:text=schemas), [validate_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts#:~:text=schemas), [validate_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts#:~:text=schemas), [validate_migration.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migration.test.ts#:~:text=schemas), [validate_migration.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migration.test.ts#:~:text=schemas), [validate_migration.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migration.test.ts#:~:text=schemas), [validate_migration.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migration.test.ts#:~:text=schemas) | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectsType.convertToMultiNamespaceTypeVersion" text="convertToMultiNamespaceTypeVersion"/> | [utils.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/utils.ts#:~:text=convertToMultiNamespaceTypeVersion), [internal_transforms.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts#:~:text=convertToMultiNamespaceTypeVersion), [internal_transforms.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts#:~:text=convertToMultiNamespaceTypeVersion), [internal_transforms.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/internal_transforms.ts#:~:text=convertToMultiNamespaceTypeVersion), [validate_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts#:~:text=convertToMultiNamespaceTypeVersion), [validate_migrations.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/validate_migrations.ts#:~:text=convertToMultiNamespaceTypeVersion), [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts#:~:text=convertToMultiNamespaceTypeVersion), [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts#:~:text=convertToMultiNamespaceTypeVersion), [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts#:~:text=convertToMultiNamespaceTypeVersion), [document_migrator.test.ts](https://github.com/elastic/kibana/tree/main/packages/core/saved-objects/core-saved-objects-migration-server-internal/src/document_migrator/document_migrator.test.ts#:~:text=convertToMultiNamespaceTypeVersion)+ 18 more | - |
@ -347,6 +348,14 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
## @kbn/reporting-public
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [reporting_panel_content.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-reporting/public/share/share_context_menu/reporting_panel_content/reporting_panel_content.tsx#:~:text=toMountPoint), [reporting_panel_content.tsx](https://github.com/elastic/kibana/tree/main/packages/kbn-reporting/public/share/share_context_menu/reporting_panel_content/reporting_panel_content.tsx#:~:text=toMountPoint) | - |
## @kbn/securitysolution-data-table
| Deprecated API | Reference location(s) | Remove By |
@ -1277,7 +1286,7 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [job_failure.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_failure.tsx#:~:text=toMountPoint), [job_failure.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_failure.tsx#:~:text=toMountPoint), [job_failure.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_failure.tsx#:~:text=toMountPoint), [general_error.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/general_error.tsx#:~:text=toMountPoint), [general_error.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/general_error.tsx#:~:text=toMountPoint), [job_success.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_success.tsx#:~:text=toMountPoint), [job_success.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_success.tsx#:~:text=toMountPoint), [job_success.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_success.tsx#:~:text=toMountPoint), [job_warning_formulas.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_warning_formulas.tsx#:~:text=toMountPoint), [job_warning_formulas.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_warning_formulas.tsx#:~:text=toMountPoint)+ 9 more | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.toMountPoint" text="toMountPoint"/> | [job_failure.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_failure.tsx#:~:text=toMountPoint), [job_failure.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_failure.tsx#:~:text=toMountPoint), [job_failure.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_failure.tsx#:~:text=toMountPoint), [general_error.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/general_error.tsx#:~:text=toMountPoint), [general_error.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/general_error.tsx#:~:text=toMountPoint), [job_success.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_success.tsx#:~:text=toMountPoint), [job_success.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_success.tsx#:~:text=toMountPoint), [job_success.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_success.tsx#:~:text=toMountPoint), [job_warning_formulas.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_warning_formulas.tsx#:~:text=toMountPoint), [job_warning_formulas.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/public/notifier/job_warning_formulas.tsx#:~:text=toMountPoint)+ 7 more | - |
| <DocLink id="kibKbnReportingExportTypesPdfPluginApi" section="def-server.PdfV1ExportType" text="PdfV1ExportType"/> | [core.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/server/core.ts#:~:text=PdfV1ExportType), [core.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/server/core.ts#:~:text=PdfV1ExportType) | - |
| <DocLink id="kibKbnReportingExportTypesPdfCommonPluginApi" section="def-common.JobParamsPDFDeprecated" text="JobParamsPDFDeprecated"/> | [request_handler.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/server/routes/common/generate/request_handler.test.ts#:~:text=JobParamsPDFDeprecated), [request_handler.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/reporting/server/routes/common/generate/request_handler.test.ts#:~:text=JobParamsPDFDeprecated) | - |
@ -1725,4 +1734,4 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaThemeProvider" text="KibanaThemeProvider"/> | [shared_imports.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/application/shared_imports.ts#:~:text=KibanaThemeProvider), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/application/index.tsx#:~:text=KibanaThemeProvider), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/application/index.tsx#:~:text=KibanaThemeProvider), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/application/index.tsx#:~:text=KibanaThemeProvider) | - |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24) | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24) | 8.8.0 |

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-22
date: 2024-02-23
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$"/> | [create_threat_signals.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_signals.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 |
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [create_threat_signals.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_signals.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 |

16
api_docs/dev_tools.devdocs.json
View file

@ -192,15 +192,15 @@
},
{
"parentPluginId": "devTools",
"id": "def-public.ENABLE_DOCKED_CONSOLE_UI_SETTING_ID",
"id": "def-public.ENABLE_PERSISTENT_CONSOLE_UI_SETTING_ID",
"type": "string",
"tags": [],
"label": "ENABLE_DOCKED_CONSOLE_UI_SETTING_ID",
"label": "ENABLE_PERSISTENT_CONSOLE_UI_SETTING_ID",
"description": [
"\nUI Setting ID for enabling / disabling the docked console in Kibana"
"\nUI Setting ID for enabling / disabling the persistent console in Kibana"
],
"signature": [
"\"devTools:enableDockedConsole\""
"\"devTools:enablePersistentConsole\""
],
"path": "src/plugins/dev_tools/common/constants.ts",
"deprecated": false,
@ -297,15 +297,15 @@
},
{
"parentPluginId": "devTools",
"id": "def-common.ENABLE_DOCKED_CONSOLE_UI_SETTING_ID",
"id": "def-common.ENABLE_PERSISTENT_CONSOLE_UI_SETTING_ID",
"type": "string",
"tags": [],
"label": "ENABLE_DOCKED_CONSOLE_UI_SETTING_ID",
"label": "ENABLE_PERSISTENT_CONSOLE_UI_SETTING_ID",
"description": [
"\nUI Setting ID for enabling / disabling the docked console in Kibana"
"\nUI Setting ID for enabling / disabling the persistent console in Kibana"
],
"signature": [
"\"devTools:enableDockedConsole\""
"\"devTools:enablePersistentConsole\""
],
"path": "src/plugins/dev_tools/common/constants.ts",
"deprecated": false,

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

462
api_docs/discover.devdocs.json
View file

@ -60,7 +60,9 @@
"tags": [],
"label": "props",
"description": [],
"signature": ["P"],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false,
"trackAdoption": false
@ -99,7 +101,10 @@
"tags": [],
"label": "result",
"description": [],
"signature": ["DataTableRecord", "[] | undefined"],
"signature": [
"DataTableRecord",
"[] | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_data_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -132,7 +137,9 @@
"tags": [],
"label": "textBasedHeaderWarning",
"description": [],
"signature": ["string | undefined"],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_data_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -144,7 +151,10 @@
"tags": [],
"label": "interceptedWarnings",
"description": [],
"signature": ["SearchResponseIncompleteWarning", "[] | undefined"],
"signature": [
"SearchResponseIncompleteWarning",
"[] | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_data_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -169,8 +179,12 @@
"type": "Array",
"tags": [],
"label": "columns",
"description": ["\nColumns displayed in the table"],
"signature": ["string[] | undefined"],
"description": [
"\nColumns displayed in the table"
],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -181,7 +195,9 @@
"type": "Array",
"tags": [],
"label": "filters",
"description": ["\nArray of applied filters"],
"description": [
"\nArray of applied filters"
],
"signature": [
{
"pluginId": "@kbn/es-query",
@ -202,7 +218,9 @@
"type": "Object",
"tags": [],
"label": "grid",
"description": ["\nData Grid related state"],
"description": [
"\nData Grid related state"
],
"signature": [
{
"pluginId": "savedSearch",
@ -223,8 +241,12 @@
"type": "CompoundType",
"tags": [],
"label": "hideChart",
"description": ["\nHide chart"],
"signature": ["boolean | undefined"],
"description": [
"\nHide chart"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -235,8 +257,12 @@
"type": "string",
"tags": [],
"label": "index",
"description": ["\nid of the used data view"],
"signature": ["string | undefined"],
"description": [
"\nid of the used data view"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -247,8 +273,12 @@
"type": "string",
"tags": [],
"label": "interval",
"description": ["\nUsed interval of the histogram"],
"signature": ["string | undefined"],
"description": [
"\nUsed interval of the histogram"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -259,7 +289,9 @@
"type": "CompoundType",
"tags": [],
"label": "query",
"description": ["\nLucence or KQL query"],
"description": [
"\nLucence or KQL query"
],
"signature": [
{
"pluginId": "@kbn/es-query",
@ -288,8 +320,12 @@
"type": "Array",
"tags": [],
"label": "sort",
"description": ["\nArray of the used sorting [[field,direction],...]"],
"signature": ["string[][] | undefined"],
"description": [
"\nArray of the used sorting [[field,direction],...]"
],
"signature": [
"string[][] | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -300,8 +336,12 @@
"type": "string",
"tags": [],
"label": "savedQuery",
"description": ["\nid of the used saved query"],
"signature": ["string | undefined"],
"description": [
"\nid of the used saved query"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -312,7 +352,9 @@
"type": "CompoundType",
"tags": [],
"label": "viewMode",
"description": ["\nTable view: Documents vs Field Statistics"],
"description": [
"\nTable view: Documents vs Field Statistics"
],
"signature": [
{
"pluginId": "savedSearch",
@ -336,7 +378,9 @@
"description": [
"\nHide mini distribution/preview charts when in Field Statistics mode"
],
"signature": ["boolean | undefined"],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -347,8 +391,12 @@
"type": "number",
"tags": [],
"label": "rowHeight",
"description": ["\nDocument explorer row height option"],
"signature": ["number | undefined"],
"description": [
"\nDocument explorer row height option"
],
"signature": [
"number | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -359,8 +407,12 @@
"type": "number",
"tags": [],
"label": "headerRowHeight",
"description": ["\nDocument explorer header row height option"],
"signature": ["number | undefined"],
"description": [
"\nDocument explorer header row height option"
],
"signature": [
"number | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -371,8 +423,12 @@
"type": "number",
"tags": [],
"label": "rowsPerPage",
"description": ["\nNumber of rows in the grid per page"],
"signature": ["number | undefined"],
"description": [
"\nNumber of rows in the grid per page"
],
"signature": [
"number | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -383,8 +439,12 @@
"type": "number",
"tags": [],
"label": "sampleSize",
"description": ["\nCustom sample size"],
"signature": ["number | undefined"],
"description": [
"\nCustom sample size"
],
"signature": [
"number | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -395,8 +455,12 @@
"type": "string",
"tags": [],
"label": "breakdownField",
"description": ["\nBreakdown field of chart"],
"signature": ["string | undefined"],
"description": [
"\nBreakdown field of chart"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
@ -518,7 +582,9 @@
"tags": [],
"label": "id",
"description": [],
"signature": ["TCustomizationId"],
"signature": [
"TCustomizationId"
],
"path": "src/plugins/discover/public/customizations/customization_service.ts",
"deprecated": false,
"trackAdoption": false,
@ -629,7 +695,9 @@
"tags": [],
"label": "options",
"description": [],
"signature": ["CustomizationCallbackContext"],
"signature": [
"CustomizationCallbackContext"
],
"path": "src/plugins/discover/public/customizations/types.ts",
"deprecated": false,
"trackAdoption": false
@ -677,8 +745,12 @@
"type": "Object",
"tags": [],
"label": "globalState",
"description": ["\nGlobal State, the _g part of the URL"],
"signature": ["DiscoverGlobalStateContainer"],
"description": [
"\nGlobal State, the _g part of the URL"
],
"signature": [
"DiscoverGlobalStateContainer"
],
"path": "src/plugins/discover/public/application/main/services/discover_state.ts",
"deprecated": false,
"trackAdoption": false
@ -689,8 +761,12 @@
"type": "Object",
"tags": [],
"label": "appState",
"description": ["\nApp state, the _a part of the URL"],
"signature": ["DiscoverAppStateContainer"],
"description": [
"\nApp state, the _a part of the URL"
],
"signature": [
"DiscoverAppStateContainer"
],
"path": "src/plugins/discover/public/application/main/services/discover_state.ts",
"deprecated": false,
"trackAdoption": false
@ -701,8 +777,12 @@
"type": "Object",
"tags": [],
"label": "dataState",
"description": ["\nData fetching related state"],
"signature": ["DiscoverDataStateContainer"],
"description": [
"\nData fetching related state"
],
"signature": [
"DiscoverDataStateContainer"
],
"path": "src/plugins/discover/public/application/main/services/discover_state.ts",
"deprecated": false,
"trackAdoption": false
@ -713,7 +793,9 @@
"type": "Object",
"tags": [],
"label": "internalState",
"description": ["\nInternal shared state that's used at several places in the UI"],
"description": [
"\nInternal shared state that's used at several places in the UI"
],
"signature": [
{
"pluginId": "kibanaUtils",
@ -736,8 +818,12 @@
"type": "Object",
"tags": [],
"label": "savedSearchState",
"description": ["\nState of saved search, the saved object of Discover"],
"signature": ["DiscoverSavedSearchContainer"],
"description": [
"\nState of saved search, the saved object of Discover"
],
"signature": [
"DiscoverSavedSearchContainer"
],
"path": "src/plugins/discover/public/application/main/services/discover_state.ts",
"deprecated": false,
"trackAdoption": false
@ -748,7 +834,9 @@
"type": "Object",
"tags": [],
"label": "stateStorage",
"description": ["\nState of url, allows updating and subscribing to url changes"],
"description": [
"\nState of url, allows updating and subscribing to url changes"
],
"signature": [
{
"pluginId": "kibanaUtils",
@ -768,8 +856,12 @@
"type": "Object",
"tags": [],
"label": "searchSessionManager",
"description": ["\nService for handling search sessions"],
"signature": ["DiscoverSearchSessionManager"],
"description": [
"\nService for handling search sessions"
],
"signature": [
"DiscoverSearchSessionManager"
],
"path": "src/plugins/discover/public/application/main/services/discover_state.ts",
"deprecated": false,
"trackAdoption": false
@ -780,8 +872,12 @@
"type": "Object",
"tags": [],
"label": "customizationContext",
"description": ["\nContext object for customization related properties"],
"signature": ["DiscoverCustomizationContext"],
"description": [
"\nContext object for customization related properties"
],
"signature": [
"DiscoverCustomizationContext"
],
"path": "src/plugins/discover/public/application/main/services/discover_state.ts",
"deprecated": false,
"trackAdoption": false
@ -792,7 +888,9 @@
"type": "Object",
"tags": [],
"label": "actions",
"description": ["\nComplex functions to update multiple containers from UI"],
"description": [
"\nComplex functions to update multiple containers from UI"
],
"signature": [
"{ fetchData: (initial?: boolean | undefined) => void; initializeAndSync: () => () => void; loadDataViewList: () => Promise<void>; loadSavedSearch: (param?: ",
"LoadParams",
@ -935,7 +1033,9 @@
"tags": [],
"label": "doc",
"description": [],
"signature": ["DataTableRecord"],
"signature": [
"DataTableRecord"
],
"path": "src/plugins/discover/public/customizations/customization_types/flyout_customization.ts",
"deprecated": false,
"trackAdoption": false
@ -947,7 +1047,9 @@
"tags": [],
"label": "renderDefaultContent",
"description": [],
"signature": ["() => React.ReactNode"],
"signature": [
"() => React.ReactNode"
],
"path": "src/plugins/discover/public/customizations/customization_types/flyout_customization.ts",
"deprecated": false,
"trackAdoption": false,
@ -975,7 +1077,9 @@
"tags": [],
"label": "id",
"description": [],
"signature": ["\"flyout\""],
"signature": [
"\"flyout\""
],
"path": "src/plugins/discover/public/customizations/customization_types/flyout_customization.ts",
"deprecated": false,
"trackAdoption": false
@ -987,7 +1091,10 @@
"tags": [],
"label": "size",
"description": [],
"signature": ["Property", ".Width<string | number> | undefined"],
"signature": [
"Property",
".Width<string | number> | undefined"
],
"path": "src/plugins/discover/public/customizations/customization_types/flyout_customization.ts",
"deprecated": false,
"trackAdoption": false
@ -999,7 +1106,9 @@
"tags": [],
"label": "title",
"description": [],
"signature": ["string | undefined"],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/customizations/customization_types/flyout_customization.ts",
"deprecated": false,
"trackAdoption": false
@ -1154,7 +1263,9 @@
"tags": [],
"label": "hasTimeRange",
"description": [],
"signature": ["() => boolean"],
"signature": [
"() => boolean"
],
"path": "src/plugins/discover/public/embeddable/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1204,7 +1315,9 @@
"tags": [],
"label": "selectedTab",
"description": [],
"signature": ["\"discover\" | \"logs-explorer\""],
"signature": [
"\"discover\" | \"logs-explorer\""
],
"path": "src/plugins/discover/public/components/logs_explorer_tabs/logs_explorer_tabs.tsx",
"deprecated": false,
"trackAdoption": false
@ -1230,7 +1343,9 @@
"tags": [],
"label": "id",
"description": [],
"signature": ["\"search_bar\""],
"signature": [
"\"search_bar\""
],
"path": "src/plugins/discover/public/customizations/customization_types/search_bar_customization.ts",
"deprecated": false,
"trackAdoption": false
@ -1242,7 +1357,9 @@
"tags": [],
"label": "CustomDataViewPicker",
"description": [],
"signature": ["React.ComponentType<{}> | undefined"],
"signature": [
"React.ComponentType<{}> | undefined"
],
"path": "src/plugins/discover/public/customizations/customization_types/search_bar_customization.ts",
"deprecated": false,
"trackAdoption": false
@ -1254,7 +1371,9 @@
"tags": [],
"label": "PrependFilterBar",
"description": [],
"signature": ["React.ComponentType<{}> | undefined"],
"signature": [
"React.ComponentType<{}> | undefined"
],
"path": "src/plugins/discover/public/customizations/customization_types/search_bar_customization.ts",
"deprecated": false,
"trackAdoption": false
@ -1296,7 +1415,9 @@
"tags": [],
"label": "hideDataViewPicker",
"description": [],
"signature": ["boolean | undefined"],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/public/customizations/customization_types/search_bar_customization.ts",
"deprecated": false,
"trackAdoption": false
@ -1322,7 +1443,9 @@
"tags": [],
"label": "id",
"description": [],
"signature": ["\"top_nav\""],
"signature": [
"\"top_nav\""
],
"path": "src/plugins/discover/public/customizations/customization_types/top_nav_customization.ts",
"deprecated": false,
"trackAdoption": false
@ -1334,7 +1457,10 @@
"tags": [],
"label": "defaultMenu",
"description": [],
"signature": ["TopNavDefaultMenu", " | undefined"],
"signature": [
"TopNavDefaultMenu",
" | undefined"
],
"path": "src/plugins/discover/public/customizations/customization_types/top_nav_customization.ts",
"deprecated": false,
"trackAdoption": false
@ -1346,7 +1472,11 @@
"tags": [],
"label": "getMenuItems",
"description": [],
"signature": ["(() => ", "TopNavMenuItem", "[]) | undefined"],
"signature": [
"(() => ",
"TopNavMenuItem",
"[]) | undefined"
],
"path": "src/plugins/discover/public/customizations/customization_types/top_nav_customization.ts",
"deprecated": false,
"trackAdoption": false,
@ -1360,7 +1490,10 @@
"tags": [],
"label": "defaultBadges",
"description": [],
"signature": ["TopNavDefaultBadges", " | undefined"],
"signature": [
"TopNavDefaultBadges",
" | undefined"
],
"path": "src/plugins/discover/public/customizations/customization_types/top_nav_customization.ts",
"deprecated": false,
"trackAdoption": false
@ -1372,7 +1505,11 @@
"tags": [],
"label": "getBadges",
"description": [],
"signature": ["(() => ", "TopNavBadge", "[]) | undefined"],
"signature": [
"(() => ",
"TopNavBadge",
"[]) | undefined"
],
"path": "src/plugins/discover/public/customizations/customization_types/top_nav_customization.ts",
"deprecated": false,
"trackAdoption": false,
@ -1409,7 +1546,9 @@
"tags": [],
"label": "options",
"description": [],
"signature": ["CustomizationCallbackContext"],
"signature": [
"CustomizationCallbackContext"
],
"path": "src/plugins/discover/public/customizations/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1512,7 +1651,9 @@
"tags": [],
"label": "DiscoverProfileId",
"description": [],
"signature": ["string"],
"signature": [
"string"
],
"path": "src/plugins/discover/public/customizations/types.ts",
"deprecated": false,
"trackAdoption": false,
@ -1582,7 +1723,9 @@
"tags": [],
"label": "SEARCH_EMBEDDABLE_CELL_ACTIONS_TRIGGER_ID",
"description": [],
"signature": ["\"SEARCH_EMBEDDABLE_CELL_ACTIONS_TRIGGER_ID\""],
"signature": [
"\"SEARCH_EMBEDDABLE_CELL_ACTIONS_TRIGGER_ID\""
],
"path": "src/plugins/discover/public/embeddable/constants.ts",
"deprecated": false,
"trackAdoption": false,
@ -1595,7 +1738,9 @@
"tags": [],
"label": "SEARCH_EMBEDDABLE_TYPE",
"description": [],
"signature": ["\"search\""],
"signature": [
"\"search\""
],
"path": "packages/kbn-discover-utils/src/constants.ts",
"deprecated": false,
"trackAdoption": false,
@ -1696,7 +1841,9 @@
"tags": [],
"label": "showLogsExplorerTabs",
"description": [],
"signature": ["() => void"],
"signature": [
"() => void"
],
"path": "src/plugins/discover/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
@ -2296,7 +2443,9 @@
"tags": [],
"label": "id",
"description": [],
"signature": ["\"DISCOVER_APP_LOCATOR\""],
"signature": [
"\"DISCOVER_APP_LOCATOR\""
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2308,7 +2457,9 @@
"tags": [],
"label": "Constructor",
"description": [],
"signature": ["any"],
"signature": [
"any"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
@ -2320,7 +2471,9 @@
"tags": [],
"label": "deps",
"description": [],
"signature": ["DiscoverAppLocatorDependencies"],
"signature": [
"DiscoverAppLocatorDependencies"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
@ -2430,7 +2583,9 @@
"tags": [],
"label": "id",
"description": [],
"signature": ["\"DISCOVER_ESQL_LOCATOR\""],
"signature": [
"\"DISCOVER_ESQL_LOCATOR\""
],
"path": "src/plugins/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2442,7 +2597,9 @@
"tags": [],
"label": "Constructor",
"description": [],
"signature": ["any"],
"signature": [
"any"
],
"path": "src/plugins/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false,
@ -2454,7 +2611,9 @@
"tags": [],
"label": "deps",
"description": [],
"signature": ["DiscoverESQLLocatorDependencies"],
"signature": [
"DiscoverESQLLocatorDependencies"
],
"path": "src/plugins/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false,
@ -2470,7 +2629,11 @@
"tags": [],
"label": "getLocation",
"description": [],
"signature": ["() => Promise<", "KibanaLocation", "<object>>"],
"signature": [
"() => Promise<",
"KibanaLocation",
"<object>>"
],
"path": "src/plugins/discover/common/esql_locator.ts",
"deprecated": false,
"trackAdoption": false,
@ -2517,8 +2680,12 @@
"type": "string",
"tags": [],
"label": "savedSearchId",
"description": ["\nOptionally set saved search ID."],
"signature": ["string | undefined"],
"description": [
"\nOptionally set saved search ID."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2529,8 +2696,12 @@
"type": "string",
"tags": [],
"label": "dataViewId",
"description": ["\nOptionally set index pattern / data view ID."],
"signature": ["string | undefined"],
"description": [
"\nOptionally set index pattern / data view ID."
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2539,10 +2710,16 @@
"parentPluginId": "discover",
"id": "def-common.DiscoverAppLocatorParams.indexPatternId",
"type": "string",
"tags": ["deprecated"],
"tags": [
"deprecated"
],
"label": "indexPatternId",
"description": ["\nDuplication of dataViewId"],
"signature": ["string | undefined"],
"description": [
"\nDuplication of dataViewId"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": true,
"trackAdoption": false,
@ -2620,7 +2797,9 @@
"type": "Object",
"tags": [],
"label": "timeRange",
"description": ["\nOptionally set the time range in the time picker."],
"description": [
"\nOptionally set the time range in the time picker."
],
"signature": [
{
"pluginId": "@kbn/es-query",
@ -2641,7 +2820,9 @@
"type": "CompoundType",
"tags": [],
"label": "refreshInterval",
"description": ["\nOptionally set the refresh interval."],
"description": [
"\nOptionally set the refresh interval."
],
"signature": [
"(",
{
@ -2671,7 +2852,9 @@
"type": "Array",
"tags": [],
"label": "filters",
"description": ["\nOptionally apply filters."],
"description": [
"\nOptionally apply filters."
],
"signature": [
{
"pluginId": "@kbn/es-query",
@ -2692,7 +2875,9 @@
"type": "CompoundType",
"tags": [],
"label": "query",
"description": ["\nOptionally set a query."],
"description": [
"\nOptionally set a query."
],
"signature": [
{
"pluginId": "@kbn/es-query",
@ -2724,7 +2909,9 @@
"description": [
"\nIf not given, will use the uiSettings configuration for `storeInSessionStorage`. useHash determines\nwhether to hash the data in the url to avoid url length issues."
],
"signature": ["boolean | undefined"],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2735,8 +2922,12 @@
"type": "string",
"tags": [],
"label": "searchSessionId",
"description": ["\nBackground search session id"],
"signature": ["string | undefined"],
"description": [
"\nBackground search session id"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2747,8 +2938,12 @@
"type": "Array",
"tags": [],
"label": "columns",
"description": ["\nColumns displayed in the table"],
"signature": ["string[] | undefined"],
"description": [
"\nColumns displayed in the table"
],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2759,7 +2954,9 @@
"type": "Object",
"tags": [],
"label": "grid",
"description": ["\nData Grid related state"],
"description": [
"\nData Grid related state"
],
"signature": [
{
"pluginId": "savedSearch",
@ -2780,8 +2977,12 @@
"type": "string",
"tags": [],
"label": "interval",
"description": ["\nUsed interval of the histogram"],
"signature": ["string | undefined"],
"description": [
"\nUsed interval of the histogram"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2792,8 +2993,12 @@
"type": "Array",
"tags": [],
"label": "sort",
"description": ["\nArray of the used sorting [[field,direction],...]"],
"signature": ["string[][] | undefined"],
"description": [
"\nArray of the used sorting [[field,direction],...]"
],
"signature": [
"string[][] | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2804,8 +3009,12 @@
"type": "string",
"tags": [],
"label": "savedQuery",
"description": ["\nid of the used saved query"],
"signature": ["string | undefined"],
"description": [
"\nid of the used saved query"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2816,8 +3025,13 @@
"type": "CompoundType",
"tags": [],
"label": "viewMode",
"description": ["\nTable view: Documents vs Field Statistics"],
"signature": ["VIEW_MODE", " | undefined"],
"description": [
"\nTable view: Documents vs Field Statistics"
],
"signature": [
"VIEW_MODE",
" | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2831,7 +3045,9 @@
"description": [
"\nHide mini distribution/preview charts when in Field Statistics mode"
],
"signature": ["boolean | undefined"],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2842,8 +3058,12 @@
"type": "string",
"tags": [],
"label": "breakdownField",
"description": ["\nBreakdown field"],
"signature": ["string | undefined"],
"description": [
"\nBreakdown field"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2854,8 +3074,12 @@
"type": "CompoundType",
"tags": [],
"label": "isAlertResults",
"description": ["\nUsed when navigating to particular alert results"],
"signature": ["boolean | undefined"],
"description": [
"\nUsed when navigating to particular alert results"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2866,8 +3090,12 @@
"type": "string",
"tags": [],
"label": "profile",
"description": ["\nThe Discover profile to use"],
"signature": ["string | undefined"],
"description": [
"\nThe Discover profile to use"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2916,7 +3144,9 @@
"tags": [],
"label": "isAlertResults",
"description": [],
"signature": ["boolean | undefined"],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false
@ -2934,7 +3164,9 @@
"tags": [],
"label": "APP_ICON",
"description": [],
"signature": ["\"discoverApp\""],
"signature": [
"\"discoverApp\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
@ -2947,7 +3179,9 @@
"tags": [],
"label": "DISCOVER_APP_LOCATOR",
"description": [],
"signature": ["\"DISCOVER_APP_LOCATOR\""],
"signature": [
"\"DISCOVER_APP_LOCATOR\""
],
"path": "src/plugins/discover/common/app_locator.ts",
"deprecated": false,
"trackAdoption": false,
@ -3041,7 +3275,9 @@
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": ["\"discover\""],
"signature": [
"\"discover\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
@ -3050,4 +3286,4 @@
],
"objects": []
}
}
}

2
api_docs/discover.mdx
View file

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

2
api_docs/discover_enhanced.mdx
View file

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

2
api_docs/embeddable.mdx
View file

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

2
api_docs/embeddable_enhanced.mdx
View file

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

4
api_docs/event_annotation.devdocs.json
View file

@ -1911,7 +1911,7 @@
"label": "options",
"description": [],
"signature": [
"(\"alert\" | \"tag\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"circle\" | \"triangle\")[]"
"(\"alert\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"circle\" | \"triangle\")[]"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false,
@ -3033,7 +3033,7 @@
"label": "options",
"description": [],
"signature": [
"(\"alert\" | \"tag\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"circle\" | \"triangle\")[]"
"(\"alert\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"circle\" | \"triangle\")[]"
],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.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-22
date: 2024-02-23
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-22
date: 2024-02-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotationListing']
---
import eventAnnotationListingObj from './event_annotation_listing.devdocs.json';

6
api_docs/event_log.devdocs.json
View file

@ -1450,7 +1450,7 @@
"label": "data",
"description": [],
"signature": [
"(Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; license?: string | undefined; uuid?: string | undefined; version?: string | undefined; category?: string | undefined; description?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_delayed_alerts?: string | number | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; version?: string | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; outcome?: string | undefined; category?: string[] | undefined; duration?: string | number | undefined; timezone?: string | undefined; risk_score?: number | undefined; severity?: string | number | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; code?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]"
"(Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; license?: string | undefined; uuid?: string | undefined; version?: string | undefined; category?: string | undefined; description?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_delayed_alerts?: string | number | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; version?: string | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; outcome?: string | undefined; category?: string[] | undefined; duration?: string | number | undefined; timezone?: string | undefined; risk_score?: number | undefined; severity?: string | number | undefined; code?: string | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]"
],
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"deprecated": false,
@ -1470,7 +1470,7 @@
"label": "IEvent",
"description": [],
"signature": [
"DeepPartial<DeepWriteable<Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; license?: string | undefined; uuid?: string | undefined; version?: string | undefined; category?: string | undefined; description?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_delayed_alerts?: string | number | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; version?: string | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; outcome?: string | undefined; category?: string[] | undefined; duration?: string | number | undefined; timezone?: string | undefined; risk_score?: number | undefined; severity?: string | number | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; code?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
"DeepPartial<DeepWriteable<Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; license?: string | undefined; uuid?: string | undefined; version?: string | undefined; category?: string | undefined; description?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_delayed_alerts?: string | number | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; version?: string | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; outcome?: string | undefined; category?: string[] | undefined; duration?: string | number | undefined; timezone?: string | undefined; risk_score?: number | undefined; severity?: string | number | undefined; code?: string | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
],
"path": "x-pack/plugins/event_log/generated/schemas.ts",
"deprecated": false,
@ -1485,7 +1485,7 @@
"label": "IValidatedEvent",
"description": [],
"signature": [
"Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; license?: string | undefined; uuid?: string | undefined; version?: string | undefined; category?: string | undefined; description?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_delayed_alerts?: string | number | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; version?: string | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; outcome?: string | undefined; category?: string[] | undefined; duration?: string | number | undefined; timezone?: string | undefined; risk_score?: number | undefined; severity?: string | number | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; code?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}> | undefined"
"Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; license?: string | undefined; uuid?: string | undefined; version?: string | undefined; category?: string | undefined; description?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ source?: string | undefined; uuid?: string | undefined; gen_ai?: Readonly<{ usage?: Readonly<{ prompt_tokens?: string | number | undefined; completion_tokens?: string | number | undefined; total_tokens?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; revision?: string | number | undefined; execution?: Readonly<{ uuid?: string | undefined; status?: string | undefined; metrics?: Readonly<{ total_search_duration_ms?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_delayed_alerts?: string | number | undefined; number_of_searches?: string | number | undefined; es_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; persist_alerts_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; uuid?: string | undefined; flapping?: boolean | undefined; maintenance_window_ids?: string[] | undefined; } & {}> | undefined; version?: string | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; outcome?: string | undefined; category?: string[] | undefined; duration?: string | number | undefined; timezone?: string | undefined; risk_score?: number | undefined; severity?: string | number | undefined; code?: string | undefined; url?: string | undefined; created?: string | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; user?: Readonly<{ id?: string | undefined; name?: string | undefined; } & {}> | undefined; } & {}> | undefined"
],
"path": "x-pack/plugins/event_log/generated/schemas.ts",
"deprecated": false,

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

278
api_docs/exploratory_view.devdocs.json
View file

@ -82,7 +82,9 @@
"tags": [],
"label": "baseHref",
"description": [],
"signature": ["string"],
"signature": [
"string"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/configurations/exploratory_view_url.ts",
"deprecated": false,
"trackAdoption": false,
@ -99,7 +101,11 @@
"tags": [],
"label": "ExploratoryView",
"description": [],
"signature": ["(props: ", "ExploratoryViewPageProps", ") => JSX.Element"],
"signature": [
"(props: ",
"ExploratoryViewPageProps",
") => JSX.Element"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/index.tsx",
"deprecated": false,
"trackAdoption": false,
@ -111,7 +117,9 @@
"tags": [],
"label": "props",
"description": [],
"signature": ["ExploratoryViewPageProps"],
"signature": [
"ExploratoryViewPageProps"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/index.tsx",
"deprecated": false,
"trackAdoption": false,
@ -128,7 +136,11 @@
"tags": [],
"label": "FilterValueLabel",
"description": [],
"signature": ["(props: ", "FilterValueLabelProps", ") => JSX.Element"],
"signature": [
"(props: ",
"FilterValueLabelProps",
") => JSX.Element"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/index.tsx",
"deprecated": false,
"trackAdoption": false,
@ -140,7 +152,9 @@
"tags": [],
"label": "props",
"description": [],
"signature": ["FilterValueLabelProps"],
"signature": [
"FilterValueLabelProps"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/index.tsx",
"deprecated": false,
"trackAdoption": false,
@ -157,7 +171,9 @@
"tags": [],
"label": "fromQuery",
"description": [],
"signature": ["(query: Record<string, any>) => string"],
"signature": [
"(query: Record<string, any>) => string"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/utils/url.ts",
"deprecated": false,
"trackAdoption": false,
@ -169,7 +185,9 @@
"tags": [],
"label": "query",
"description": [],
"signature": ["Record<string, any>"],
"signature": [
"Record<string, any>"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/utils/url.ts",
"deprecated": false,
"trackAdoption": false,
@ -186,7 +204,11 @@
"tags": [],
"label": "SelectableUrlList",
"description": [],
"signature": ["(props: ", "SelectableUrlListProps", ") => JSX.Element"],
"signature": [
"(props: ",
"SelectableUrlListProps",
") => JSX.Element"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/index.tsx",
"deprecated": false,
"trackAdoption": false,
@ -198,7 +220,9 @@
"tags": [],
"label": "props",
"description": [],
"signature": ["SelectableUrlListProps"],
"signature": [
"SelectableUrlListProps"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/index.tsx",
"deprecated": false,
"trackAdoption": false,
@ -215,7 +239,11 @@
"tags": [],
"label": "toQuery",
"description": [],
"signature": ["(search: string | undefined) => ", "ParsedQuery", "<string>"],
"signature": [
"(search: string | undefined) => ",
"ParsedQuery",
"<string>"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/utils/url.ts",
"deprecated": false,
"trackAdoption": false,
@ -227,7 +255,9 @@
"tags": [],
"label": "search",
"description": [],
"signature": ["string | undefined"],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/utils/url.ts",
"deprecated": false,
"trackAdoption": false,
@ -299,7 +329,9 @@
"tags": [],
"label": "spaceId",
"description": [],
"signature": ["string | undefined"],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -325,7 +357,9 @@
"tags": [],
"label": "id",
"description": [],
"signature": ["string | undefined"],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -337,7 +371,9 @@
"tags": [],
"label": "appendTitle",
"description": [],
"signature": ["JSX.Element | undefined"],
"signature": [
"JSX.Element | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -412,7 +448,9 @@
"tags": [],
"label": "customHeight",
"description": [],
"signature": ["string | undefined"],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -424,7 +462,9 @@
"tags": [],
"label": "customTimeRange",
"description": [],
"signature": ["{ from: string; to: string; } | undefined"],
"signature": [
"{ from: string; to: string; } | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -436,7 +476,11 @@
"tags": [],
"label": "dataTypesIndexPatterns",
"description": [],
"signature": ["Partial<Record<", "AppDataType", ", string>> | undefined"],
"signature": [
"Partial<Record<",
"AppDataType",
", string>> | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -448,7 +492,9 @@
"tags": [],
"label": "isSingleMetric",
"description": [],
"signature": ["boolean | undefined"],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -460,7 +506,9 @@
"tags": [],
"label": "legendIsVisible",
"description": [],
"signature": ["boolean | undefined"],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -472,7 +520,10 @@
"tags": [],
"label": "legendPosition",
"description": [],
"signature": ["Position", " | undefined"],
"signature": [
"Position",
" | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -484,7 +535,9 @@
"tags": [],
"label": "hideTicks",
"description": [],
"signature": ["boolean | undefined"],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -496,7 +549,9 @@
"tags": [],
"label": "onBrushEnd",
"description": [],
"signature": ["((param: { range: number[]; }) => void) | undefined"],
"signature": [
"((param: { range: number[]; }) => void) | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
@ -519,7 +574,9 @@
"tags": [],
"label": "range",
"description": [],
"signature": ["number[]"],
"signature": [
"number[]"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -536,7 +593,9 @@
"tags": [],
"label": "onLoad",
"description": [],
"signature": ["((loading: boolean) => void) | undefined"],
"signature": [
"((loading: boolean) => void) | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
@ -548,7 +607,9 @@
"tags": [],
"label": "loading",
"description": [],
"signature": ["boolean"],
"signature": [
"boolean"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false,
@ -564,7 +625,9 @@
"tags": [],
"label": "caseOwner",
"description": [],
"signature": ["string | undefined"],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -576,7 +639,10 @@
"tags": [],
"label": "reportConfigMap",
"description": [],
"signature": ["ReportConfigMap", " | undefined"],
"signature": [
"ReportConfigMap",
" | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -602,7 +668,9 @@
"tags": [],
"label": "showCalculationMethod",
"description": [],
"signature": ["boolean | undefined"],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -614,7 +682,9 @@
"tags": [],
"label": "title",
"description": [],
"signature": ["string | JSX.Element | undefined"],
"signature": [
"string | JSX.Element | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -626,7 +696,11 @@
"tags": [],
"label": "withActions",
"description": [],
"signature": ["boolean | ", "ActionTypes", "[] | undefined"],
"signature": [
"boolean | ",
"ActionTypes",
"[] | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -638,7 +712,9 @@
"tags": [],
"label": "align",
"description": [],
"signature": ["\"right\" | \"left\" | \"center\" | undefined"],
"signature": [
"\"right\" | \"left\" | \"center\" | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -650,7 +726,9 @@
"tags": [],
"label": "sparklineMode",
"description": [],
"signature": ["boolean | undefined"],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -662,7 +740,9 @@
"tags": [],
"label": "noLabel",
"description": [],
"signature": ["boolean | undefined"],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -674,7 +754,9 @@
"tags": [],
"label": "fontSize",
"description": [],
"signature": ["number | undefined"],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -686,7 +768,9 @@
"tags": [],
"label": "lineHeight",
"description": [],
"signature": ["number | undefined"],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -698,7 +782,9 @@
"tags": [],
"label": "dataTestSubj",
"description": [],
"signature": ["string | undefined"],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -710,7 +796,9 @@
"tags": [],
"label": "searchSessionId",
"description": [],
"signature": ["string | undefined"],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/embeddable/embeddable.tsx",
"deprecated": false,
"trackAdoption": false
@ -1345,7 +1433,9 @@
"tags": [],
"label": "breakdownFields",
"description": [],
"signature": ["string[]"],
"signature": [
"string[]"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1482,7 +1572,9 @@
"tags": [],
"label": "textDefinitionFields",
"description": [],
"signature": ["string[] | undefined"],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1512,7 +1604,9 @@
"tags": [],
"label": "labels",
"description": [],
"signature": ["{ [x: string]: string; }"],
"signature": [
"{ [x: string]: string; }"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1556,7 +1650,9 @@
"tags": [],
"label": "yTitle",
"description": [],
"signature": ["string | undefined"],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1589,7 +1685,9 @@
"tags": [],
"label": "query",
"description": [],
"signature": ["{ query: string; language: \"kuery\"; } | undefined"],
"signature": [
"{ query: string; language: \"kuery\"; } | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1626,7 +1724,9 @@
"tags": [],
"label": "time",
"description": [],
"signature": ["{ to: string; from: string; }"],
"signature": [
"{ to: string; from: string; }"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1638,7 +1738,9 @@
"tags": [],
"label": "breakdown",
"description": [],
"signature": ["string | undefined"],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1692,7 +1794,9 @@
"tags": [],
"label": "operationType",
"description": [],
"signature": ["string | undefined"],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1718,7 +1822,10 @@
"tags": [],
"label": "reportDefinitions",
"description": [],
"signature": ["URLReportDefinition", " | undefined"],
"signature": [
"URLReportDefinition",
" | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1730,7 +1837,10 @@
"tags": [],
"label": "textReportDefinitions",
"description": [],
"signature": ["URLTextReportDefinition", " | undefined"],
"signature": [
"URLTextReportDefinition",
" | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1742,7 +1852,9 @@
"tags": [],
"label": "selectedMetricField",
"description": [],
"signature": ["string | undefined"],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1754,7 +1866,9 @@
"tags": [],
"label": "hidden",
"description": [],
"signature": ["boolean | undefined"],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1766,7 +1880,9 @@
"tags": [],
"label": "showPercentileAnnotations",
"description": [],
"signature": ["boolean | undefined"],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1778,7 +1894,9 @@
"tags": [],
"label": "color",
"description": [],
"signature": ["string | undefined"],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1815,7 +1933,9 @@
"tags": [],
"label": "values",
"description": [],
"signature": ["(string | number)[] | undefined"],
"signature": [
"(string | number)[] | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1827,7 +1947,9 @@
"tags": [],
"label": "notValues",
"description": [],
"signature": ["(string | number)[] | undefined"],
"signature": [
"(string | number)[] | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1839,7 +1961,9 @@
"tags": [],
"label": "wildcards",
"description": [],
"signature": ["string[] | undefined"],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1851,7 +1975,9 @@
"tags": [],
"label": "notWildcards",
"description": [],
"signature": ["string[] | undefined"],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/types.ts",
"deprecated": false,
"trackAdoption": false
@ -1882,7 +2008,9 @@
"tags": [],
"label": "ALL_VALUES_SELECTED",
"description": [],
"signature": ["\"ALL_VALUES\""],
"signature": [
"\"ALL_VALUES\""
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/configurations/constants/url_constants.ts",
"deprecated": false,
"trackAdoption": false,
@ -1917,7 +2045,9 @@
"tags": [],
"label": "APP_ROUTE",
"description": [],
"signature": ["\"/app/exploratory-view\""],
"signature": [
"\"/app/exploratory-view\""
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/constants.ts",
"deprecated": false,
"trackAdoption": false,
@ -1930,7 +2060,9 @@
"tags": [],
"label": "ENVIRONMENT_ALL",
"description": [],
"signature": ["\"ENVIRONMENT_ALL\""],
"signature": [
"\"ENVIRONMENT_ALL\""
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/configurations/constants/constants.ts",
"deprecated": false,
"trackAdoption": false,
@ -1943,7 +2075,9 @@
"tags": [],
"label": "FILTER_RECORDS",
"description": [],
"signature": ["\"FILTER_RECORDS\""],
"signature": [
"\"FILTER_RECORDS\""
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/configurations/constants/constants.ts",
"deprecated": false,
"trackAdoption": false,
@ -1956,7 +2090,9 @@
"tags": [],
"label": "OPERATION_COLUMN",
"description": [],
"signature": ["\"operation\""],
"signature": [
"\"operation\""
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/configurations/constants/constants.ts",
"deprecated": false,
"trackAdoption": false,
@ -1969,7 +2105,9 @@
"tags": [],
"label": "RECORDS_FIELD",
"description": [],
"signature": ["\"___records___\""],
"signature": [
"\"___records___\""
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/configurations/constants/constants.ts",
"deprecated": false,
"trackAdoption": false,
@ -1982,7 +2120,9 @@
"tags": [],
"label": "RECORDS_PERCENTAGE_FIELD",
"description": [],
"signature": ["\"RecordsPercentage\""],
"signature": [
"\"RecordsPercentage\""
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/configurations/constants/constants.ts",
"deprecated": false,
"trackAdoption": false,
@ -1995,7 +2135,9 @@
"tags": [],
"label": "REPORT_METRIC_FIELD",
"description": [],
"signature": ["\"REPORT_METRIC_FIELD\""],
"signature": [
"\"REPORT_METRIC_FIELD\""
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/configurations/constants/constants.ts",
"deprecated": false,
"trackAdoption": false,
@ -2008,7 +2150,9 @@
"tags": [],
"label": "TERMS_COLUMN",
"description": [],
"signature": ["\"TERMS_COLUMN\""],
"signature": [
"\"TERMS_COLUMN\""
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/configurations/constants/constants.ts",
"deprecated": false,
"trackAdoption": false,
@ -2021,7 +2165,9 @@
"tags": [],
"label": "USE_BREAK_DOWN_COLUMN",
"description": [],
"signature": ["\"USE_BREAK_DOWN_COLUMN\""],
"signature": [
"\"USE_BREAK_DOWN_COLUMN\""
],
"path": "x-pack/plugins/observability_solution/exploratory_view/public/components/shared/exploratory_view/configurations/constants/constants.ts",
"deprecated": false,
"trackAdoption": false,
@ -2110,4 +2256,4 @@
"misc": [],
"objects": []
}
}
}

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

2
api_docs/expression_metric_vis.devdocs.json
View file

@ -1014,7 +1014,7 @@
"label": "AvailableMetricIcon",
"description": [],
"signature": [
"\"alert\" | \"tag\" | \"temperature\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"compute\" | \"editorComment\" | \"empty\" | \"flag\" | \"globe\" | \"heart\" | \"mapMarker\" | \"pin\" | \"sortDown\" | \"sortUp\" | \"starEmpty\""
"\"alert\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"compute\" | \"editorComment\" | \"empty\" | \"flag\" | \"globe\" | \"heart\" | \"mapMarker\" | \"pin\" | \"sortDown\" | \"sortUp\" | \"starEmpty\" | \"tag\" | \"temperature\""
],
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
"deprecated": false,

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

2
api_docs/expression_x_y.devdocs.json
View file

@ -2264,7 +2264,7 @@
"label": "AvailableReferenceLineIcon",
"description": [],
"signature": [
"\"alert\" | \"tag\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"empty\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"circle\" | \"triangle\""
"\"alert\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"empty\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"circle\" | \"triangle\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,

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

2
api_docs/expressions.mdx
View file

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

2
api_docs/features.mdx
View file

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

8
api_docs/fleet.devdocs.json
View file

@ -22645,7 +22645,7 @@
"label": "release",
"description": [],
"signature": [
"\"experimental\" | \"beta\" | \"ga\" | undefined"
"\"beta\" | \"experimental\" | \"ga\" | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"deprecated": false,
@ -23057,7 +23057,7 @@
"label": "[RegistryDataStreamKeys.release]",
"description": [],
"signature": [
"\"experimental\" | \"beta\" | \"ga\""
"\"beta\" | \"experimental\" | \"ga\""
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
@ -25727,7 +25727,7 @@
"label": "RegistrySearchResult",
"description": [],
"signature": [
"{ type?: \"input\" | \"integration\" | undefined; name: string; title: string; version: string; description: string; path: string; download: string; internal?: boolean | undefined; icons?: (",
"{ type?: \"input\" | \"integration\" | undefined; name: string; title: string; version: string; description: string; download: string; path: string; internal?: boolean | undefined; icons?: (",
{
"pluginId": "fleet",
"scope": "common",
@ -25751,7 +25751,7 @@
"section": "def-common.PackageSpecCategory",
"text": "PackageSpecCategory"
},
" | undefined)[] | undefined; release?: \"experimental\" | \"beta\" | \"ga\" | undefined; policy_templates?: ",
" | undefined)[] | undefined; release?: \"beta\" | \"experimental\" | \"ga\" | undefined; policy_templates?: ",
{
"pluginId": "fleet",
"scope": "common",

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-22
date: 2024-02-23
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-22
date: 2024-02-23
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-22
date: 2024-02-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
---
import guidedOnboardingObj from './guided_onboarding.devdocs.json';

6
api_docs/home.devdocs.json
View file

@ -1839,7 +1839,7 @@
"label": "ArtifactsSchema",
"description": [],
"signature": [
"{ readonly application?: Readonly<{} & { path: string; label: string; }> | undefined; readonly exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; readonly dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }"
"{ readonly application?: Readonly<{} & { label: string; path: string; }> | undefined; readonly exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; readonly dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }"
],
"path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts",
"deprecated": false,
@ -2013,7 +2013,7 @@
"section": "def-server.TutorialContext",
"text": "TutorialContext"
},
") => Readonly<{ savedObjects?: any[] | undefined; euiIconType?: string | undefined; isBeta?: boolean | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { id: string; name: string; category: \"security\" | \"metrics\" | \"other\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>"
") => Readonly<{ savedObjects?: any[] | undefined; euiIconType?: string | undefined; isBeta?: boolean | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { id: string; name: string; category: \"security\" | \"metrics\" | \"other\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>"
],
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
"deprecated": false,
@ -2051,7 +2051,7 @@
"label": "TutorialSchema",
"description": [],
"signature": [
"{ readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly isBeta?: boolean | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly id: string; readonly name: string; readonly category: \"security\" | \"metrics\" | \"other\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }"
"{ readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly isBeta?: boolean | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly id: string; readonly name: string; readonly category: \"security\" | \"metrics\" | \"other\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; text?: string | undefined; title?: string | undefined; success?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { index: string | string[]; query: Record<string, any>; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; textPre?: string | undefined; commands?: string[] | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }"
],
"path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts",
"deprecated": false,

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

2
api_docs/index_management.devdocs.json
View file

@ -892,7 +892,7 @@
"label": "IndexManagementConfig",
"description": [],
"signature": [
"{ readonly ui: Readonly<{} & { enabled: boolean; }>; readonly enableIndexActions: boolean; readonly enableLegacyTemplates: boolean; readonly dev: Readonly<{} & { enableIndexDetailsPage: boolean; }>; readonly enableIndexStats: boolean; readonly editableIndexSettings: \"all\" | \"limited\"; readonly enableDataStreamsStorageColumn: boolean; }"
"{ readonly dev: Readonly<{} & { enableIndexDetailsPage: boolean; }>; readonly ui: Readonly<{} & { enabled: boolean; }>; readonly enableIndexActions: boolean; readonly enableLegacyTemplates: boolean; readonly enableIndexStats: boolean; readonly editableIndexSettings: \"all\" | \"limited\"; readonly enableDataStreamsStorageColumn: boolean; }"
],
"path": "x-pack/plugins/index_management/server/config.ts",
"deprecated": false,

2
api_docs/index_management.mdx
View file

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

111
api_docs/infra.devdocs.json
View file

@ -366,28 +366,119 @@
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
},
{
"parentPluginId": "infra",
"id": "def-server.InfraRequestHandlerContext",
"type": "Type",
"type": "Interface",
"tags": [],
"label": "InfraRequestHandlerContext",
"description": [],
"signature": [
"InfraMlRequestHandlerContext",
" & ",
"InfraSpacesRequestHandlerContext"
],
"path": "x-pack/plugins/infra/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "infra",
"id": "def-server.InfraRequestHandlerContext.mlAnomalyDetectors",
"type": "Object",
"tags": [],
"label": "mlAnomalyDetectors",
"description": [],
"signature": [
"{ jobs(jobId?: string | undefined): Promise<{ count: number; jobs: ",
"MlJob",
"[]; }>; jobStats(jobId?: string | undefined): Promise<{ count: number; jobs: ",
"MlJobStats",
"[]; }>; datafeeds(datafeedId?: string | undefined): Promise<{ count: number; datafeeds: ",
"MlDatafeed",
"[]; }>; datafeedStats(datafeedId?: string | undefined): Promise<{ count: number; datafeeds: ",
"MlDatafeedStats",
"[]; }>; } | undefined"
],
"path": "x-pack/plugins/infra/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "infra",
"id": "def-server.InfraRequestHandlerContext.mlSystem",
"type": "Object",
"tags": [],
"label": "mlSystem",
"description": [],
"signature": [
"{ mlCapabilities(): Promise<",
"MlCapabilitiesResponse",
">; mlInfo(): Promise<",
"MlInfoResponse",
">; mlAnomalySearch<T>(searchParams: any, jobIds: string[]): Promise<",
"SearchResponse",
"<T, Record<string, ",
"AggregationsAggregate",
">>>; } | undefined"
],
"path": "x-pack/plugins/infra/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "infra",
"id": "def-server.InfraRequestHandlerContext.spaceId",
"type": "string",
"tags": [],
"label": "spaceId",
"description": [],
"path": "x-pack/plugins/infra/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "infra",
"id": "def-server.InfraRequestHandlerContext.savedObjectsClient",
"type": "Object",
"tags": [],
"label": "savedObjectsClient",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-common.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
}
],
"path": "x-pack/plugins/infra/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "infra",
"id": "def-server.InfraRequestHandlerContext.uiSettingsClient",
"type": "Object",
"tags": [],
"label": "uiSettingsClient",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-ui-settings-server",
"scope": "common",
"docId": "kibKbnCoreUiSettingsServerPluginApi",
"section": "def-common.IUiSettingsClient",
"text": "IUiSettingsClient"
}
],
"path": "x-pack/plugins/infra/server/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "infra",

7
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-22
date: 2024-02-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
---
import infraObj from './infra.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 32 | 0 | 29 | 8 |
| 37 | 0 | 34 | 6 |
## Client
@ -45,6 +45,3 @@ Contact [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux
### Interfaces
<DocDefinitionList data={infraObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={infraObj.server.misc}/>

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-22
date: 2024-02-23
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-22
date: 2024-02-23
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-22
date: 2024-02-23
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-22
date: 2024-02-23
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-22
date: 2024-02-23
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-22
date: 2024-02-23
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-22
date: 2024-02-23
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils']
---
import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json';

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