mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
[api-docs] Daily api_docs build (#139337)
This commit is contained in:
Kibana Machine
GitHub
parent
7a107392b4
commit
5e44648cca
366 changed files with 1618 additions and 1056 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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
|
||||
---
|
||||
import advancedSettingsObj from './advanced_settings.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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
|
||||
---
|
||||
import apmObj from './apm.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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
|
||||
---
|
||||
import cloudObj from './cloud.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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
|
||||
---
|
||||
import consoleObj from './console.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -3517,20 +3517,6 @@
|
|||
"path": "src/plugins/controls/common/range_slider/types.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "controls",
|
||||
"id": "def-public.TIME_SLIDER_CONTROL",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "TIME_SLIDER_CONTROL",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"timeSlider\""
|
||||
],
|
||||
"path": "src/plugins/controls/common/control_types/time_slider/types.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": []
|
||||
|
|
@ -4443,20 +4429,6 @@
|
|||
"path": "src/plugins/controls/common/control_group/types.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "controls",
|
||||
"id": "def-common.TIME_SLIDER_CONTROL",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "TIME_SLIDER_CONTROL",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"timeSlider\""
|
||||
],
|
||||
"path": "src/plugins/controls/common/control_types/time_slider/types.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": []
|
||||
|
|
|
|||
|
|
@ -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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
|
||||
---
|
||||
import controlsObj from './controls.devdocs.json';
|
||||
|
|
@ -21,7 +21,7 @@ Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-prese
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 206 | 0 | 198 | 7 |
|
||||
| 204 | 0 | 196 | 7 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/core
|
|||
title: "core"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the core plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core']
|
||||
---
|
||||
import coreObj from './core.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/core-application
|
|||
title: "core.application"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the core.application plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application']
|
||||
---
|
||||
import coreApplicationObj from './core_application.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/core-chrome
|
|||
title: "core.chrome"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the core.chrome plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome']
|
||||
---
|
||||
import coreChromeObj from './core_chrome.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/core-savedObjects
|
|||
title: "core.savedObjects"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the core.savedObjects plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.savedObjects']
|
||||
---
|
||||
import coreSavedObjectsObj from './core_saved_objects.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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
|
||||
---
|
||||
import dataObj from './data.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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
|
||||
---
|
||||
import dataVisualizerObj from './data_visualizer.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
|
|||
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
|
||||
title: Deprecated API usage by API
|
||||
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
|
||||
---
|
||||
import devToolsObj from './dev_tools.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -1091,6 +1091,59 @@
|
|||
"path": "src/plugins/saved_search/public/services/saved_searches/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.SavedSearch.timeRestore",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "timeRestore",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "src/plugins/saved_search/public/services/saved_searches/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.SavedSearch.timeRange",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "timeRange",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/saved_search/public/services/saved_searches/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.SavedSearch.refreshInterval",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "refreshInterval",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.RefreshInterval",
|
||||
"text": "RefreshInterval"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/saved_search/public/services/saved_searches/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.SavedSearch.rowsPerPage",
|
||||
|
|
|
|||
|
|
@ -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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
|
||||
---
|
||||
import discoverObj from './discover.devdocs.json';
|
||||
|
|
@ -21,7 +21,7 @@ Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-disco
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 90 | 0 | 73 | 5 |
|
||||
| 93 | 0 | 76 | 4 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
|
||||
---
|
||||
import discoverEnhancedObj from './discover_enhanced.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
|
||||
---
|
||||
import enterpriseSearchObj from './enterprise_search.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esUiShared
|
|||
title: "esUiShared"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the esUiShared plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
|
||||
---
|
||||
import esUiSharedObj from './es_ui_shared.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation
|
|||
title: "eventAnnotation"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the eventAnnotation plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
|
||||
---
|
||||
import eventAnnotationObj from './event_annotation.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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
|
||||
---
|
||||
import eventLogObj from './event_log.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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
|
||||
---
|
||||
import fieldFormatsObj from './field_formats.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fileUpload
|
|||
title: "fileUpload"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the fileUpload plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
|
||||
---
|
||||
import fileUploadObj from './file_upload.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -141,7 +141,7 @@
|
|||
"\nList all file objects, of a given {@link FileKind}.\n"
|
||||
],
|
||||
"signature": [
|
||||
"(args: ",
|
||||
"(args?: ",
|
||||
{
|
||||
"pluginId": "files",
|
||||
"scope": "common",
|
||||
|
|
@ -149,7 +149,7 @@
|
|||
"section": "def-common.Pagination",
|
||||
"text": "Pagination"
|
||||
},
|
||||
") => Promise<{ files: ",
|
||||
" | undefined) => Promise<{ files: ",
|
||||
{
|
||||
"pluginId": "files",
|
||||
"scope": "common",
|
||||
|
|
@ -173,7 +173,7 @@
|
|||
"- list files args"
|
||||
],
|
||||
"signature": [
|
||||
"E[\"inputs\"][\"body\"] & E[\"inputs\"][\"params\"] & E[\"inputs\"][\"query\"]"
|
||||
"(E[\"inputs\"][\"body\"] & E[\"inputs\"][\"params\"] & E[\"inputs\"][\"query\"]) | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/files/public/types.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -280,7 +280,7 @@
|
|||
"\nStream the contents of the file to Kibana server for storage.\n"
|
||||
],
|
||||
"signature": [
|
||||
"(args: any) => Promise<{ ok: true; size: number; }>"
|
||||
"(args: { body: unknown; } & { id: string; }) => Promise<{ ok: true; size: number; }>"
|
||||
],
|
||||
"path": "x-pack/plugins/files/public/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -575,6 +575,53 @@
|
|||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "files",
|
||||
"id": "def-public.FilesClient.getDownloadHref",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getDownloadHref",
|
||||
"description": [
|
||||
"\nGet a string for downloading a file that can be passed to a button element's\nhref for download."
|
||||
],
|
||||
"signature": [
|
||||
"(file: ",
|
||||
{
|
||||
"pluginId": "files",
|
||||
"scope": "common",
|
||||
"docId": "kibFilesPluginApi",
|
||||
"section": "def-common.FileJSON",
|
||||
"text": "FileJSON"
|
||||
},
|
||||
"<unknown>) => string"
|
||||
],
|
||||
"path": "x-pack/plugins/files/public/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "files",
|
||||
"id": "def-public.FilesClient.getDownloadHref.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "file",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "files",
|
||||
"scope": "common",
|
||||
"docId": "kibFilesPluginApi",
|
||||
"section": "def-common.FileJSON",
|
||||
"text": "FileJSON"
|
||||
},
|
||||
"<unknown>"
|
||||
],
|
||||
"path": "x-pack/plugins/files/public/types.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -637,8 +684,116 @@
|
|||
}
|
||||
],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "files",
|
||||
"id": "def-public.FilesClientResponses",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "FilesClientResponses",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ create: { file: ",
|
||||
{
|
||||
"pluginId": "files",
|
||||
"scope": "common",
|
||||
"docId": "kibFilesPluginApi",
|
||||
"section": "def-common.FileJSON",
|
||||
"text": "FileJSON"
|
||||
},
|
||||
"<unknown>; }; delete: { ok: true; }; getById: { file: ",
|
||||
{
|
||||
"pluginId": "files",
|
||||
"scope": "common",
|
||||
"docId": "kibFilesPluginApi",
|
||||
"section": "def-common.FileJSON",
|
||||
"text": "FileJSON"
|
||||
},
|
||||
"<unknown>; }; list: { files: ",
|
||||
{
|
||||
"pluginId": "files",
|
||||
"scope": "common",
|
||||
"docId": "kibFilesPluginApi",
|
||||
"section": "def-common.FileJSON",
|
||||
"text": "FileJSON"
|
||||
},
|
||||
"<unknown>[]; }; find: { files: ",
|
||||
{
|
||||
"pluginId": "files",
|
||||
"scope": "common",
|
||||
"docId": "kibFilesPluginApi",
|
||||
"section": "def-common.FileJSON",
|
||||
"text": "FileJSON"
|
||||
},
|
||||
"<unknown>[]; }; update: { file: ",
|
||||
{
|
||||
"pluginId": "files",
|
||||
"scope": "common",
|
||||
"docId": "kibFilesPluginApi",
|
||||
"section": "def-common.FileJSON",
|
||||
"text": "FileJSON"
|
||||
},
|
||||
"<unknown>; }; upload: { ok: true; size: number; }; download: any; share: ",
|
||||
{
|
||||
"pluginId": "files",
|
||||
"scope": "common",
|
||||
"docId": "kibFilesPluginApi",
|
||||
"section": "def-common.FileShareJSON",
|
||||
"text": "FileShareJSON"
|
||||
},
|
||||
" & { token: string; }; unshare: { ok: true; }; getShare: { share: ",
|
||||
{
|
||||
"pluginId": "files",
|
||||
"scope": "common",
|
||||
"docId": "kibFilesPluginApi",
|
||||
"section": "def-common.FileShareJSON",
|
||||
"text": "FileShareJSON"
|
||||
},
|
||||
"; }; listShares: { shares: ",
|
||||
{
|
||||
"pluginId": "files",
|
||||
"scope": "common",
|
||||
"docId": "kibFilesPluginApi",
|
||||
"section": "def-common.FileShareJSON",
|
||||
"text": "FileShareJSON"
|
||||
},
|
||||
"[]; }; getMetrics: ",
|
||||
{
|
||||
"pluginId": "files",
|
||||
"scope": "common",
|
||||
"docId": "kibFilesPluginApi",
|
||||
"section": "def-common.FilesMetrics",
|
||||
"text": "FilesMetrics"
|
||||
},
|
||||
"; publicDownload: any; getDownloadHref: string; }"
|
||||
],
|
||||
"path": "x-pack/plugins/files/public/types.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": [],
|
||||
"start": {
|
||||
"parentPluginId": "files",
|
||||
"id": "def-public.FilesStart",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "FilesStart",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "files",
|
||||
"scope": "public",
|
||||
"docId": "kibFilesPluginApi",
|
||||
"section": "def-public.FilesSetup",
|
||||
"text": "FilesSetup"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/files/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"lifecycle": "start",
|
||||
"initialIsOpen": true
|
||||
}
|
||||
},
|
||||
"server": {
|
||||
"classes": [],
|
||||
|
|
@ -5349,10 +5504,12 @@
|
|||
"parentPluginId": "files",
|
||||
"id": "def-common.FileKind.maxSizeBytes",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"tags": [
|
||||
"default"
|
||||
],
|
||||
"label": "maxSizeBytes",
|
||||
"description": [
|
||||
"\nMaximum size, in bytes, a file of this kind can be."
|
||||
"\nMaximum size, in bytes, a file of this kind can be.\n"
|
||||
],
|
||||
"signature": [
|
||||
"number | undefined"
|
||||
|
|
|
|||
|
|
@ -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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
|
||||
---
|
||||
import filesObj from './files.devdocs.json';
|
||||
|
|
@ -21,13 +21,19 @@ Contact [@elastic/kibana-app-services](https://github.com/orgs/elastic/teams/tea
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 237 | 0 | 3 | 2 |
|
||||
| 243 | 0 | 6 | 2 |
|
||||
|
||||
## Client
|
||||
|
||||
### Start
|
||||
<DocDefinitionList data={[filesObj.client.start]}/>
|
||||
|
||||
### Interfaces
|
||||
<DocDefinitionList data={filesObj.client.interfaces}/>
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={filesObj.client.misc}/>
|
||||
|
||||
## Server
|
||||
|
||||
### Setup
|
||||
|
|
|
|||
|
|
@ -5302,6 +5302,60 @@
|
|||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-server.PackagePolicyServiceInterface.findAllForAgentPolicy",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "findAllForAgentPolicy",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(soClient: ",
|
||||
"SavedObjectsClientContract",
|
||||
", agentPolicyId: string) => Promise<",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.PackagePolicy",
|
||||
"text": "PackagePolicy"
|
||||
},
|
||||
"[]>"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/server/services/package_policy.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-server.PackagePolicyServiceInterface.findAllForAgentPolicy.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "soClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SavedObjectsClientContract"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/server/services/package_policy.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-server.PackagePolicyServiceInterface.findAllForAgentPolicy.$2",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "agentPolicyId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/server/services/package_policy.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-server.PackagePolicyServiceInterface.getByIDs",
|
||||
|
|
@ -7462,12 +7516,11 @@
|
|||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.AgentPolicy.package_policies",
|
||||
"type": "CompoundType",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "package_policies",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string[] | ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
|
|
@ -7475,7 +7528,7 @@
|
|||
"section": "def-common.PackagePolicy",
|
||||
"text": "PackagePolicy"
|
||||
},
|
||||
"[]"
|
||||
"[] | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -9793,7 +9846,7 @@
|
|||
"label": "install_source",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"registry\" | \"upload\" | \"bundled\""
|
||||
"\"upload\" | \"registry\" | \"bundled\""
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -9943,7 +9996,7 @@
|
|||
"label": "installSource",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"registry\" | \"upload\" | \"bundled\""
|
||||
"\"upload\" | \"registry\" | \"bundled\""
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -12867,6 +12920,52 @@
|
|||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.BulkGetAgentPoliciesResponse",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "BulkGetAgentPoliciesResponse",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"BulkGetResult",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.GetAgentPoliciesResponseItem",
|
||||
"text": "GetAgentPoliciesResponseItem"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.BulkGetPackagePoliciesResponse",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "BulkGetPackagePoliciesResponse",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"BulkGetResult",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.PackagePolicy",
|
||||
"text": "PackagePolicy"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.DeletePackagePoliciesResponse",
|
||||
|
|
@ -14425,6 +14524,21 @@
|
|||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.agentPolicyRouteService.getBulkGetPath",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getBulkGetPath",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => string"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/common/services/routes.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-common.agentPolicyRouteService.getInfoPath",
|
||||
|
|
|
|||
|
|
@ -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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
|
||||
---
|
||||
import fleetObj from './fleet.devdocs.json';
|
||||
|
|
@ -21,7 +21,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 961 | 3 | 866 | 9 |
|
||||
| 967 | 3 | 872 | 10 |
|
||||
|
||||
## 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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
|
||||
---
|
||||
import globalSearchObj from './global_search.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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
|
||||
---
|
||||
import homeObj from './home.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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
|
||||
---
|
||||
import indexManagementObj from './index_management.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/infra
|
|||
title: "infra"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the infra plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
|
||||
---
|
||||
import infraObj from './infra.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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
|
||||
---
|
||||
import inspectorObj from './inspector.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/interactiveSetup
|
|||
title: "interactiveSetup"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the interactiveSetup plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
|
||||
---
|
||||
import interactiveSetupObj from './interactive_setup.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ace
|
|||
title: "@kbn/ace"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/ace plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace']
|
||||
---
|
||||
import kbnAceObj from './kbn_ace.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: 2022-08-23
|
||||
date: 2022-08-24
|
||||
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-utils
|
|||
title: "@kbn/aiops-utils"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/aiops-utils plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils']
|
||||
---
|
||||
import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts
|
|||
title: "@kbn/alerts"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/alerts plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts']
|
||||
---
|
||||
import kbnAlertsObj from './kbn_alerts.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics
|
|||
title: "@kbn/analytics"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/analytics plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics']
|
||||
---
|
||||
import kbnAnalyticsObj from './kbn_analytics.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client
|
|||
title: "@kbn/analytics-client"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/analytics-client plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client']
|
||||
---
|
||||
import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-browser
|
|||
title: "@kbn/analytics-shippers-elastic-v3-browser"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser']
|
||||
---
|
||||
import kbnAnalyticsShippersElasticV3BrowserObj from './kbn_analytics_shippers_elastic_v3_browser.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-common
|
|||
title: "@kbn/analytics-shippers-elastic-v3-common"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common']
|
||||
---
|
||||
import kbnAnalyticsShippersElasticV3CommonObj from './kbn_analytics_shippers_elastic_v3_common.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-server
|
|||
title: "@kbn/analytics-shippers-elastic-v3-server"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server']
|
||||
---
|
||||
import kbnAnalyticsShippersElasticV3ServerObj from './kbn_analytics_shippers_elastic_v3_server.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory
|
|||
title: "@kbn/analytics-shippers-fullstory"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/analytics-shippers-fullstory plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory']
|
||||
---
|
||||
import kbnAnalyticsShippersFullstoryObj from './kbn_analytics_shippers_fullstory.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader
|
|||
title: "@kbn/apm-config-loader"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/apm-config-loader plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader']
|
||||
---
|
||||
import kbnApmConfigLoaderObj from './kbn_apm_config_loader.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -1301,6 +1301,20 @@
|
|||
],
|
||||
"path": "packages/kbn-apm-synthtrace/src/lib/apm/index.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/apm-synthtrace",
|
||||
"id": "def-server.apm.ApmSynthtraceKibanaClient",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "ApmSynthtraceKibanaClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"typeof ",
|
||||
"ApmSynthtraceKibanaClient"
|
||||
],
|
||||
"path": "packages/kbn-apm-synthtrace/src/lib/apm/index.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace
|
|||
title: "@kbn/apm-synthtrace"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/apm-synthtrace plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace']
|
||||
---
|
||||
import kbnApmSynthtraceObj from './kbn_apm_synthtrace.devdocs.json';
|
||||
|
|
@ -21,7 +21,7 @@ Contact [Owner missing] for questions regarding this plugin.
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 74 | 0 | 74 | 11 |
|
||||
| 75 | 0 | 75 | 12 |
|
||||
|
||||
## Server
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils
|
|||
title: "@kbn/apm-utils"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/apm-utils plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils']
|
||||
---
|
||||
import kbnApmUtilsObj from './kbn_apm_utils.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config
|
|||
title: "@kbn/axe-config"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/axe-config plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config']
|
||||
---
|
||||
import kbnAxeConfigObj from './kbn_axe_config.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -1,333 +0,0 @@
|
|||
{
|
||||
"id": "@kbn/bazel-packages",
|
||||
"client": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"server": {
|
||||
"classes": [
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.BazelPackage",
|
||||
"type": "Class",
|
||||
"tags": [],
|
||||
"label": "BazelPackage",
|
||||
"description": [
|
||||
"\nRepresentation of a Bazel Package in the Kibana repository"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/bazel_package.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.BazelPackage.fromDir",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "fromDir",
|
||||
"description": [
|
||||
"\nCreate a BazelPackage object from a package directory. Reads some files from the package and returns\na Promise for a BazelPackage instance."
|
||||
],
|
||||
"signature": [
|
||||
"(dir: string) => Promise<",
|
||||
{
|
||||
"pluginId": "@kbn/bazel-packages",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnBazelPackagesPluginApi",
|
||||
"section": "def-server.BazelPackage",
|
||||
"text": "BazelPackage"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/bazel_package.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.BazelPackage.fromDir.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "dir",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/bazel_package.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.BazelPackage.Unnamed",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "Constructor",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/bazel_package.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.BazelPackage.Unnamed.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "normalizedRepoRelativeDir",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/bazel_package.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.BazelPackage.Unnamed.$2",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "pkg",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ParsedPackageJson"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/bazel_package.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.BazelPackage.Unnamed.$3",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "buildBazelContent",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/bazel_package.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.BazelPackage.hasBuildRule",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "hasBuildRule",
|
||||
"description": [
|
||||
"\nReturns true if the package includes a `:build` bazel rule"
|
||||
],
|
||||
"signature": [
|
||||
"() => boolean"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/bazel_package.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.BazelPackage.hasBuildTypesRule",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "hasBuildTypesRule",
|
||||
"description": [
|
||||
"\nReturns true if the package includes a `:build_types` bazel rule"
|
||||
],
|
||||
"signature": [
|
||||
"() => boolean"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/bazel_package.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.BazelPackage.isDevOnly",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "isDevOnly",
|
||||
"description": [
|
||||
"\nReturns true if the package is not intended to be in the build"
|
||||
],
|
||||
"signature": [
|
||||
"() => boolean"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/bazel_package.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.BazelPackage.inspect.custom",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "[inspect.custom]",
|
||||
"description": [
|
||||
"\nCustom inspect handler so that logging variables in scripts/generate doesn't\nprint all the BUILD.bazel files"
|
||||
],
|
||||
"signature": [
|
||||
"() => string"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/bazel_package.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.discoverBazelPackageLocations",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "discoverBazelPackageLocations",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(repoRoot: string) => string[]"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/discover_packages.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.discoverBazelPackageLocations.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "repoRoot",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/discover_packages.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.discoverBazelPackages",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "discoverBazelPackages",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(repoRoot: string) => Promise<",
|
||||
{
|
||||
"pluginId": "@kbn/bazel-packages",
|
||||
"scope": "server",
|
||||
"docId": "kibKbnBazelPackagesPluginApi",
|
||||
"section": "def-server.BazelPackage",
|
||||
"text": "BazelPackage"
|
||||
},
|
||||
"[]>"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/discover_packages.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.discoverBazelPackages.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "repoRoot",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/discover_packages.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.getAllBazelPackageDirs",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getAllBazelPackageDirs",
|
||||
"description": [
|
||||
"\nResolve all the BAZEL_PACKAGE_DIRS to absolute paths"
|
||||
],
|
||||
"signature": [
|
||||
"() => string[]"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/bazel_package_dirs.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.getAllRepoRelativeBazelPackageDirs",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getAllRepoRelativeBazelPackageDirs",
|
||||
"description": [
|
||||
"\nResolve all the BAZEL_PACKAGE_DIRS to repo-relative paths"
|
||||
],
|
||||
"signature": [
|
||||
"() => string[]"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/bazel_package_dirs.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "@kbn/bazel-packages",
|
||||
"id": "def-server.BAZEL_PACKAGE_DIRS",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "BAZEL_PACKAGE_DIRS",
|
||||
"description": [
|
||||
"\nThis is a list of repo-relative paths to directories containing packages. Do not\ninclude `**` in these, one or two `*` segments is acceptable, we need this search\nto be super fast so please avoid deep recursive searching.\n\n eg. src/vis_editors => would find a package at src/vis_editors/foo/package.json\n src/vis_editors/* => would find a package at src/vis_editors/foo/bar/package.json"
|
||||
],
|
||||
"signature": [
|
||||
"string[]"
|
||||
],
|
||||
"path": "packages/kbn-bazel-packages/src/bazel_package_dirs.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": []
|
||||
},
|
||||
"common": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
}
|
||||
}
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
---
|
||||
####
|
||||
#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
|
||||
#### Reach out in #docs-engineering for more info.
|
||||
####
|
||||
id: kibKbnBazelPackagesPluginApi
|
||||
slug: /kibana-dev-docs/api/kbn-bazel-packages
|
||||
title: "@kbn/bazel-packages"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/bazel-packages plugin
|
||||
date: 2022-08-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-packages']
|
||||
---
|
||||
import kbnBazelPackagesObj from './kbn_bazel_packages.devdocs.json';
|
||||
|
||||
|
||||
|
||||
Contact [Owner missing] for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 18 | 0 | 9 | 1 |
|
||||
|
||||
## Server
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={kbnBazelPackagesObj.server.functions}/>
|
||||
|
||||
### Classes
|
||||
<DocDefinitionList data={kbnBazelPackagesObj.server.classes}/>
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={kbnBazelPackagesObj.server.misc}/>
|
||||
|
||||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-chart-icons
|
|||
title: "@kbn/chart-icons"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/chart-icons plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/chart-icons']
|
||||
---
|
||||
import kbnChartIconsObj from './kbn_chart_icons.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core
|
|||
title: "@kbn/ci-stats-core"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/ci-stats-core plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core']
|
||||
---
|
||||
import kbnCiStatsCoreObj from './kbn_ci_stats_core.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-performance-metrics
|
|||
title: "@kbn/ci-stats-performance-metrics"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/ci-stats-performance-metrics plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-performance-metrics']
|
||||
---
|
||||
import kbnCiStatsPerformanceMetricsObj from './kbn_ci_stats_performance_metrics.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter
|
|||
title: "@kbn/ci-stats-reporter"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/ci-stats-reporter plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter']
|
||||
---
|
||||
import kbnCiStatsReporterObj from './kbn_ci_stats_reporter.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode
|
|||
title: "@kbn/cli-dev-mode"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/cli-dev-mode plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode']
|
||||
---
|
||||
import kbnCliDevModeObj from './kbn_cli_dev_mode.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -157,7 +157,7 @@
|
|||
"signature": [
|
||||
"React.ExoticComponent<",
|
||||
"CustomizablePaletteProps",
|
||||
"> & { readonly _result: ({ palettes, activePalette, setPalette, dataBounds, showExtraActions, showRangeTypeSelector, disableSwitchingContinuity, }: ",
|
||||
"> & { readonly _result: ({ palettes, activePalette, setPalette, dataBounds, showExtraActions, showRangeTypeSelector, disableSwitchingContinuity, displayInfinity, }: ",
|
||||
"CustomizablePaletteProps",
|
||||
") => JSX.Element; }"
|
||||
],
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-coloring
|
|||
title: "@kbn/coloring"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/coloring plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring']
|
||||
---
|
||||
import kbnColoringObj from './kbn_coloring.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config
|
|||
title: "@kbn/config"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/config plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config']
|
||||
---
|
||||
import kbnConfigObj from './kbn_config.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config-mocks
|
|||
title: "@kbn/config-mocks"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/config-mocks plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-mocks']
|
||||
---
|
||||
import kbnConfigMocksObj from './kbn_config_mocks.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema
|
|||
title: "@kbn/config-schema"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/config-schema plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema']
|
||||
---
|
||||
import kbnConfigSchemaObj from './kbn_config_schema.devdocs.json';
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser
|
|||
title: "@kbn/core-analytics-browser"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
description: API docs for the @kbn/core-analytics-browser plugin
|
||||
date: 2022-08-23
|
||||
date: 2022-08-24
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser']
|
||||
---
|
||||
import kbnCoreAnalyticsBrowserObj from './kbn_core_analytics_browser.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