mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 09:48:58 -04:00
[api-docs] 2024-08-15 Daily api_docs build (#190576)
Generated by https://buildkite.com/elastic/kibana-api-docs-daily/builds/800
This commit is contained in:
parent
6738bdc12e
commit
bc88e54c16
738 changed files with 1977 additions and 875 deletions
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions
|
|||
title: "actions"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the actions plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
|
||||
---
|
||||
import actionsObj from './actions.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings
|
|||
title: "advancedSettings"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the advancedSettings plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
|
||||
---
|
||||
import advancedSettingsObj from './advanced_settings.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiAssistantManagementSelection
|
|||
title: "aiAssistantManagementSelection"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the aiAssistantManagementSelection plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection']
|
||||
---
|
||||
import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops
|
|||
title: "aiops"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the aiops plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
|
||||
---
|
||||
import aiopsObj from './aiops.devdocs.json';
|
||||
|
|
|
@ -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-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
|
||||
---
|
||||
import alertingObj from './alerting.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm
|
|||
title: "apm"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the apm plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
|
||||
---
|
||||
import apmObj from './apm.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apmDataAccess
|
|||
title: "apmDataAccess"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the apmDataAccess plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
|
||||
---
|
||||
import apmDataAccessObj from './apm_data_access.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/banners
|
|||
title: "banners"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the banners plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
|
||||
---
|
||||
import bannersObj from './banners.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/bfetch
|
|||
title: "bfetch"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the bfetch plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
|
||||
---
|
||||
import bfetchObj from './bfetch.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/canvas
|
|||
title: "canvas"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the canvas plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
|
||||
---
|
||||
import canvasObj from './canvas.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases
|
|||
title: "cases"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the cases plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
|
||||
---
|
||||
import casesObj from './cases.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts
|
|||
title: "charts"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the charts plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
|
||||
---
|
||||
import chartsObj from './charts.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud
|
|||
title: "cloud"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the cloud plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
|
||||
---
|
||||
import cloudObj from './cloud.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration
|
|||
title: "cloudDataMigration"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the cloudDataMigration plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
|
||||
---
|
||||
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDefend
|
|||
title: "cloudDefend"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the cloudDefend plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
|
||||
---
|
||||
import cloudDefendObj from './cloud_defend.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudExperiments
|
|||
title: "cloudExperiments"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the cloudExperiments plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments']
|
||||
---
|
||||
import cloudExperimentsObj from './cloud_experiments.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture
|
|||
title: "cloudSecurityPosture"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the cloudSecurityPosture plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
|
||||
---
|
||||
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/console
|
|||
title: "console"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the console plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
|
||||
---
|
||||
import consoleObj from './console.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentManagement
|
|||
title: "contentManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the contentManagement plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
|
||||
---
|
||||
import contentManagementObj from './content_management.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/controls
|
|||
title: "controls"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the controls plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
|
||||
---
|
||||
import controlsObj from './controls.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/customIntegrations
|
|||
title: "customIntegrations"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the customIntegrations plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
|
||||
---
|
||||
import customIntegrationsObj from './custom_integrations.devdocs.json';
|
||||
|
|
|
@ -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-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
|
||||
---
|
||||
import dashboardObj from './dashboard.devdocs.json';
|
||||
|
|
|
@ -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-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
|
||||
---
|
||||
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data
|
|||
title: "data"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the data plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
|
||||
---
|
||||
import dataObj from './data.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataQuality
|
|||
title: "dataQuality"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the dataQuality plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataQuality']
|
||||
---
|
||||
import dataQualityObj from './data_quality.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query
|
|||
title: "data.query"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the data.query plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
|
||||
---
|
||||
import dataQueryObj from './data_query.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search
|
|||
title: "data.search"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the data.search plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
|
||||
---
|
||||
import dataSearchObj from './data_search.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewEditor
|
|||
title: "dataViewEditor"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the dataViewEditor plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
|
||||
---
|
||||
import dataViewEditorObj from './data_view_editor.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor
|
|||
title: "dataViewFieldEditor"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the dataViewFieldEditor plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
|
||||
---
|
||||
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewManagement
|
|||
title: "dataViewManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the dataViewManagement plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
|
||||
---
|
||||
import dataViewManagementObj from './data_view_management.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews
|
|||
title: "dataViews"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the dataViews plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
|
||||
---
|
||||
import dataViewsObj from './data_views.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataVisualizer
|
|||
title: "dataVisualizer"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the dataVisualizer plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
|
||||
---
|
||||
import dataVisualizerObj from './data_visualizer.devdocs.json';
|
||||
|
|
|
@ -94,7 +94,62 @@
|
|||
"DatasetQualityPublicState",
|
||||
"> | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/observability_solution/dataset_quality/public/controller/create_controller.ts",
|
||||
"path": "x-pack/plugins/observability_solution/dataset_quality/public/controller/dataset_quality/create_controller.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "datasetQuality",
|
||||
"id": "def-public.DatasetQualityPluginStart.DatasetQualityDetails",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "DatasetQualityDetails",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"React.ComponentClass<",
|
||||
"DatasetQualityDetailsProps",
|
||||
", any> | React.FunctionComponent<",
|
||||
"DatasetQualityDetailsProps",
|
||||
">"
|
||||
],
|
||||
"path": "x-pack/plugins/observability_solution/dataset_quality/public/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "datasetQuality",
|
||||
"id": "def-public.DatasetQualityPluginStart.createDatasetQualityDetailsController",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "createDatasetQualityDetailsController",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"({ initialState, }: { initialState: ",
|
||||
"DatasetQualityDetailsPublicStateUpdate",
|
||||
"; }) => Promise<",
|
||||
"DatasetQualityDetailsController",
|
||||
">"
|
||||
],
|
||||
"path": "x-pack/plugins/observability_solution/dataset_quality/public/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "datasetQuality",
|
||||
"id": "def-public.DatasetQualityPluginStart.createDatasetQualityDetailsController.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "__0",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ initialState: ",
|
||||
"DatasetQualityDetailsPublicStateUpdate",
|
||||
"; }"
|
||||
],
|
||||
"path": "x-pack/plugins/observability_solution/dataset_quality/public/controller/dataset_quality_details/create_controller.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
|
@ -115,7 +170,41 @@
|
|||
},
|
||||
"common": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "datasetQuality",
|
||||
"id": "def-common.indexNameToDataStreamParts",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "indexNameToDataStreamParts",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(dataStreamName: string) => { type: \"metrics\" | \"synthetics\" | \"traces\" | \"logs\" | \"profiling\"; dataset: string; namespace: string; }"
|
||||
],
|
||||
"path": "x-pack/plugins/observability_solution/dataset_quality/common/utils/dataset_name.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "datasetQuality",
|
||||
"id": "def-common.indexNameToDataStreamParts.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "dataStreamName",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/observability_solution/dataset_quality/common/utils/dataset_name.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [
|
||||
{
|
||||
"parentPluginId": "datasetQuality",
|
||||
|
@ -169,7 +258,7 @@
|
|||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"DatasetQualityRouteHandlerResources",
|
||||
" & { params: { path: { dataStream: string; }; }; }) => Promise<{ createdOn?: number | null | undefined; integration?: string | undefined; }>; } & ",
|
||||
" & { params: { path: { dataStream: string; }; }; }) => Promise<{ createdOn?: number | null | undefined; integration?: string | undefined; datasetUserPrivileges?: ({ canMonitor: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }) | undefined; }>; } & ",
|
||||
"DatasetQualityRouteCreateOptions",
|
||||
"; \"GET /internal/dataset_quality/data_streams/{dataStream}/details\": { endpoint: \"GET /internal/dataset_quality/data_streams/{dataStream}/details\"; params?: ",
|
||||
"TypeC",
|
||||
|
@ -330,7 +419,7 @@
|
|||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"DatasetQualityRouteHandlerResources",
|
||||
" & { params: { path: { dataStream: string; }; }; }) => Promise<{ createdOn?: number | null | undefined; integration?: string | undefined; }>; } & ",
|
||||
" & { params: { path: { dataStream: string; }; }; }) => Promise<{ createdOn?: number | null | undefined; integration?: string | undefined; datasetUserPrivileges?: ({ canMonitor: boolean; } & { canRead: boolean; canViewIntegrations: boolean; }) | undefined; }>; } & ",
|
||||
"DatasetQualityRouteCreateOptions",
|
||||
"; \"GET /internal/dataset_quality/data_streams/{dataStream}/details\": { endpoint: \"GET /internal/dataset_quality/data_streams/{dataStream}/details\"; params?: ",
|
||||
"TypeC",
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/datasetQuality
|
|||
title: "datasetQuality"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the datasetQuality plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'datasetQuality']
|
||||
---
|
||||
import datasetQualityObj from './dataset_quality.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 |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 10 | 0 | 10 | 5 |
|
||||
| 15 | 0 | 15 | 8 |
|
||||
|
||||
## Client
|
||||
|
||||
|
@ -36,6 +36,9 @@ Contact [@elastic/obs-ux-logs-team](https://github.com/orgs/elastic/teams/obs-ux
|
|||
|
||||
## Common
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={datasetQualityObj.common.functions}/>
|
||||
|
||||
### Interfaces
|
||||
<DocDefinitionList data={datasetQualityObj.common.interfaces}/>
|
||||
|
||||
|
|
|
@ -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-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
|
|
@ -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-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
|
|
@ -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-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
---
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/devTools
|
|||
title: "devTools"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the devTools plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
|
||||
---
|
||||
import devToolsObj from './dev_tools.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover
|
|||
title: "discover"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the discover plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
|
||||
---
|
||||
import discoverObj from './discover.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced
|
|||
title: "discoverEnhanced"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the discoverEnhanced plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
|
||||
---
|
||||
import discoverEnhancedObj from './discover_enhanced.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverShared
|
|||
title: "discoverShared"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the discoverShared plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverShared']
|
||||
---
|
||||
import discoverSharedObj from './discover_shared.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ecsDataQualityDashboard
|
|||
title: "ecsDataQualityDashboard"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the ecsDataQualityDashboard plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
|
||||
---
|
||||
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/elasticAssistant
|
|||
title: "elasticAssistant"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the elasticAssistant plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistant']
|
||||
---
|
||||
import elasticAssistantObj from './elastic_assistant.devdocs.json';
|
||||
|
|
|
@ -8980,7 +8980,7 @@
|
|||
"section": "def-public.PresentationPanelProps",
|
||||
"text": "PresentationPanelProps"
|
||||
},
|
||||
"<Api, {}>, \"showShadow\" | \"showBorder\" | \"showBadges\" | \"showNotifications\" | \"hideHeader\" | \"hideInspector\"> | undefined; hidePanelChrome?: boolean | undefined; onAnyStateChange?: ((state: ",
|
||||
"<Api, {}>, \"showShadow\" | \"showBorder\" | \"showBadges\" | \"showNotifications\" | \"hideLoader\" | \"hideHeader\" | \"hideInspector\"> | undefined; hidePanelChrome?: boolean | undefined; onAnyStateChange?: ((state: ",
|
||||
{
|
||||
"pluginId": "@kbn/presentation-containers",
|
||||
"scope": "public",
|
||||
|
@ -9094,7 +9094,7 @@
|
|||
"section": "def-public.PresentationPanelProps",
|
||||
"text": "PresentationPanelProps"
|
||||
},
|
||||
"<Api, {}>, \"showShadow\" | \"showBorder\" | \"showBadges\" | \"showNotifications\" | \"hideHeader\" | \"hideInspector\"> | undefined"
|
||||
"<Api, {}>, \"showShadow\" | \"showBorder\" | \"showBadges\" | \"showNotifications\" | \"hideLoader\" | \"hideHeader\" | \"hideInspector\"> | undefined"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/react_embeddable_system/react_embeddable_renderer.tsx",
|
||||
"deprecated": false,
|
||||
|
|
|
@ -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-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
|
||||
---
|
||||
import embeddableObj from './embeddable.devdocs.json';
|
||||
|
|
|
@ -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-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
|
||||
---
|
||||
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects
|
|||
title: "encryptedSavedObjects"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the encryptedSavedObjects plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
|
||||
---
|
||||
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch
|
|||
title: "enterpriseSearch"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the enterpriseSearch plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
|
||||
---
|
||||
import enterpriseSearchObj from './enterprise_search.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/entitiesDataAccess
|
|||
title: "entitiesDataAccess"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the entitiesDataAccess plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'entitiesDataAccess']
|
||||
---
|
||||
import entitiesDataAccessObj from './entities_data_access.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/entityManager
|
|||
title: "entityManager"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the entityManager plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'entityManager']
|
||||
---
|
||||
import entityManagerObj from './entity_manager.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esUiShared
|
|||
title: "esUiShared"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the esUiShared plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
|
||||
---
|
||||
import esUiSharedObj from './es_ui_shared.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esql
|
|||
title: "esql"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the esql plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esql']
|
||||
---
|
||||
import esqlObj from './esql.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esqlDataGrid
|
|||
title: "esqlDataGrid"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the esqlDataGrid plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esqlDataGrid']
|
||||
---
|
||||
import esqlDataGridObj from './esql_data_grid.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation
|
|||
title: "eventAnnotation"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the eventAnnotation plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
|
||||
---
|
||||
import eventAnnotationObj from './event_annotation.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotationListing
|
|||
title: "eventAnnotationListing"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the eventAnnotationListing plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotationListing']
|
||||
---
|
||||
import eventAnnotationListingObj from './event_annotation_listing.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventLog
|
|||
title: "eventLog"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the eventLog plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
|
||||
---
|
||||
import eventLogObj from './event_log.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/exploratoryView
|
|||
title: "exploratoryView"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the exploratoryView plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
|
||||
---
|
||||
import exploratoryViewObj from './exploratory_view.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionError
|
|||
title: "expressionError"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionError plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
|
||||
---
|
||||
import expressionErrorObj from './expression_error.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionGauge
|
|||
title: "expressionGauge"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionGauge plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
|
||||
---
|
||||
import expressionGaugeObj from './expression_gauge.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap
|
|||
title: "expressionHeatmap"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionHeatmap plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
|
||||
---
|
||||
import expressionHeatmapObj from './expression_heatmap.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionImage
|
|||
title: "expressionImage"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionImage plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
|
||||
---
|
||||
import expressionImageObj from './expression_image.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis
|
|||
title: "expressionLegacyMetricVis"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionLegacyMetricVis plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
|
||||
---
|
||||
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetric
|
|||
title: "expressionMetric"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionMetric plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
|
||||
---
|
||||
import expressionMetricObj from './expression_metric.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis
|
|||
title: "expressionMetricVis"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionMetricVis plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
|
||||
---
|
||||
import expressionMetricVisObj from './expression_metric_vis.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis
|
|||
title: "expressionPartitionVis"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionPartitionVis plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
|
||||
---
|
||||
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage
|
|||
title: "expressionRepeatImage"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionRepeatImage plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
|
||||
---
|
||||
import expressionRepeatImageObj from './expression_repeat_image.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage
|
|||
title: "expressionRevealImage"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionRevealImage plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
|
||||
---
|
||||
import expressionRevealImageObj from './expression_reveal_image.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionShape
|
|||
title: "expressionShape"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionShape plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
|
||||
---
|
||||
import expressionShapeObj from './expression_shape.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud
|
|||
title: "expressionTagcloud"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionTagcloud plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
|
||||
---
|
||||
import expressionTagcloudObj from './expression_tagcloud.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionXY
|
|||
title: "expressionXY"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressionXY plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
|
||||
---
|
||||
import expressionXYObj from './expression_x_y.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions
|
|||
title: "expressions"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the expressions plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
|
||||
---
|
||||
import expressionsObj from './expressions.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/features
|
|||
title: "features"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the features plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
|
||||
---
|
||||
import featuresObj from './features.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats
|
|||
title: "fieldFormats"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the fieldFormats plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
|
||||
---
|
||||
import fieldFormatsObj from './field_formats.devdocs.json';
|
||||
|
|
|
@ -336,7 +336,7 @@
|
|||
"label": "pick",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(props: (\"source\" | \"type\" | \"normalize\" | \"short\" | \"format\" | \"name\" | \"index\" | \"description\" | \"pattern\" | \"doc_values\" | \"ignore_above\" | \"beta\" | \"required\" | \"level\" | \"allowed_values\" | \"dashed_name\" | \"example\" | \"expected_values\" | \"flat_name\" | \"input_format\" | \"multi_fields\" | \"object_type\" | \"original_fieldset\" | \"output_format\" | \"output_precision\" | \"scaling_factor\" | \"documentation_url\")[]) => { name?: string | undefined; } & { allowed_values?: ({ description: string; name: string; } & { expected_event_types?: string[] | undefined; beta?: string | undefined; })[] | undefined; beta?: string | undefined; dashed_name?: string | undefined; description?: string | undefined; doc_values?: boolean | undefined; example?: unknown; expected_values?: string[] | undefined; flat_name?: string | undefined; format?: string | undefined; ignore_above?: number | undefined; index?: boolean | undefined; input_format?: string | undefined; level?: string | undefined; multi_fields?: { flat_name: string; name: string; type: string; }[] | undefined; normalize?: string[] | undefined; object_type?: string | undefined; original_fieldset?: string | undefined; output_format?: string | undefined; output_precision?: number | undefined; pattern?: string | undefined; required?: boolean | undefined; scaling_factor?: number | undefined; short?: string | undefined; source?: \"unknown\" | \"ecs\" | \"integration\" | \"metadata\" | undefined; type?: string | undefined; documentation_url?: string | undefined; }"
|
||||
"(props: (\"source\" | \"type\" | \"normalize\" | \"short\" | \"format\" | \"name\" | \"index\" | \"description\" | \"pattern\" | \"doc_values\" | \"ignore_above\" | \"required\" | \"beta\" | \"level\" | \"allowed_values\" | \"dashed_name\" | \"example\" | \"expected_values\" | \"flat_name\" | \"input_format\" | \"multi_fields\" | \"object_type\" | \"original_fieldset\" | \"output_format\" | \"output_precision\" | \"scaling_factor\" | \"documentation_url\")[]) => { name?: string | undefined; } & { allowed_values?: ({ description: string; name: string; } & { expected_event_types?: string[] | undefined; beta?: string | undefined; })[] | undefined; beta?: string | undefined; dashed_name?: string | undefined; description?: string | undefined; doc_values?: boolean | undefined; example?: unknown; expected_values?: string[] | undefined; flat_name?: string | undefined; format?: string | undefined; ignore_above?: number | undefined; index?: boolean | undefined; input_format?: string | undefined; level?: string | undefined; multi_fields?: { flat_name: string; name: string; type: string; }[] | undefined; normalize?: string[] | undefined; object_type?: string | undefined; original_fieldset?: string | undefined; output_format?: string | undefined; output_precision?: number | undefined; pattern?: string | undefined; required?: boolean | undefined; scaling_factor?: number | undefined; short?: string | undefined; source?: \"unknown\" | \"ecs\" | \"integration\" | \"metadata\" | undefined; type?: string | undefined; documentation_url?: string | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/fields_metadata/common/fields_metadata/models/field_metadata.ts",
|
||||
"deprecated": false,
|
||||
|
@ -350,7 +350,7 @@
|
|||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(\"source\" | \"type\" | \"normalize\" | \"short\" | \"format\" | \"name\" | \"index\" | \"description\" | \"pattern\" | \"doc_values\" | \"ignore_above\" | \"beta\" | \"required\" | \"level\" | \"allowed_values\" | \"dashed_name\" | \"example\" | \"expected_values\" | \"flat_name\" | \"input_format\" | \"multi_fields\" | \"object_type\" | \"original_fieldset\" | \"output_format\" | \"output_precision\" | \"scaling_factor\" | \"documentation_url\")[]"
|
||||
"(\"source\" | \"type\" | \"normalize\" | \"short\" | \"format\" | \"name\" | \"index\" | \"description\" | \"pattern\" | \"doc_values\" | \"ignore_above\" | \"required\" | \"beta\" | \"level\" | \"allowed_values\" | \"dashed_name\" | \"example\" | \"expected_values\" | \"flat_name\" | \"input_format\" | \"multi_fields\" | \"object_type\" | \"original_fieldset\" | \"output_format\" | \"output_precision\" | \"scaling_factor\" | \"documentation_url\")[]"
|
||||
],
|
||||
"path": "x-pack/plugins/fields_metadata/common/fields_metadata/models/field_metadata.ts",
|
||||
"deprecated": false,
|
||||
|
@ -454,7 +454,7 @@
|
|||
"label": "pick",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(attributes: (\"source\" | \"type\" | \"normalize\" | \"short\" | \"format\" | \"name\" | \"index\" | \"description\" | \"pattern\" | \"doc_values\" | \"ignore_above\" | \"beta\" | \"required\" | \"level\" | \"allowed_values\" | \"dashed_name\" | \"example\" | \"expected_values\" | \"flat_name\" | \"input_format\" | \"multi_fields\" | \"object_type\" | \"original_fieldset\" | \"output_format\" | \"output_precision\" | \"scaling_factor\" | \"documentation_url\")[]) => Record<string, { name?: string | undefined; } & { allowed_values?: ({ description: string; name: string; } & { expected_event_types?: string[] | undefined; beta?: string | undefined; })[] | undefined; beta?: string | undefined; dashed_name?: string | undefined; description?: string | undefined; doc_values?: boolean | undefined; example?: unknown; expected_values?: string[] | undefined; flat_name?: string | undefined; format?: string | undefined; ignore_above?: number | undefined; index?: boolean | undefined; input_format?: string | undefined; level?: string | undefined; multi_fields?: { flat_name: string; name: string; type: string; }[] | undefined; normalize?: string[] | undefined; object_type?: string | undefined; original_fieldset?: string | undefined; output_format?: string | undefined; output_precision?: number | undefined; pattern?: string | undefined; required?: boolean | undefined; scaling_factor?: number | undefined; short?: string | undefined; source?: \"unknown\" | \"ecs\" | \"integration\" | \"metadata\" | undefined; type?: string | undefined; documentation_url?: string | undefined; }>"
|
||||
"(attributes: (\"source\" | \"type\" | \"normalize\" | \"short\" | \"format\" | \"name\" | \"index\" | \"description\" | \"pattern\" | \"doc_values\" | \"ignore_above\" | \"required\" | \"beta\" | \"level\" | \"allowed_values\" | \"dashed_name\" | \"example\" | \"expected_values\" | \"flat_name\" | \"input_format\" | \"multi_fields\" | \"object_type\" | \"original_fieldset\" | \"output_format\" | \"output_precision\" | \"scaling_factor\" | \"documentation_url\")[]) => Record<string, { name?: string | undefined; } & { allowed_values?: ({ description: string; name: string; } & { expected_event_types?: string[] | undefined; beta?: string | undefined; })[] | undefined; beta?: string | undefined; dashed_name?: string | undefined; description?: string | undefined; doc_values?: boolean | undefined; example?: unknown; expected_values?: string[] | undefined; flat_name?: string | undefined; format?: string | undefined; ignore_above?: number | undefined; index?: boolean | undefined; input_format?: string | undefined; level?: string | undefined; multi_fields?: { flat_name: string; name: string; type: string; }[] | undefined; normalize?: string[] | undefined; object_type?: string | undefined; original_fieldset?: string | undefined; output_format?: string | undefined; output_precision?: number | undefined; pattern?: string | undefined; required?: boolean | undefined; scaling_factor?: number | undefined; short?: string | undefined; source?: \"unknown\" | \"ecs\" | \"integration\" | \"metadata\" | undefined; type?: string | undefined; documentation_url?: string | undefined; }>"
|
||||
],
|
||||
"path": "x-pack/plugins/fields_metadata/common/fields_metadata/models/fields_metadata_dictionary.ts",
|
||||
"deprecated": false,
|
||||
|
@ -468,7 +468,7 @@
|
|||
"label": "attributes",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(\"source\" | \"type\" | \"normalize\" | \"short\" | \"format\" | \"name\" | \"index\" | \"description\" | \"pattern\" | \"doc_values\" | \"ignore_above\" | \"beta\" | \"required\" | \"level\" | \"allowed_values\" | \"dashed_name\" | \"example\" | \"expected_values\" | \"flat_name\" | \"input_format\" | \"multi_fields\" | \"object_type\" | \"original_fieldset\" | \"output_format\" | \"output_precision\" | \"scaling_factor\" | \"documentation_url\")[]"
|
||||
"(\"source\" | \"type\" | \"normalize\" | \"short\" | \"format\" | \"name\" | \"index\" | \"description\" | \"pattern\" | \"doc_values\" | \"ignore_above\" | \"required\" | \"beta\" | \"level\" | \"allowed_values\" | \"dashed_name\" | \"example\" | \"expected_values\" | \"flat_name\" | \"input_format\" | \"multi_fields\" | \"object_type\" | \"original_fieldset\" | \"output_format\" | \"output_precision\" | \"scaling_factor\" | \"documentation_url\")[]"
|
||||
],
|
||||
"path": "x-pack/plugins/fields_metadata/common/fields_metadata/models/fields_metadata_dictionary.ts",
|
||||
"deprecated": false,
|
||||
|
@ -605,7 +605,7 @@
|
|||
"label": "FieldAttribute",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"source\" | \"type\" | \"normalize\" | \"short\" | \"format\" | \"name\" | \"index\" | \"description\" | \"pattern\" | \"doc_values\" | \"ignore_above\" | \"beta\" | \"required\" | \"level\" | \"allowed_values\" | \"dashed_name\" | \"example\" | \"expected_values\" | \"flat_name\" | \"input_format\" | \"multi_fields\" | \"object_type\" | \"original_fieldset\" | \"output_format\" | \"output_precision\" | \"scaling_factor\" | \"documentation_url\""
|
||||
"\"source\" | \"type\" | \"normalize\" | \"short\" | \"format\" | \"name\" | \"index\" | \"description\" | \"pattern\" | \"doc_values\" | \"ignore_above\" | \"required\" | \"beta\" | \"level\" | \"allowed_values\" | \"dashed_name\" | \"example\" | \"expected_values\" | \"flat_name\" | \"input_format\" | \"multi_fields\" | \"object_type\" | \"original_fieldset\" | \"output_format\" | \"output_precision\" | \"scaling_factor\" | \"documentation_url\""
|
||||
],
|
||||
"path": "x-pack/plugins/fields_metadata/common/fields_metadata/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldsMetadata
|
|||
title: "fieldsMetadata"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the fieldsMetadata plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldsMetadata']
|
||||
---
|
||||
import fieldsMetadataObj from './fields_metadata.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fileUpload
|
|||
title: "fileUpload"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the fileUpload plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
|
||||
---
|
||||
import fileUploadObj from './file_upload.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/files
|
|||
title: "files"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the files plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
|
||||
---
|
||||
import filesObj from './files.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/filesManagement
|
|||
title: "filesManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the filesManagement plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
|
||||
---
|
||||
import filesManagementObj from './files_management.devdocs.json';
|
||||
|
|
|
@ -6322,7 +6322,15 @@
|
|||
"section": "def-server.SavedObjectsClientContract",
|
||||
"text": "SavedObjectsClientContract"
|
||||
},
|
||||
", id: string, options?: { standalone: boolean; } | undefined) => Promise<",
|
||||
", id: string, options?: { standalone?: boolean | undefined; agentPolicy?: ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.AgentPolicy",
|
||||
"text": "AgentPolicy"
|
||||
},
|
||||
" | undefined; } | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
|
@ -6376,7 +6384,15 @@
|
|||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ standalone: boolean; } | undefined"
|
||||
"{ standalone?: boolean | undefined; agentPolicy?: ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.AgentPolicy",
|
||||
"text": "AgentPolicy"
|
||||
},
|
||||
" | undefined; } | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/server/services/agent_policy.ts",
|
||||
"deprecated": false,
|
||||
|
@ -6544,7 +6560,7 @@
|
|||
},
|
||||
", { perPage, kuery }?: ",
|
||||
"FetchAllAgentPolicyIdsOptions",
|
||||
") => AsyncIterable<string[]>"
|
||||
") => Promise<AsyncIterable<string[]>>"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
||||
"deprecated": false,
|
||||
|
@ -6605,7 +6621,7 @@
|
|||
},
|
||||
", { perPage, kuery, sortOrder, sortField, fields, }?: ",
|
||||
"FetchAllAgentPoliciesOptions",
|
||||
") => AsyncIterable<",
|
||||
") => Promise<AsyncIterable<",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
|
@ -6613,7 +6629,7 @@
|
|||
"section": "def-common.AgentPolicy",
|
||||
"text": "AgentPolicy"
|
||||
},
|
||||
"[]>"
|
||||
"[]>>"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/server/services/index.ts",
|
||||
"deprecated": false,
|
||||
|
@ -11809,7 +11825,7 @@
|
|||
},
|
||||
", options?: ",
|
||||
"PackagePolicyClientFetchAllItemIdsOptions",
|
||||
" | undefined) => AsyncIterable<string[]>"
|
||||
" | undefined) => Promise<AsyncIterable<string[]>>"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/server/services/package_policy_service.ts",
|
||||
"deprecated": false,
|
||||
|
@ -11875,7 +11891,7 @@
|
|||
},
|
||||
", options?: ",
|
||||
"PackagePolicyClientFetchAllItemsOptions",
|
||||
" | undefined) => AsyncIterable<",
|
||||
" | undefined) => Promise<AsyncIterable<",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
|
@ -11883,7 +11899,7 @@
|
|||
"section": "def-common.PackagePolicy",
|
||||
"text": "PackagePolicy"
|
||||
},
|
||||
"[]>"
|
||||
"[]>>"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/server/services/package_policy_service.ts",
|
||||
"deprecated": false,
|
||||
|
@ -23194,6 +23210,20 @@
|
|||
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.ListWithKuery.fields",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "fields",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string[] | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -26455,7 +26485,7 @@
|
|||
"label": "AGENT_POLICY_SAVED_OBJECT_TYPE",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"ingest-agent-policies\""
|
||||
"\"fleet-agent-policies\""
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
|
||||
"deprecated": false,
|
||||
|
@ -27481,6 +27511,36 @@
|
|||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.LEGACY_AGENT_POLICY_SAVED_OBJECT_TYPE",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "LEGACY_AGENT_POLICY_SAVED_OBJECT_TYPE",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"ingest-agent-policies\""
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/constants/agent_policy.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.LEGACY_PACKAGE_POLICY_SAVED_OBJECT_TYPE",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "LEGACY_PACKAGE_POLICY_SAVED_OBJECT_TYPE",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"ingest-package-policies\""
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/constants/package_policy.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.MESSAGE_SIGNING_KEYS_SAVED_OBJECT_TYPE",
|
||||
|
@ -27581,21 +27641,6 @@
|
|||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.PACKAGE_POLICY_SAVED_OBJECT_TYPE",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "PACKAGE_POLICY_SAVED_OBJECT_TYPE",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"ingest-package-policies\""
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/constants/package_policy.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.PackageInfo",
|
||||
|
|
|
@ -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-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
|
||||
---
|
||||
import fleetObj from './fleet.devdocs.json';
|
||||
|
@ -21,7 +21,7 @@ Contact [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) for questi
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 1357 | 5 | 1234 | 74 |
|
||||
| 1359 | 5 | 1236 | 74 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/globalSearch
|
|||
title: "globalSearch"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the globalSearch plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
|
||||
---
|
||||
import globalSearchObj from './global_search.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/guidedOnboarding
|
|||
title: "guidedOnboarding"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the guidedOnboarding plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
|
||||
---
|
||||
import guidedOnboardingObj from './guided_onboarding.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/home
|
|||
title: "home"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the home plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
|
||||
---
|
||||
import homeObj from './home.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/imageEmbeddable
|
|||
title: "imageEmbeddable"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the imageEmbeddable plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
|
||||
---
|
||||
import imageEmbeddableObj from './image_embeddable.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement
|
|||
title: "indexLifecycleManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the indexLifecycleManagement plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
|
||||
---
|
||||
import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexManagement
|
|||
title: "indexManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the indexManagement plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
|
||||
---
|
||||
import indexManagementObj from './index_management.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inference
|
|||
title: "inference"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the inference plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inference']
|
||||
---
|
||||
import inferenceObj from './inference.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/infra
|
|||
title: "infra"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the infra plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
|
||||
---
|
||||
import infraObj from './infra.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ingestPipelines
|
|||
title: "ingestPipelines"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the ingestPipelines plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ingestPipelines']
|
||||
---
|
||||
import ingestPipelinesObj from './ingest_pipelines.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inspector
|
|||
title: "inspector"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the inspector plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
|
||||
---
|
||||
import inspectorObj from './inspector.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/integrationAssistant
|
|||
title: "integrationAssistant"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the integrationAssistant plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'integrationAssistant']
|
||||
---
|
||||
import integrationAssistantObj from './integration_assistant.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/interactiveSetup
|
|||
title: "interactiveSetup"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the interactiveSetup plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
|
||||
---
|
||||
import interactiveSetupObj from './interactive_setup.devdocs.json';
|
||||
|
|
|
@ -1152,24 +1152,6 @@
|
|||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "investigate",
|
||||
"id": "def-public.InvestigatePublicStart.useInvestigateWidget",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "useInvestigateWidget",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
"UseInvestigateWidgetApi",
|
||||
"<{}, {}> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/observability_solution/investigate/public/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
@ -1789,19 +1771,10 @@
|
|||
{
|
||||
"parentPluginId": "investigate",
|
||||
"id": "def-common.InvestigationNote.createdBy",
|
||||
"type": "Object",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "createdBy",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "@kbn/core-security-common",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnCoreSecurityCommonPluginApi",
|
||||
"section": "def-common.AuthenticatedUser",
|
||||
"text": "AuthenticatedUser"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/observability_solution/investigate/common/types.ts",
|
||||
"deprecated": false,
|
||||
"trackAdoption": false
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/investigate
|
|||
title: "investigate"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the investigate plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'investigate']
|
||||
---
|
||||
import investigateObj from './investigate.devdocs.json';
|
||||
|
@ -21,7 +21,7 @@ Contact [@elastic/obs-ux-management-team](https://github.com/orgs/elastic/teams/
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 112 | 0 | 112 | 6 |
|
||||
| 111 | 0 | 111 | 5 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -50,7 +50,7 @@
|
|||
"label": "InvestigateAppServerRouteRepository",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ \"GET /api/observability/investigations/{id} 2023-10-31\": { endpoint: \"GET /api/observability/investigations/{id} 2023-10-31\"; params?: ",
|
||||
"{ \"GET /api/observability/investigations/{id}/notes 2023-10-31\": { endpoint: \"GET /api/observability/investigations/{id}/notes 2023-10-31\"; params?: ",
|
||||
"TypeC",
|
||||
"<{ path: ",
|
||||
"TypeC",
|
||||
|
@ -58,19 +58,55 @@
|
|||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params: { path: { id: string; }; }; }) => Promise<{ id: string; title: string; createdAt: number; createdBy: string; parameters: { timeRange: { from: number; to: number; }; }; }>; } & ",
|
||||
" & { params: { path: { id: string; }; }; }) => Promise<{ id: string; content: string; createdAt: number; createdBy: string; }[]>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; \"POST /api/observability/investigations/{id}/notes 2023-10-31\": { endpoint: \"POST /api/observability/investigations/{id}/notes 2023-10-31\"; params?: ",
|
||||
"TypeC",
|
||||
"<{ path: ",
|
||||
"TypeC",
|
||||
"<{ id: ",
|
||||
"StringC",
|
||||
"; }>; body: ",
|
||||
"TypeC",
|
||||
"<{ content: ",
|
||||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params: { path: { id: string; }; body: { content: string; }; }; }) => Promise<{ id: string; content: string; createdAt: number; createdBy: string; }>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; \"DELETE /api/observability/investigations/{id} 2023-10-31\": { endpoint: \"DELETE /api/observability/investigations/{id} 2023-10-31\"; params?: ",
|
||||
"TypeC",
|
||||
"<{ path: ",
|
||||
"TypeC",
|
||||
"<{ id: ",
|
||||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params: { path: { id: string; }; }; }) => Promise<void>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; \"GET /api/observability/investigations/{id} 2023-10-31\": { endpoint: \"GET /api/observability/investigations/{id} 2023-10-31\"; params?: ",
|
||||
"TypeC",
|
||||
"<{ path: ",
|
||||
"TypeC",
|
||||
"<{ id: ",
|
||||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params: { path: { id: string; }; }; }) => Promise<{ id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; }>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; \"GET /api/observability/investigations 2023-10-31\": { endpoint: \"GET /api/observability/investigations 2023-10-31\"; params?: ",
|
||||
"PartialC",
|
||||
"<{ query: ",
|
||||
"PartialC",
|
||||
"<{ page: ",
|
||||
"<{ alertId: ",
|
||||
"StringC",
|
||||
"; page: ",
|
||||
"StringC",
|
||||
"; perPage: ",
|
||||
"StringC",
|
||||
"; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params?: { query?: { page?: string | undefined; perPage?: string | undefined; } | undefined; } | undefined; }) => Promise<{ page: number; perPage: number; total: number; results: { id: string; title: string; createdAt: number; createdBy: string; parameters: { timeRange: { from: number; to: number; }; }; }[]; }>; } & ",
|
||||
" & { params?: { query?: { alertId?: string | undefined; page?: string | undefined; perPage?: string | undefined; } | undefined; } | undefined; }) => Promise<{ page: number; perPage: number; total: number; results: { id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; }[]; }>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; \"POST /api/observability/investigations 2023-10-31\": { endpoint: \"POST /api/observability/investigations 2023-10-31\"; params?: ",
|
||||
"TypeC",
|
||||
|
@ -80,7 +116,7 @@
|
|||
"StringC",
|
||||
"; title: ",
|
||||
"StringC",
|
||||
"; parameters: ",
|
||||
"; params: ",
|
||||
"TypeC",
|
||||
"<{ timeRange: ",
|
||||
"TypeC",
|
||||
|
@ -88,9 +124,21 @@
|
|||
"NumberC",
|
||||
"; to: ",
|
||||
"NumberC",
|
||||
"; }>; }>; }>; }> | undefined; handler: ({}: ",
|
||||
"; }>; }>; origin: ",
|
||||
"UnionC",
|
||||
"<[",
|
||||
"TypeC",
|
||||
"<{ type: ",
|
||||
"LiteralC",
|
||||
"<\"alert\">; id: ",
|
||||
"StringC",
|
||||
"; }>, ",
|
||||
"TypeC",
|
||||
"<{ type: ",
|
||||
"LiteralC",
|
||||
"<\"blank\">; }>]>; }>; }> | undefined; handler: ({}: ",
|
||||
"InvestigateAppRouteHandlerResources",
|
||||
" & { params: { body: { id: string; title: string; parameters: { timeRange: { from: number; to: number; }; }; }; }; }) => Promise<{ id: string; title: string; createdAt: number; createdBy: string; parameters: { timeRange: { from: number; to: number; }; }; }>; } & ",
|
||||
" & { params: { body: { id: string; title: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; }; }; }) => Promise<{ id: string; title: string; createdAt: number; createdBy: string; params: { timeRange: { from: number; to: number; }; }; origin: { type: \"alert\"; id: string; } | { type: \"blank\"; }; status: \"closed\" | \"ongoing\"; notes: { id: string; content: string; createdAt: number; createdBy: string; }[]; }>; } & ",
|
||||
"InvestigateAppRouteCreateOptions",
|
||||
"; }"
|
||||
],
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/investigateApp
|
|||
title: "investigateApp"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the investigateApp plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'investigateApp']
|
||||
---
|
||||
import investigateAppObj from './investigate_app.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ace
|
|||
title: "@kbn/ace"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/ace plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace']
|
||||
---
|
||||
import kbnAceObj from './kbn_ace.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-actions-types
|
|||
title: "@kbn/actions-types"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/actions-types plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/actions-types']
|
||||
---
|
||||
import kbnActionsTypesObj from './kbn_actions_types.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-components
|
|||
title: "@kbn/aiops-components"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/aiops-components plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components']
|
||||
---
|
||||
import kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json';
|
||||
|
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-log-pattern-analysis
|
|||
title: "@kbn/aiops-log-pattern-analysis"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/aiops-log-pattern-analysis plugin
|
||||
date: 2024-08-14
|
||||
date: 2024-08-15
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-log-pattern-analysis']
|
||||
---
|
||||
import kbnAiopsLogPatternAnalysisObj from './kbn_aiops_log_pattern_analysis.devdocs.json';
|
||||
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue