[api-docs] Daily api_docs build (#135878)

This commit is contained in:
Kibana Machine 2022-07-07 00:42:52 -04:00 committed by GitHub
parent 380a8b8705
commit dfee1647e8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
298 changed files with 3885 additions and 1102 deletions

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

File diff suppressed because one or more lines are too long

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -490,7 +490,7 @@
"signature": [
"{ features?: Partial<",
"CasesContextFeatures",
"> | undefined; basePath?: string | undefined; onClose?: (() => void) | undefined; owner: string[]; userCanCrud: boolean; releasePhase?: ",
"> | undefined; basePath?: string | undefined; onClose?: (() => void) | undefined; owner: string[]; permissions: { all: boolean; read: boolean; }; releasePhase?: ",
"ReleasePhase",
" | undefined; hiddenStatuses?: ",
"CaseStatusWithAllStatus",
@ -518,7 +518,7 @@
"signature": [
"{ features?: Partial<",
"CasesContextFeatures",
"> | undefined; basePath?: string | undefined; owner: string[]; userCanCrud: boolean; onComponentInitialized?: (() => void) | undefined; actionsNavigation?: ",
"> | undefined; basePath?: string | undefined; owner: string[]; permissions: { all: boolean; read: boolean; }; onComponentInitialized?: (() => void) | undefined; actionsNavigation?: ",
"CasesNavigation",
"<string, \"configurable\"> | undefined; ruleDetailsNavigation?: ",
"CasesNavigation",
@ -552,7 +552,7 @@
"signature": [
"{ features?: Partial<",
"CasesContextFeatures",
"> | undefined; basePath?: string | undefined; onClose?: (() => void) | undefined; owner: string[]; userCanCrud: boolean; releasePhase?: ",
"> | undefined; basePath?: string | undefined; onClose?: (() => void) | undefined; owner: string[]; permissions: { all: boolean; read: boolean; }; releasePhase?: ",
"ReleasePhase",
" | undefined; afterCaseCreated?: ((theCase: ",
{
@ -596,7 +596,7 @@
"signature": [
"{ features?: Partial<",
"CasesContextFeatures",
"> | undefined; basePath?: string | undefined; owner: string[]; userCanCrud: boolean; releasePhase?: ",
"> | undefined; basePath?: string | undefined; owner: string[]; permissions: { all: boolean; read: boolean; }; releasePhase?: ",
"ReleasePhase",
" | undefined; maxCasesToShow: number; }"
],

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

File diff suppressed because it is too large Load diff

View file

@ -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-07-06
date: 2022-07-07
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 |
|-------------------|-----------|------------------------|-----------------|
| 2525 | 15 | 914 | 28 |
| 2546 | 15 | 926 | 28 |
## Client

View file

@ -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-07-06
date: 2022-07-07
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 |
|-------------------|-----------|------------------------|-----------------|
| 2525 | 15 | 914 | 28 |
| 2546 | 15 | 926 | 28 |
## Client

View file

@ -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-07-06
date: 2022-07-07
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 |
|-------------------|-----------|------------------------|-----------------|
| 2525 | 15 | 914 | 28 |
| 2546 | 15 | 926 | 28 |
## Client

View file

@ -3216,6 +3216,16 @@
"description": [
"\nKibana HTTP Service provides an abstraction to work with the HTTP stack at the `preboot` stage. This functionality\nallows Kibana to serve user requests even before Kibana becomes fully operational. Only Core and `preboot` plugins\ncan define HTTP routes at this stage.\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.HttpServicePreboot",
"text": "HttpServicePreboot"
},
"<DefaultRequestHandlerType>"
],
"path": "src/core/server/http/types.ts",
"deprecated": false,
"children": [
@ -3229,7 +3239,7 @@
"\nProvides ability to acquire `preboot` {@link IRouter} instance for a particular top-level path and register handler\nfunctions for any number of nested routes.\n"
],
"signature": [
"(path: string, callback: (router: ",
"<ContextType extends DefaultRequestHandlerType = DefaultRequestHandlerType>(path: string, callback: (router: ",
{
"pluginId": "core",
"scope": "server",
@ -3237,15 +3247,7 @@
"section": "def-server.IRouter",
"text": "IRouter"
},
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
">) => void) => void"
"<ContextType>) => void) => void"
],
"path": "src/core/server/http/types.ts",
"deprecated": false,
@ -3280,15 +3282,7 @@
"section": "def-server.IRouter",
"text": "IRouter"
},
"<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
">) => void"
"<ContextType>) => void"
],
"path": "src/core/server/http/types.ts",
"deprecated": false,
@ -3364,6 +3358,16 @@
"description": [
"\nKibana HTTP Service provides own abstraction for work with HTTP stack.\nPlugins don't have direct access to `hapi` server and its primitives anymore. Moreover,\nplugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood.\nThis gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins.\nIf the HTTP Service lacks functionality you need, we are happy to discuss and support your needs.\n"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreHttpPluginApi",
"section": "def-server.HttpServiceSetup",
"text": "HttpServiceSetup"
},
"<DefaultRequestHandlerType>"
],
"path": "src/core/server/http/types.ts",
"deprecated": false,
"children": [
@ -3726,23 +3730,7 @@
"\nProvides ability to declare a handler function for a particular path and HTTP request method.\n"
],
"signature": [
"<Context extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
" = ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
">() => ",
"<Context extends DefaultRequestHandlerType = DefaultRequestHandlerType>() => ",
{
"pluginId": "core",
"scope": "server",
@ -3767,15 +3755,7 @@
"\nRegister a context provider for a route handler."
],
"signature": [
"<Context extends ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
},
", ContextName extends Exclude<keyof Context, \"resolve\">>(contextName: ContextName, provider: ",
"<Context extends DefaultRequestHandlerType, ContextName extends Exclude<keyof Context, \"resolve\">>(contextName: ContextName, provider: ",
{
"pluginId": "core",
"scope": "server",
@ -7042,16 +7022,16 @@
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
"section": "def-server.RequestHandlerContextBase",
"text": "RequestHandlerContextBase"
},
" = ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
"section": "def-server.RequestHandlerContextBase",
"text": "RequestHandlerContextBase"
},
", Method extends ",
{
@ -10691,11 +10671,11 @@
"section": "def-server.OnPreAuthToolkit",
"text": "OnPreAuthToolkit"
},
") => ",
") => Next | ",
"KibanaResponse",
"<any> | Next | Promise<",
"<any> | Promise<Next | ",
"KibanaResponse",
"<any> | Next>"
"<any>>"
],
"path": "src/core/server/http/lifecycle/on_pre_auth.ts",
"deprecated": false,
@ -11147,11 +11127,11 @@
"section": "def-server.OnPreRoutingToolkit",
"text": "OnPreRoutingToolkit"
},
") => OnPreRoutingResult | ",
") => ",
"KibanaResponse",
"<any> | Promise<OnPreRoutingResult | ",
"<any> | OnPreRoutingResult | Promise<",
"KibanaResponse",
"<any>>"
"<any> | OnPreRoutingResult>"
],
"path": "src/core/server/http/lifecycle/on_pre_routing.ts",
"deprecated": false,
@ -11934,16 +11914,16 @@
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
"section": "def-server.RequestHandlerContextBase",
"text": "RequestHandlerContextBase"
},
" = ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.RequestHandlerContext",
"text": "RequestHandlerContext"
"section": "def-server.RequestHandlerContextBase",
"text": "RequestHandlerContextBase"
},
", Method extends ",
{

View file

@ -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-07-06
date: 2022-07-07
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 |
|-------------------|-----------|------------------------|-----------------|
| 2525 | 15 | 914 | 28 |
| 2546 | 15 | 926 | 28 |
## Client

View file

@ -12204,6 +12204,557 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRequestHandlerContext",
"type": "Interface",
"tags": [],
"label": "SavedObjectsRequestHandlerContext",
"description": [
"\nCore's `savedObjects` request handler context."
],
"path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRequestHandlerContext.client",
"type": "Object",
"tags": [],
"label": "client",
"description": [],
"signature": [
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
"SavedObject",
"<T>>; bulkCreate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkCreateObject",
"text": "SavedObjectsBulkCreateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreateOptions",
"text": "SavedObjectsCreateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; checkConflicts: (objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsObject",
"text": "SavedObjectsCheckConflictsObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCheckConflictsResponse",
"text": "SavedObjectsCheckConflictsResponse"
},
">; delete: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsDeleteOptions",
"text": "SavedObjectsDeleteOptions"
},
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsFindResponse",
"text": "SavedObjectsFindResponse"
},
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkGetObject",
"text": "SavedObjectsBulkGetObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResponse",
"text": "SavedObjectsBulkResponse"
},
"<T>>; bulkResolve: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveObject",
"text": "SavedObjectsBulkResolveObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkResolveResponse",
"text": "SavedObjectsBulkResolveResponse"
},
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
"SavedObject",
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsResolveResponse",
"text": "SavedObjectsResolveResponse"
},
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateOptions",
"text": "SavedObjectsUpdateOptions"
},
"<T>) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<T>>; collectMultiNamespaceReferences: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
},
"[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
},
">; updateObjectsSpaces: (objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
"text": "SavedObjectsUpdateObjectsSpacesObject"
},
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
"text": "SavedObjectsUpdateObjectsSpacesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
"text": "SavedObjectsUpdateObjectsSpacesResponse"
},
">; bulkUpdate: <T = unknown>(objects: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateObject",
"text": "SavedObjectsBulkUpdateObject"
},
"<T>[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateOptions",
"text": "SavedObjectsBulkUpdateOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBulkUpdateResponse",
"text": "SavedObjectsBulkUpdateResponse"
},
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
"text": "SavedObjectsRemoveReferencesToOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
"text": "SavedObjectsRemoveReferencesToResponse"
},
">; openPointInTimeForType: (type: string | string[], options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
"text": "SavedObjectsOpenPointInTimeOptions"
},
") => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
"text": "SavedObjectsOpenPointInTimeResponse"
},
">; closePointInTime: (id: string, options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsBaseOptions",
"text": "SavedObjectsBaseOptions"
},
" | undefined) => Promise<",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClosePointInTimeResponse",
"text": "SavedObjectsClosePointInTimeResponse"
},
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderOptions",
"text": "SavedObjectsCreatePointInTimeFinderOptions"
},
", dependencies?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
},
" | undefined) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.ISavedObjectsPointInTimeFinder",
"text": "ISavedObjectsPointInTimeFinder"
},
"<T, A>; errors: typeof ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsErrorHelpers",
"text": "SavedObjectsErrorHelpers"
},
"; }"
],
"path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRequestHandlerContext.typeRegistry",
"type": "Object",
"tags": [],
"label": "typeRegistry",
"description": [],
"signature": [
"{ getType: (type: string) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any> | undefined; getVisibleTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; getAllTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; getImportableAndExportableTypes: () => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsType",
"text": "SavedObjectsType"
},
"<any>[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; isHidden: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }"
],
"path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts",
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRequestHandlerContext.getClient",
"type": "Function",
"tags": [],
"label": "getClient",
"description": [],
"signature": [
"(options?: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientProviderOptions",
"text": "SavedObjectsClientProviderOptions"
},
" | undefined) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
}
],
"path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRequestHandlerContext.getClient.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientProviderOptions",
"text": "SavedObjectsClientProviderOptions"
},
" | undefined"
],
"path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRequestHandlerContext.getExporter",
"type": "Function",
"tags": [],
"label": "getExporter",
"description": [],
"signature": [
"(client: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
},
") => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.ISavedObjectsExporter",
"text": "ISavedObjectsExporter"
}
],
"path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRequestHandlerContext.getExporter.$1",
"type": "Object",
"tags": [],
"label": "client",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
}
],
"path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRequestHandlerContext.getImporter",
"type": "Function",
"tags": [],
"label": "getImporter",
"description": [],
"signature": [
"(client: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
},
") => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.ISavedObjectsImporter",
"text": "ISavedObjectsImporter"
}
],
"path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsRequestHandlerContext.getImporter.$1",
"type": "Object",
"tags": [],
"label": "client",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
}
],
"path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "core",
"id": "def-server.SavedObjectsResolveImportErrorsOptions",

