mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
[api-docs] Daily api_docs build (#134973)
This commit is contained in:
Kibana Machine
GitHub
parent
da2315225c
commit
52fa9c391f
266 changed files with 1581 additions and 284 deletions
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/actions
|
|||
title: "actions"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the actions plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/advancedSettings
|
|||
title: "advancedSettings"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the advancedSettings plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/aiops
|
|||
title: "aiops"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the aiops plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/alerting
|
|||
title: "alerting"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the alerting plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/apm
|
|||
title: "apm"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the apm plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/banners
|
|||
title: "banners"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the banners plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/bfetch
|
|||
title: "bfetch"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the bfetch plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/canvas
|
|||
title: "canvas"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the canvas plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cases
|
|||
title: "cases"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the cases plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/charts
|
|||
title: "charts"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the charts plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloud
|
|||
title: "cloud"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the cloud plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture
|
|||
title: "cloudSecurityPosture"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the cloudSecurityPosture plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/console
|
|||
title: "console"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the console plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/controls
|
|||
title: "controls"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the controls plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1583,13 +1583,7 @@
|
|||
"{@link I18nStart}"
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-public.I18nStart",
|
||||
"text": "I18nStart"
|
||||
}
|
||||
"I18nStart"
|
||||
],
|
||||
"path": "src/core/public/index.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -2647,9 +2641,9 @@
|
|||
"tags": [],
|
||||
"label": "I18nStart",
|
||||
"description": [
|
||||
"\nI18nStart.Context is required by any localizable React component from \\@kbn/i18n and \\@elastic/eui packages\nand is supposed to be used as the topmost component for any i18n-compatible React tree.\n"
|
||||
"\r\nI18nStart.Context is required by any localizable React component from \\@kbn/i18n and \\@elastic/eui packages\r\nand is supposed to be used as the topmost component for any i18n-compatible React tree.\r\n"
|
||||
],
|
||||
"path": "src/core/public/i18n/i18n_service.tsx",
|
||||
"path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
|
|
@ -2659,12 +2653,12 @@
|
|||
"tags": [],
|
||||
"label": "Context",
|
||||
"description": [
|
||||
"\nReact Context provider required as the topmost component for any i18n-compatible React tree."
|
||||
"\r\nReact Context provider required as the topmost component for any i18n-compatible React tree."
|
||||
],
|
||||
"signature": [
|
||||
"({ children }: { children: React.ReactNode; }) => JSX.Element"
|
||||
],
|
||||
"path": "src/core/public/i18n/i18n_service.tsx",
|
||||
"path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
|
|
@ -2674,7 +2668,7 @@
|
|||
"tags": [],
|
||||
"label": "{ children }",
|
||||
"description": [],
|
||||
"path": "src/core/public/i18n/i18n_service.tsx",
|
||||
"path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
|
|
@ -2687,7 +2681,7 @@
|
|||
"signature": [
|
||||
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
|
||||
],
|
||||
"path": "src/core/public/i18n/i18n_service.tsx",
|
||||
"path": "node_modules/@types/kbn__core-i18n-browser/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
|
|
@ -24176,7 +24170,7 @@
|
|||
"tags": [],
|
||||
"label": "AnalyticsServicePreboot",
|
||||
"description": [
|
||||
"\nExposes the public APIs of the AnalyticsClient during the preboot phase\n{@link AnalyticsClient}"
|
||||
"\r\nExposes the public APIs of the AnalyticsClient during the preboot phase\r\n{@link AnalyticsClient}"
|
||||
],
|
||||
"signature": [
|
||||
"{ optIn: (optInConfig: ",
|
||||
|
|
@ -24197,7 +24191,7 @@
|
|||
"ContextProviderOpts",
|
||||
"<Context>) => void; removeContextProvider: (contextProviderName: string) => void; }"
|
||||
],
|
||||
"path": "src/core/server/analytics/analytics_service.ts",
|
||||
"path": "node_modules/@types/kbn__core-analytics-server/index.d.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
|
|
@ -24208,7 +24202,7 @@
|
|||
"tags": [],
|
||||
"label": "AnalyticsServiceSetup",
|
||||
"description": [
|
||||
"\nExposes the public APIs of the AnalyticsClient during the setup phase.\n{@link AnalyticsClient}"
|
||||
"\r\nExposes the public APIs of the AnalyticsClient during the setup phase.\r\n{@link AnalyticsClient}"
|
||||
],
|
||||
"signature": [
|
||||
"{ optIn: (optInConfig: ",
|
||||
|
|
@ -24229,7 +24223,7 @@
|
|||
"ContextProviderOpts",
|
||||
"<Context>) => void; removeContextProvider: (contextProviderName: string) => void; }"
|
||||
],
|
||||
"path": "src/core/server/analytics/analytics_service.ts",
|
||||
"path": "node_modules/@types/kbn__core-analytics-server/index.d.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
|
|
@ -24240,7 +24234,7 @@
|
|||
"tags": [],
|
||||
"label": "AnalyticsServiceStart",
|
||||
"description": [
|
||||
"\nExposes the public APIs of the AnalyticsClient during the start phase\n{@link AnalyticsClient}"
|
||||
"\r\nExposes the public APIs of the AnalyticsClient during the start phase\r\n{@link AnalyticsClient}"
|
||||
],
|
||||
"signature": [
|
||||
"{ optIn: (optInConfig: ",
|
||||
|
|
@ -24251,7 +24245,7 @@
|
|||
"TelemetryCounter",
|
||||
">; }"
|
||||
],
|
||||
"path": "src/core/server/analytics/analytics_service.ts",
|
||||
"path": "node_modules/@types/kbn__core-analytics-server/index.d.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core
|
|||
title: "core"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the core plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2527 | 15 | 940 | 29 |
|
||||
| 2527 | 15 | 938 | 29 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-application
|
|||
title: "core.application"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the core.application plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2527 | 15 | 940 | 29 |
|
||||
| 2527 | 15 | 938 | 29 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-chrome
|
|||
title: "core.chrome"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the core.chrome plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2527 | 15 | 940 | 29 |
|
||||
| 2527 | 15 | 938 | 29 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-http
|
|||
title: "core.http"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the core.http plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.http']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2527 | 15 | 940 | 29 |
|
||||
| 2527 | 15 | 938 | 29 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-savedObjects
|
|||
title: "core.savedObjects"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the core.savedObjects plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.savedObjects']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2527 | 15 | 940 | 29 |
|
||||
| 2527 | 15 | 938 | 29 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/customIntegrations
|
|||
title: "customIntegrations"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the customIntegrations plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboard
|
|||
title: "dashboard"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the dashboard plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced
|
|||
title: "dashboardEnhanced"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the dashboardEnhanced plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data
|
|||
title: "data"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the data plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-query
|
|||
title: "data.query"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the data.query plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-search
|
|||
title: "data.search"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the data.search plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewEditor
|
|||
title: "dataViewEditor"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the dataViewEditor plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor
|
|||
title: "dataViewFieldEditor"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the dataViewFieldEditor plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewManagement
|
|||
title: "dataViewManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the dataViewManagement plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViews
|
|||
title: "dataViews"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the dataViews plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataVisualizer
|
|||
title: "dataVisualizer"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the dataVisualizer plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByApi
|
|||
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
|
||||
title: Deprecated API usage by API
|
||||
summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByPlugin
|
|||
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
|
||||
title: Deprecated API usage by plugin
|
||||
summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsDueByTeam
|
|||
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
|
||||
title: Deprecated APIs due to be removed, by team
|
||||
summary: Lists the teams that are referencing deprecated APIs with a remove by date.
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/devTools
|
|||
title: "devTools"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the devTools plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discover
|
|||
title: "discover"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the discover plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced
|
|||
title: "discoverEnhanced"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the discoverEnhanced plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/elastic-apm-synthtrace
|
|||
title: "@elastic/apm-synthtrace"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @elastic/apm-synthtrace plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/apm-synthtrace']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddable
|
|||
title: "embeddable"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the embeddable plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced
|
|||
title: "embeddableEnhanced"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the embeddableEnhanced plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects
|
|||
title: "encryptedSavedObjects"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the encryptedSavedObjects plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch
|
|||
title: "enterpriseSearch"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the enterpriseSearch plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/esUiShared
|
|||
title: "esUiShared"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the esUiShared plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventAnnotation
|
|||
title: "eventAnnotation"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the eventAnnotation plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventLog
|
|||
title: "eventLog"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the eventLog plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionError
|
|||
title: "expressionError"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionError plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionGauge
|
|||
title: "expressionGauge"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionGauge plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap
|
|||
title: "expressionHeatmap"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionHeatmap plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionImage
|
|||
title: "expressionImage"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionImage plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetric
|
|||
title: "expressionMetric"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionMetric plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis
|
|||
title: "expressionMetricVis"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionMetricVis plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis
|
|||
title: "expressionPartitionVis"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionPartitionVis plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage
|
|||
title: "expressionRepeatImage"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionRepeatImage plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage
|
|||
title: "expressionRevealImage"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionRevealImage plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionShape
|
|||
title: "expressionShape"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionShape plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud
|
|||
title: "expressionTagcloud"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionTagcloud plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionXY
|
|||
title: "expressionXY"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionXY plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressions
|
|||
title: "expressions"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressions plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/features
|
|||
title: "features"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the features plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fieldFormats
|
|||
title: "fieldFormats"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the fieldFormats plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fileUpload
|
|||
title: "fileUpload"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the fileUpload plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fleet
|
|||
title: "fleet"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the fleet plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/globalSearch
|
|||
title: "globalSearch"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the globalSearch plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/home
|
|||
title: "home"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the home plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement
|
|||
title: "indexLifecycleManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the indexLifecycleManagement plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexManagement
|
|||
title: "indexManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the indexManagement plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/infra
|
|||
title: "infra"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the infra plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/inspector
|
|||
title: "inspector"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the inspector plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/interactiveSetup
|
|||
title: "interactiveSetup"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the interactiveSetup plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ace
|
|||
title: "@kbn/ace"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/ace plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils
|
|||
title: "@kbn/aiops-utils"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/aiops-utils plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-alerts
|
|||
title: "@kbn/alerts"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/alerts plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics
|
|||
title: "@kbn/analytics"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/analytics plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client
|
|||
title: "@kbn/analytics-client"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/analytics-client plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,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
|
||||
summary: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,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
|
||||
summary: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,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
|
||||
summary: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory
|
|||
title: "@kbn/analytics-shippers-fullstory"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/analytics-shippers-fullstory plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader
|
|||
title: "@kbn/apm-config-loader"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/apm-config-loader plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils
|
|||
title: "@kbn/apm-utils"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/apm-utils plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config
|
|||
title: "@kbn/axe-config"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/axe-config plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-packages
|
|||
title: "@kbn/bazel-packages"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/bazel-packages plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-packages']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-runner
|
|||
title: "@kbn/bazel-runner"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/bazel-runner plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-runner']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core
|
|||
title: "@kbn/ci-stats-core"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/ci-stats-core plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
75
api_docs/kbn_ci_stats_performance_metrics.devdocs.json
Normal file
75
api_docs/kbn_ci_stats_performance_metrics.devdocs.json
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
{
|
||||
"id": "@kbn/ci-stats-performance-metrics",
|
||||
"client": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"server": {
|
||||
"classes": [],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "@kbn/ci-stats-performance-metrics",
|
||||
"id": "def-server.reporter",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "reporter",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(options: ReporterOptions) => Promise<void>"
|
||||
],
|
||||
"path": "packages/kbn-ci-stats-performance-metrics/src/reporter.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/ci-stats-performance-metrics",
|
||||
"id": "def-server.reporter.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ReporterOptions"
|
||||
],
|
||||
"path": "packages/kbn-ci-stats-performance-metrics/src/reporter.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/ci-stats-performance-metrics",
|
||||
"id": "def-server.runCli",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "runCli",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => Promise<void>"
|
||||
],
|
||||
"path": "packages/kbn-ci-stats-performance-metrics/src/cli.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"common": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
}
|
||||
}
|
||||
27
api_docs/kbn_ci_stats_performance_metrics.mdx
Normal file
27
api_docs/kbn_ci_stats_performance_metrics.mdx
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
id: kibKbnCiStatsPerformanceMetricsPluginApi
|
||||
slug: /kibana-dev-docs/api/kbn-ci-stats-performance-metrics
|
||||
title: "@kbn/ci-stats-performance-metrics"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/ci-stats-performance-metrics plugin
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-performance-metrics']
|
||||
warning: 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.
|
||||
---
|
||||
import kbnCiStatsPerformanceMetricsObj from './kbn_ci_stats_performance_metrics.devdocs.json';
|
||||
|
||||
|
||||
|
||||
Contact [Owner missing] for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3 | 0 | 3 | 0 |
|
||||
|
||||
## Server
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={kbnCiStatsPerformanceMetricsObj.server.functions}/>
|
||||
|
||||
|
|
@ -309,6 +309,38 @@
|
|||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/ci-stats-reporter",
|
||||
"id": "def-server.CiStatsReporter.reportPerformanceMetrics",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "reportPerformanceMetrics",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(metrics: ",
|
||||
"PerformanceMetrics",
|
||||
") => Promise<boolean | undefined>"
|
||||
],
|
||||
"path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/ci-stats-reporter",
|
||||
"id": "def-server.CiStatsReporter.reportPerformanceMetrics.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "metrics",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"PerformanceMetrics"
|
||||
],
|
||||
"path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter
|
|||
title: "@kbn/ci-stats-reporter"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/ci-stats-reporter plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin.
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 60 | 0 | 15 | 0 |
|
||||
| 62 | 0 | 17 | 1 |
|
||||
|
||||
## Server
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode
|
|||
title: "@kbn/cli-dev-mode"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/cli-dev-mode plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-coloring
|
|||
title: "@kbn/coloring"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/coloring plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config
|
|||
title: "@kbn/config"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/config plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-mocks
|
|||
title: "@kbn/config-mocks"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/config-mocks plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-mocks']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema
|
|||
title: "@kbn/config-schema"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/config-schema plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser
|
|||
title: "@kbn/core-analytics-browser"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/core-analytics-browser plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-internal
|
|||
title: "@kbn/core-analytics-browser-internal"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/core-analytics-browser-internal plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-internal']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-mocks
|
|||
title: "@kbn/core-analytics-browser-mocks"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/core-analytics-browser-mocks plugin
|
||||
date: 2022-06-22
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-mocks']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
114
api_docs/kbn_core_analytics_server.devdocs.json
Normal file
114
api_docs/kbn_core_analytics_server.devdocs.json
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
{
|
||||
"id": "@kbn/core-analytics-server",
|
||||
"client": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"server": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [
|
||||
{
|
||||
"parentPluginId": "@kbn/core-analytics-server",
|
||||
"id": "def-server.AnalyticsServicePreboot",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "AnalyticsServicePreboot",
|
||||
"description": [
|
||||
"\nExposes the public APIs of the AnalyticsClient during the preboot phase\n{@link AnalyticsClient}"
|
||||
],
|
||||
"signature": [
|
||||
"{ optIn: (optInConfig: ",
|
||||
"OptInConfig",
|
||||
") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
|
||||
"Observable",
|
||||
"<",
|
||||
"TelemetryCounter",
|
||||
">; registerEventType: <EventTypeData>(eventTypeOps: ",
|
||||
"EventTypeOpts",
|
||||
"<EventTypeData>) => void; registerShipper: <Shipper extends ",
|
||||
"IShipper",
|
||||
", ShipperConfig>(Shipper: ",
|
||||
"ShipperClassConstructor",
|
||||
"<Shipper, ShipperConfig>, shipperConfig: ShipperConfig, opts?: ",
|
||||
"RegisterShipperOpts",
|
||||
" | undefined) => void; registerContextProvider: <Context>(contextProviderOpts: ",
|
||||
"ContextProviderOpts",
|
||||
"<Context>) => void; removeContextProvider: (contextProviderName: string) => void; }"
|
||||
],
|
||||
"path": "packages/core/analytics/core-analytics-server/src/contracts.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/core-analytics-server",
|
||||
"id": "def-server.AnalyticsServiceSetup",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "AnalyticsServiceSetup",
|
||||
"description": [
|
||||
"\nExposes the public APIs of the AnalyticsClient during the setup phase.\n{@link AnalyticsClient}"
|
||||
],
|
||||
"signature": [
|
||||
"{ optIn: (optInConfig: ",
|
||||
"OptInConfig",
|
||||
") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
|
||||
"Observable",
|
||||
"<",
|
||||
"TelemetryCounter",
|
||||
">; registerEventType: <EventTypeData>(eventTypeOps: ",
|
||||
"EventTypeOpts",
|
||||
"<EventTypeData>) => void; registerShipper: <Shipper extends ",
|
||||
"IShipper",
|
||||
", ShipperConfig>(Shipper: ",
|
||||
"ShipperClassConstructor",
|
||||
"<Shipper, ShipperConfig>, shipperConfig: ShipperConfig, opts?: ",
|
||||
"RegisterShipperOpts",
|
||||
" | undefined) => void; registerContextProvider: <Context>(contextProviderOpts: ",
|
||||
"ContextProviderOpts",
|
||||
"<Context>) => void; removeContextProvider: (contextProviderName: string) => void; }"
|
||||
],
|
||||
"path": "packages/core/analytics/core-analytics-server/src/contracts.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/core-analytics-server",
|
||||
"id": "def-server.AnalyticsServiceStart",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "AnalyticsServiceStart",
|
||||
"description": [
|
||||
"\nExposes the public APIs of the AnalyticsClient during the start phase\n{@link AnalyticsClient}"
|
||||
],
|
||||
"signature": [
|
||||
"{ optIn: (optInConfig: ",
|
||||
"OptInConfig",
|
||||
") => void; reportEvent: <EventTypeData extends Record<string, unknown>>(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ",
|
||||
"Observable",
|
||||
"<",
|
||||
"TelemetryCounter",
|
||||
">; }"
|
||||
],
|
||||
"path": "packages/core/analytics/core-analytics-server/src/contracts.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": []
|
||||
},
|
||||
"common": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
}
|
||||
}
|
||||
27
api_docs/kbn_core_analytics_server.mdx
Normal file
27
api_docs/kbn_core_analytics_server.mdx
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
id: kibKbnCoreAnalyticsServerPluginApi
|
||||
slug: /kibana-dev-docs/api/kbn-core-analytics-server
|
||||
title: "@kbn/core-analytics-server"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/core-analytics-server plugin
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server']
|
||||
warning: 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.
|
||||
---
|
||||
import kbnCoreAnalyticsServerObj from './kbn_core_analytics_server.devdocs.json';
|
||||
|
||||
|
||||
|
||||
Contact [Owner missing] for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3 | 0 | 0 | 0 |
|
||||
|
||||
## Server
|
||||
|
||||
### Consts, variables and types
|
||||
<DocDefinitionList data={kbnCoreAnalyticsServerObj.server.misc}/>
|
||||
|
||||
134
api_docs/kbn_core_analytics_server_internal.devdocs.json
Normal file
134
api_docs/kbn_core_analytics_server_internal.devdocs.json
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
{
|
||||
"id": "@kbn/core-analytics-server-internal",
|
||||
"client": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"server": {
|
||||
"classes": [
|
||||
{
|
||||
"parentPluginId": "@kbn/core-analytics-server-internal",
|
||||
"id": "def-server.AnalyticsService",
|
||||
"type": "Class",
|
||||
"tags": [],
|
||||
"label": "AnalyticsService",
|
||||
"description": [],
|
||||
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/core-analytics-server-internal",
|
||||
"id": "def-server.AnalyticsService.Unnamed",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "Constructor",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/core-analytics-server-internal",
|
||||
"id": "def-server.AnalyticsService.Unnamed.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "core",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"CoreContext"
|
||||
],
|
||||
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/core-analytics-server-internal",
|
||||
"id": "def-server.AnalyticsService.preboot",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "preboot",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
"AnalyticsServicePreboot"
|
||||
],
|
||||
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/core-analytics-server-internal",
|
||||
"id": "def-server.AnalyticsService.setup",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "setup",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
"AnalyticsServiceSetup"
|
||||
],
|
||||
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/core-analytics-server-internal",
|
||||
"id": "def-server.AnalyticsService.start",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "start",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => ",
|
||||
"AnalyticsServiceStart"
|
||||
],
|
||||
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/core-analytics-server-internal",
|
||||
"id": "def-server.AnalyticsService.stop",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "stop",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => void"
|
||||
],
|
||||
"path": "packages/core/analytics/core-analytics-server-internal/src/analytics_service.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
},
|
||||
"common": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
"objects": []
|
||||
}
|
||||
}
|
||||
27
api_docs/kbn_core_analytics_server_internal.mdx
Normal file
27
api_docs/kbn_core_analytics_server_internal.mdx
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
id: kibKbnCoreAnalyticsServerInternalPluginApi
|
||||
slug: /kibana-dev-docs/api/kbn-core-analytics-server-internal
|
||||
title: "@kbn/core-analytics-server-internal"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/core-analytics-server-internal plugin
|
||||
date: 2022-06-23
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-internal']
|
||||
warning: 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.
|
||||
---
|
||||
import kbnCoreAnalyticsServerInternalObj from './kbn_core_analytics_server_internal.devdocs.json';
|
||||
|
||||
|
||||
|
||||
Contact [Owner missing] for questions regarding this plugin.
|
||||
|
||||
**Code health stats**
|
||||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 7 | 0 | 7 | 0 |
|
||||
|
||||
## Server
|
||||
|
||||
### Classes
|
||||
<DocDefinitionList data={kbnCoreAnalyticsServerInternalObj.server.classes}/>
|
||||
|
||||
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