View file

@ -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-07-06
date: 2022-07-07
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 |
|-------------------|-----------|------------------------|-----------------|
| 2525 | 15 | 914 | 28 |
| 2546 | 15 | 926 | 28 |
## Client

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -4328,7 +4328,9 @@
"RangeFilter",
" | ",
"ScriptedRangeFilter",
" | MatchAllRangeFilter | undefined"
" | ",
"MatchAllRangeFilter",
" | undefined"
],
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"deprecated": false,
@ -14551,7 +14553,9 @@
"RangeFilter",
" | ",
"ScriptedRangeFilter",
" | MatchAllRangeFilter | undefined"
" | ",
"MatchAllRangeFilter",
" | undefined"
],
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"deprecated": false,

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -2881,7 +2881,9 @@
"RangeFilter",
" | ",
"ScriptedRangeFilter",
" | MatchAllRangeFilter | undefined; createRelativeFilter: (indexPattern: ",
" | ",
"MatchAllRangeFilter",
" | undefined; createRelativeFilter: (indexPattern: ",
{
"pluginId": "dataViews",
"scope": "common",
@ -2895,7 +2897,9 @@
"RangeFilter",
" | ",
"ScriptedRangeFilter",
" | MatchAllRangeFilter | undefined; getBounds: () => ",
" | ",
"MatchAllRangeFilter",
" | undefined; getBounds: () => ",
{
"pluginId": "data",
"scope": "common",
@ -3121,7 +3125,9 @@
"RangeFilter",
" | ",
"ScriptedRangeFilter",
" | MatchAllRangeFilter | undefined; createRelativeFilter: (indexPattern: ",
" | ",
"MatchAllRangeFilter",
" | undefined; createRelativeFilter: (indexPattern: ",
{
"pluginId": "dataViews",
"scope": "common",
@ -3135,7 +3141,9 @@
"RangeFilter",
" | ",
"ScriptedRangeFilter",
" | MatchAllRangeFilter | undefined; getBounds: () => ",
" | ",
"MatchAllRangeFilter",
" | undefined; getBounds: () => ",
{
"pluginId": "data",
"scope": "common",
@ -3350,7 +3358,9 @@
"RangeFilter",
" | ",
"ScriptedRangeFilter",
" | MatchAllRangeFilter | undefined"
" | ",
"MatchAllRangeFilter",
" | undefined"
],
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"deprecated": false,
@ -3454,7 +3464,9 @@
"RangeFilter",
" | ",
"ScriptedRangeFilter",
" | MatchAllRangeFilter | undefined"
" | ",
"MatchAllRangeFilter",
" | undefined"
],
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
"deprecated": false,

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
tags: ['contributor', 'dev', 'apidocs', 'kibana']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
---

View file

@ -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-07-06
date: 2022-07-07
tags: ['contributor', 'dev', 'apidocs', 'kibana']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
---

View file

@ -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-07-06
date: 2022-07-07
tags: ['contributor', 'dev', 'apidocs', 'kibana']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -0,0 +1,121 @@
{
"id": "@kbn/aiops-components",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.DualBrush",
"type": "Function",
"tags": [],
"label": "DualBrush",
"description": [],
"signature": [
"({\n windowParameters,\n min,\n max,\n onChange,\n marginLeft,\n width,\n}: DualBrushProps) => JSX.Element"
],
"path": "x-pack/packages/ml/aiops_components/src/dual_brush/dual_brush.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.DualBrush.$1",
"type": "Object",
"tags": [],
"label": "{\n windowParameters,\n min,\n max,\n onChange,\n marginLeft,\n width,\n}",
"description": [],
"signature": [
"DualBrushProps"
],
"path": "x-pack/packages/ml/aiops_components/src/dual_brush/dual_brush.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.DualBrushAnnotation",
"type": "Function",
"tags": [],
"label": "DualBrushAnnotation",
"description": [],
"signature": [
"({ id, min, max }: React.PropsWithChildren<BrushAnnotationProps>) => JSX.Element"
],
"path": "x-pack/packages/ml/aiops_components/src/dual_brush/dual_brush_annotation.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.DualBrushAnnotation.$1",
"type": "CompoundType",
"tags": [],
"label": "{ id, min, max }",
"description": [],
"signature": [
"React.PropsWithChildren<BrushAnnotationProps>"
],
"path": "x-pack/packages/ml/aiops_components/src/dual_brush/dual_brush_annotation.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.ProgressControls",
"type": "Function",
"tags": [],
"label": "ProgressControls",
"description": [],
"signature": [
"({\n progress,\n progressMessage,\n onRefresh,\n onCancel,\n isRunning,\n}: ProgressControlProps) => JSX.Element"
],
"path": "x-pack/packages/ml/aiops_components/src/progress_controls/progress_controls.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/aiops-components",
"id": "def-common.ProgressControls.$1",
"type": "Object",
"tags": [],
"label": "{\n progress,\n progressMessage,\n onRefresh,\n onCancel,\n isRunning,\n}",
"description": [],
"signature": [
"ProgressControlProps"
],
"path": "x-pack/packages/ml/aiops_components/src/progress_controls/progress_controls.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

View file

@ -0,0 +1,27 @@
---
id: kibKbnAiopsComponentsPluginApi
slug: /kibana-dev-docs/api/kbn-aiops-components
title: "@kbn/aiops-components"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the @kbn/aiops-components plugin
date: 2022-07-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components']
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 kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json';
React components for AIOps related efforts.
Contact Machine Learning UI for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 6 | 0 | 6 | 0 |
## Common
### Functions
<DocDefinitionList data={kbnAiopsComponentsObj.common.functions}/>

View file

@ -38,7 +38,7 @@
"text": "WindowParameters"
}
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"deprecated": false,
"children": [
{
@ -53,7 +53,7 @@
"signature": [
"number"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"deprecated": false,
"isRequired": true
},
@ -69,7 +69,7 @@
"signature": [
"number"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"deprecated": false,
"isRequired": true
},
@ -85,7 +85,7 @@
"signature": [
"number"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"deprecated": false,
"isRequired": true
}
@ -95,37 +95,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.ProgressControls",
"type": "Function",
"tags": [],
"label": "ProgressControls",
"description": [],
"signature": [
"({\n progress,\n progressMessage,\n onRefresh,\n onCancel,\n isRunning,\n}: ProgressControlProps) => JSX.Element"
],
"path": "x-pack/packages/ml/aiops_utils/src/components/progress_controls.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.ProgressControls.$1",
"type": "Object",
"tags": [],
"label": "{\n progress,\n progressMessage,\n onRefresh,\n onCancel,\n isRunning,\n}",
"description": [],
"signature": [
"ProgressControlProps"
],
"path": "x-pack/packages/ml/aiops_utils/src/components/progress_controls.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.streamFactory",
@ -140,7 +109,7 @@
"Logger",
") => StreamFactoryReturnType<T>"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/stream_factory.ts",
"path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts",
"deprecated": false,
"children": [
{
@ -155,7 +124,7 @@
"signature": [
"Headers"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/stream_factory.ts",
"path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts",
"deprecated": false,
"isRequired": true
},
@ -169,7 +138,7 @@
"signature": [
"Logger"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/stream_factory.ts",
"path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts",
"deprecated": false,
"isRequired": true
}
@ -193,7 +162,7 @@
"Logger",
") => StreamFactoryReturnType<T>"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/stream_factory.ts",
"path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts",
"deprecated": false,
"children": [
{
@ -208,7 +177,7 @@
"signature": [
"Headers"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/stream_factory.ts",
"path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts",
"deprecated": false,
"isRequired": true
},
@ -222,7 +191,7 @@
"signature": [
"Logger"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/stream_factory.ts",
"path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts",
"deprecated": false,
"isRequired": true
}
@ -242,7 +211,7 @@
"signature": [
"(endpoint: `${BasePath}${I[\"endpoint\"]}`, body: I[\"body\"]) => UseFetchStreamReturnType<string, React.ReducerAction<I[\"reducer\"]>>"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"children": [
{
@ -255,7 +224,7 @@
"signature": [
"`${BasePath}${I[\"endpoint\"]}`"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"isRequired": true
},
@ -269,7 +238,7 @@
"signature": [
"I[\"body\"]"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"isRequired": true
}
@ -287,7 +256,7 @@
"signature": [
"(endpoint: `${BasePath}${I[\"endpoint\"]}`, body: I[\"body\"], options: { reducer: I[\"reducer\"]; initialState: React.ReducerState<I[\"reducer\"]>; }) => UseFetchStreamReturnType<React.ReducerState<I[\"reducer\"]>, React.ReducerAction<I[\"reducer\"]>>"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"children": [
{
@ -300,7 +269,7 @@
"signature": [
"`${BasePath}${I[\"endpoint\"]}`"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"isRequired": true
},
@ -314,7 +283,7 @@
"signature": [
"I[\"body\"]"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"isRequired": true
},
@ -325,7 +294,7 @@
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"children": [
{
@ -338,7 +307,7 @@
"signature": [
"I[\"reducer\"]"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -380,7 +349,7 @@
"signature": [
"I[\"reducer\"] extends React.Reducer<infer S, any> ? S : never"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false
}
]
@ -401,7 +370,7 @@
"signature": [
"(endpoint: `${BasePath}${I[\"endpoint\"]}`, body: I[\"body\"], options: { reducer: I[\"reducer\"]; initialState: React.ReducerState<I[\"reducer\"]>; } | undefined) => UseFetchStreamReturnType<React.ReducerState<I[\"reducer\"]>, React.ReducerAction<I[\"reducer\"]>>"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"children": [
{
@ -416,7 +385,7 @@
"signature": [
"`${BasePath}${I[\"endpoint\"]}`"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"isRequired": true
},
@ -432,7 +401,7 @@
"signature": [
"I[\"body\"]"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"isRequired": true
},
@ -443,7 +412,7 @@
"tags": [],
"label": "options",
"description": [],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"children": [
{
@ -456,7 +425,7 @@
"signature": [
"I[\"reducer\"]"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -498,7 +467,7 @@
"signature": [
"I[\"reducer\"] extends React.Reducer<infer S, any> ? S : never"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false
}
]
@ -520,7 +489,7 @@
"description": [
"\nCustom hook type definition of the base params for an NDJSON stream with custom reducer."
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"children": [
{
@ -530,7 +499,7 @@
"tags": [],
"label": "endpoint",
"description": [],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false
},
{
@ -543,7 +512,7 @@
"signature": [
"object"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false
},
{
@ -556,7 +525,7 @@
"signature": [
"(prevState: any, action: any) => any"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -600,7 +569,7 @@
"description": [
"\nCustom hook type definition of the base params for a string base stream without a custom reducer."
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"children": [
{
@ -610,7 +579,7 @@
"tags": [],
"label": "endpoint",
"description": [],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false
},
{
@ -623,7 +592,7 @@
"signature": [
"object"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false
},
{
@ -636,7 +605,7 @@
"signature": [
"(prevState: string, action: StringReducerPayload) => string"
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/use_fetch_stream.ts",
"path": "x-pack/packages/ml/aiops_utils/src/use_fetch_stream.ts",
"deprecated": false,
"returnComment": [],
"children": [
@ -680,7 +649,7 @@
"description": [
"\nTime range definition for baseline and deviation to be used by spike log analysis."
],
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"deprecated": false,
"children": [
{
@ -690,7 +659,7 @@
"tags": [],
"label": "baselineMin",
"description": [],
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"deprecated": false
},
{
@ -700,7 +669,7 @@
"tags": [],
"label": "baselineMax",
"description": [],
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"deprecated": false
},
{
@ -710,7 +679,7 @@
"tags": [],
"label": "deviationMin",
"description": [],
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"deprecated": false
},
{
@ -720,7 +689,7 @@
"tags": [],
"label": "deviationMax",
"description": [],
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
"path": "x-pack/packages/ml/aiops_utils/src/get_window_parameters.ts",
"deprecated": false
}
],

View file

@ -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-07-06
date: 2022-07-07
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.
---
@ -18,7 +18,7 @@ Contact Machine Learning UI for questions regarding this plugin.
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 48 | 0 | 26 | 0 |
| 46 | 0 | 24 | 0 |
## Common

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -258,7 +258,7 @@
"tags": [],
"label": "ElasticV3ShipperOptions",
"description": [
"\r\nOptions for the Elastic V3 shipper"
"\nOptions for the Elastic V3 shipper"
],
"path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts",
"deprecated": false,
@ -270,7 +270,7 @@
"tags": [],
"label": "channelName",
"description": [
"\r\nThe name of the channel to stream all the events to."
"\nThe name of the channel to stream all the events to."
],
"path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts",
"deprecated": false
@ -282,7 +282,7 @@
"tags": [],
"label": "version",
"description": [
"\r\nThe product's version."
"\nThe product's version."
],
"path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts",
"deprecated": false
@ -294,7 +294,7 @@
"tags": [],
"label": "sendTo",
"description": [
"\r\nProvide it to override the Analytics client's default configuration."
"\nProvide it to override the Analytics client's default configuration."
],
"signature": [
"\"staging\" | \"production\" | undefined"
@ -309,7 +309,7 @@
"tags": [],
"label": "debug",
"description": [
"\r\nShould show debug information about the requests it makes to the V3 API."
"\nShould show debug information about the requests it makes to the V3 API."
],
"signature": [
"boolean | undefined"

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -250,7 +250,7 @@
"tags": [],
"label": "ElasticV3ShipperOptions",
"description": [
"\r\nOptions for the Elastic V3 shipper"
"\nOptions for the Elastic V3 shipper"
],
"path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts",
"deprecated": false,
@ -262,7 +262,7 @@
"tags": [],
"label": "channelName",
"description": [
"\r\nThe name of the channel to stream all the events to."
"\nThe name of the channel to stream all the events to."
],
"path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts",
"deprecated": false
@ -274,7 +274,7 @@
"tags": [],
"label": "version",
"description": [
"\r\nThe product's version."
"\nThe product's version."
],
"path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts",
"deprecated": false
@ -286,7 +286,7 @@
"tags": [],
"label": "sendTo",
"description": [
"\r\nProvide it to override the Analytics client's default configuration."
"\nProvide it to override the Analytics client's default configuration."
],
"signature": [
"\"staging\" | \"production\" | undefined"
@ -301,7 +301,7 @@
"tags": [],
"label": "debug",
"description": [
"\r\nShould show debug information about the requests it makes to the V3 API."
"\nShould show debug information about the requests it makes to the V3 API."
],
"signature": [
"boolean | undefined"

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -4,7 +4,7 @@ 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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

View file

@ -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-07-06
date: 2022-07-07
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.
---

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