mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 09:48:58 -04:00
[api-docs] Daily api_docs build (#135389)
This commit is contained in:
Kibana Machine
GitHub
parent
ff57626fec
commit
d1c08e0fc0
294 changed files with 2023 additions and 443 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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -88,6 +88,21 @@
|
|||
],
|
||||
"path": "x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes.tsx",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "aiops",
|
||||
"id": "def-public.ExplainLogRateSpikesProps.windowParameters",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "windowParameters",
|
||||
"description": [
|
||||
"Window parameters for the analysis"
|
||||
],
|
||||
"signature": [
|
||||
"WindowParameters"
|
||||
],
|
||||
"path": "x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes.tsx",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
@ -168,7 +183,7 @@
|
|||
"\nThis is an internal hard coded feature flag so we can easily turn on/off the\n\"Explain log rate spikes UI\" during development until the first release."
|
||||
],
|
||||
"signature": [
|
||||
"false"
|
||||
"true"
|
||||
],
|
||||
"path": "x-pack/plugins/aiops/common/index.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for q
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 11 | 0 | 0 | 0 |
|
||||
| 12 | 0 | 0 | 0 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1235,7 +1235,31 @@
|
|||
"section": "def-common.CommentType",
|
||||
"text": "CommentType"
|
||||
},
|
||||
".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; })) & { id: string; version: string; })[] | undefined; }, \"comments\"> & { comments: ",
|
||||
".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }) | (({ externalReferenceId: string; externalReferenceStorage: { type: ",
|
||||
"ExternalReferenceStorageType",
|
||||
".elasticSearchDoc; }; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
|
||||
"JsonValue",
|
||||
"; } | null; type: ",
|
||||
{
|
||||
"pluginId": "cases",
|
||||
"scope": "common",
|
||||
"docId": "kibCasesPluginApi",
|
||||
"section": "def-common.CommentType",
|
||||
"text": "CommentType"
|
||||
},
|
||||
".externalReference; owner: string; } | { externalReferenceStorage: { type: ",
|
||||
"ExternalReferenceStorageType",
|
||||
".savedObject; soType: string; }; externalReferenceId: string; externalReferenceAttachmentTypeId: string; externalReferenceMetadata: { [x: string]: ",
|
||||
"JsonValue",
|
||||
"; } | null; type: ",
|
||||
{
|
||||
"pluginId": "cases",
|
||||
"scope": "common",
|
||||
"docId": "kibCasesPluginApi",
|
||||
"section": "def-common.CommentType",
|
||||
"text": "CommentType"
|
||||
},
|
||||
".externalReference; owner: string; }) & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; })) & { id: string; version: string; })[] | undefined; }, \"comments\"> & { comments: ",
|
||||
"Comment",
|
||||
"[]; }"
|
||||
],
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [ResponseOps](https://github.com/orgs/elastic/teams/response-ops) for qu
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 66 | 0 | 52 | 22 |
|
||||
| 66 | 0 | 52 | 23 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1345,13 +1345,7 @@
|
|||
"{@link ExecutionContextSetup}"
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-public.ExecutionContextSetup",
|
||||
"text": "ExecutionContextSetup"
|
||||
}
|
||||
"ExecutionContextSetup"
|
||||
],
|
||||
"path": "src/core/public/index.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -1514,13 +1508,7 @@
|
|||
"{@link ExecutionContextStart}"
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-public.ExecutionContextSetup",
|
||||
"text": "ExecutionContextSetup"
|
||||
}
|
||||
"ExecutionContextSetup"
|
||||
],
|
||||
"path": "src/core/public/index.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -2343,9 +2331,9 @@
|
|||
"tags": [],
|
||||
"label": "ExecutionContextSetup",
|
||||
"description": [
|
||||
"\nKibana execution context.\nUsed to provide execution context to Elasticsearch, reporting, performance monitoring, etc."
|
||||
"\r\nKibana execution context.\r\nUsed to provide execution context to Elasticsearch, reporting, performance monitoring, etc."
|
||||
],
|
||||
"path": "src/core/public/execution_context/execution_context_service.ts",
|
||||
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
|
|
@ -2355,7 +2343,7 @@
|
|||
"tags": [],
|
||||
"label": "context$",
|
||||
"description": [
|
||||
"\nThe current context observable"
|
||||
"\r\nThe current context observable"
|
||||
],
|
||||
"signature": [
|
||||
"Observable",
|
||||
|
|
@ -2363,7 +2351,7 @@
|
|||
"KibanaExecutionContext",
|
||||
">"
|
||||
],
|
||||
"path": "src/core/public/execution_context/execution_context_service.ts",
|
||||
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -2373,14 +2361,14 @@
|
|||
"tags": [],
|
||||
"label": "set",
|
||||
"description": [
|
||||
"\nSet the current top level context"
|
||||
"\r\nSet the current top level context"
|
||||
],
|
||||
"signature": [
|
||||
"(c$: ",
|
||||
"KibanaExecutionContext",
|
||||
") => void"
|
||||
],
|
||||
"path": "src/core/public/execution_context/execution_context_service.ts",
|
||||
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
|
|
@ -2393,7 +2381,7 @@
|
|||
"signature": [
|
||||
"KibanaExecutionContext"
|
||||
],
|
||||
"path": "src/core/public/execution_context/execution_context_service.ts",
|
||||
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
|
|
@ -2407,13 +2395,13 @@
|
|||
"tags": [],
|
||||
"label": "get",
|
||||
"description": [
|
||||
"\nGet the current top level context"
|
||||
"\r\nGet the current top level context"
|
||||
],
|
||||
"signature": [
|
||||
"() => ",
|
||||
"KibanaExecutionContext"
|
||||
],
|
||||
"path": "src/core/public/execution_context/execution_context_service.ts",
|
||||
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
|
|
@ -2425,12 +2413,12 @@
|
|||
"tags": [],
|
||||
"label": "clear",
|
||||
"description": [
|
||||
"\nclears the context"
|
||||
"\r\nclears the context"
|
||||
],
|
||||
"signature": [
|
||||
"() => void"
|
||||
],
|
||||
"path": "src/core/public/execution_context/execution_context_service.ts",
|
||||
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
|
|
@ -2442,13 +2430,12 @@
|
|||
"tags": [],
|
||||
"label": "getAsLabels",
|
||||
"description": [
|
||||
"\nreturns apm labels"
|
||||
"\r\nreturns apm labels"
|
||||
],
|
||||
"signature": [
|
||||
"() => ",
|
||||
"Labels"
|
||||
"() => Labels"
|
||||
],
|
||||
"path": "src/core/public/execution_context/execution_context_service.ts",
|
||||
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
|
|
@ -2460,7 +2447,7 @@
|
|||
"tags": [],
|
||||
"label": "withGlobalContext",
|
||||
"description": [
|
||||
"\nmerges the current top level context with the specific event context"
|
||||
"\r\nmerges the current top level context with the specific event context"
|
||||
],
|
||||
"signature": [
|
||||
"(context?: ",
|
||||
|
|
@ -2468,7 +2455,7 @@
|
|||
" | undefined) => ",
|
||||
"KibanaExecutionContext"
|
||||
],
|
||||
"path": "src/core/public/execution_context/execution_context_service.ts",
|
||||
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
|
|
@ -2482,7 +2469,7 @@
|
|||
"KibanaExecutionContext",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/core/public/execution_context/execution_context_service.ts",
|
||||
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
|
|
@ -7587,18 +7574,12 @@
|
|||
"tags": [],
|
||||
"label": "ExecutionContextStart",
|
||||
"description": [
|
||||
"\nSee {@link ExecutionContextSetup}."
|
||||
"\r\nSee {@link ExecutionContextSetup}."
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-public.ExecutionContextSetup",
|
||||
"text": "ExecutionContextSetup"
|
||||
}
|
||||
"ExecutionContextSetup"
|
||||
],
|
||||
"path": "src/core/public/execution_context/execution_context_service.ts",
|
||||
"path": "node_modules/@types/kbn__core-execution-context-browser/index.d.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
|
|
@ -7792,7 +7773,7 @@
|
|||
"KibanaExecutionContext",
|
||||
" | undefined; }"
|
||||
],
|
||||
"path": "src/core/types/execution_context.ts",
|
||||
"path": "node_modules/@types/kbn__core-execution-context-common/index.d.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
|
|
@ -19647,6 +19628,75 @@
|
|||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-server.NodeInfo",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "NodeInfo",
|
||||
"description": [
|
||||
"\r\nContains information about how this Kibana process has been configured.\r\n"
|
||||
],
|
||||
"path": "node_modules/@types/kbn__core-node-server/index.d.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-server.NodeInfo.roles",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "roles",
|
||||
"description": [
|
||||
"A list of roles this node has been configured with."
|
||||
],
|
||||
"signature": [
|
||||
"NodeRoles"
|
||||
],
|
||||
"path": "node_modules/@types/kbn__core-node-server/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-server.NodeRoles",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "NodeRoles",
|
||||
"description": [
|
||||
"\r\nThe Kibana process can be run in dedicated \"modes\" via `node.roles`.\r\nThis configuration is then exposed to plugins via `NodeRoles`,\r\nwhich is available on the `PluginInitializerContext`.\r\n\r\nThe node roles can be used by plugins to adjust their behavior based\r\non the way the Kibana process has been configured.\r\n"
|
||||
],
|
||||
"path": "node_modules/@types/kbn__core-node-server/index.d.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-server.NodeRoles.backgroundTasks",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "backgroundTasks",
|
||||
"description": [
|
||||
"\r\nThe backgroundTasks role includes operations which don't involve\r\nresponding to incoming http traffic from the UI."
|
||||
],
|
||||
"path": "node_modules/@types/kbn__core-node-server/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-server.NodeRoles.ui",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "ui",
|
||||
"description": [
|
||||
"\r\nThe ui role covers any operations that need to occur in order\r\nto handle http traffic from the browser."
|
||||
],
|
||||
"path": "node_modules/@types/kbn__core-node-server/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-server.NodesVersionCompatibility",
|
||||
|
|
@ -20589,6 +20639,21 @@
|
|||
"path": "src/core/server/plugins/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-server.PluginInitializerContext.node",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "node",
|
||||
"description": [
|
||||
"\nAccess the configuration for this particular Kibana node.\nCan be used to determine which `roles` the current process was started with.\n"
|
||||
],
|
||||
"signature": [
|
||||
"NodeInfo"
|
||||
],
|
||||
"path": "src/core/server/plugins/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-server.PluginInitializerContext.logger",
|
||||
|
|
@ -26772,7 +26837,7 @@
|
|||
"KibanaExecutionContext",
|
||||
" | undefined; }"
|
||||
],
|
||||
"path": "src/core/types/execution_context.ts",
|
||||
"path": "node_modules/@types/kbn__core-execution-context-common/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-28
|
||||
date: 2022-06-29
|
||||
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 | 936 | 29 |
|
||||
| 2533 | 15 | 932 | 27 |
|
||||
|
||||
## 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-28
|
||||
date: 2022-06-29
|
||||
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 | 936 | 29 |
|
||||
| 2533 | 15 | 932 | 27 |
|
||||
|
||||
## 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-28
|
||||
date: 2022-06-29
|
||||
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 | 936 | 29 |
|
||||
| 2533 | 15 | 932 | 27 |
|
||||
|
||||
## 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-28
|
||||
date: 2022-06-29
|
||||
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 | 936 | 29 |
|
||||
| 2533 | 15 | 932 | 27 |
|
||||
|
||||
## 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-28
|
||||
date: 2022-06-29
|
||||
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 | 936 | 29 |
|
||||
| 2533 | 15 | 932 | 27 |
|
||||
|
||||
## 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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -9465,7 +9465,15 @@
|
|||
},
|
||||
"[] | undefined; fieldsFromSource?: ",
|
||||
"Fields",
|
||||
" | undefined; index?: string | undefined; searchAfter?: ",
|
||||
" | undefined; index?: string | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewSpec",
|
||||
"text": "DataViewSpec"
|
||||
},
|
||||
" | undefined; searchAfter?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -29612,7 +29612,15 @@
|
|||
},
|
||||
"[] | undefined; fieldsFromSource?: ",
|
||||
"Fields",
|
||||
" | undefined; index?: string | undefined; searchAfter?: ",
|
||||
" | undefined; index?: string | ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewSpec",
|
||||
"text": "DataViewSpec"
|
||||
},
|
||||
" | undefined; searchAfter?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -128,21 +128,6 @@
|
|||
],
|
||||
"path": "src/plugins/data_view_editor/public/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViewEditor",
|
||||
"id": "def-public.DataViewEditorProps.showEmptyPrompt",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "showEmptyPrompt",
|
||||
"description": [
|
||||
"\nIf set to false, the screen for prompting a user to create a data view will be skipped, and the user will be taken directly\nto data view creation."
|
||||
],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "src/plugins/data_view_editor/public/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 15 | 0 | 7 | 0 |
|
||||
| 14 | 0 | 7 | 0 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -20296,6 +20296,237 @@
|
|||
}
|
||||
],
|
||||
"objects": [
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewPersistableStateService",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "DataViewPersistableStateService",
|
||||
"description": [],
|
||||
"path": "src/plugins/data_views/common/data_views/persistable_state.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewPersistableStateService.inject",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "inject",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(state: ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewSpec",
|
||||
"text": "DataViewSpec"
|
||||
},
|
||||
", references: ",
|
||||
"SavedObjectReference",
|
||||
"[]) => ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewSpec",
|
||||
"text": "DataViewSpec"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/data_views/common/data_views/persistable_state.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewPersistableStateService.inject.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewSpec",
|
||||
"text": "DataViewSpec"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/data_views/common/data_views/persistable_state.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewPersistableStateService.inject.$2",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "references",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SavedObjectReference",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/data_views/persistable_state.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewPersistableStateService.extract",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "extract",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(state: ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewSpec",
|
||||
"text": "DataViewSpec"
|
||||
},
|
||||
") => { state: ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewSpec",
|
||||
"text": "DataViewSpec"
|
||||
},
|
||||
"; references: never[]; }"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/data_views/persistable_state.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewPersistableStateService.extract.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewSpec",
|
||||
"text": "DataViewSpec"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/data_views/common/data_views/persistable_state.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewPersistableStateService.getAllMigrations",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getAllMigrations",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => {}"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/data_views/persistable_state.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewPersistableStateService.migrateToLatest",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "migrateToLatest",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"({ state }: ",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.VersionedState",
|
||||
"text": "VersionedState"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewSpec",
|
||||
"text": "DataViewSpec"
|
||||
},
|
||||
">) => ",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewSpec",
|
||||
"text": "DataViewSpec"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/data_views/common/data_views/persistable_state.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewPersistableStateService.migrateToLatest.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "{ state }",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.VersionedState",
|
||||
"text": "VersionedState"
|
||||
},
|
||||
"<",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
"docId": "kibDataViewsPluginApi",
|
||||
"section": "def-common.DataViewSpec",
|
||||
"text": "DataViewSpec"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/data_views/persistable_state.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DataViewPersistableStateService.telemetry",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "telemetry",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => {}"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/data_views/persistable_state.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataViews",
|
||||
"id": "def-common.DEFAULT_ASSETS_TO_IGNORE",
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 925 | 1 | 189 | 1 |
|
||||
| 935 | 1 | 199 | 1 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1336,6 +1336,20 @@
|
|||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-common.HIDE_ANNOUNCEMENTS",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "HIDE_ANNOUNCEMENTS",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"hideAnnouncements\""
|
||||
],
|
||||
"path": "src/plugins/discover/common/index.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-common.MAX_DOC_FIELDS_DISPLAYED",
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-disco
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 78 | 0 | 62 | 7 |
|
||||
| 79 | 0 | 63 | 7 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@
|
|||
"label": "CONNECTORS_INDEX",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\".ent-search-connectors\""
|
||||
"\".elastic-connectors\""
|
||||
],
|
||||
"path": "x-pack/plugins/enterprise_search/server/index.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -19,6 +19,113 @@
|
|||
"common": {
|
||||
"classes": [],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "@kbn/aiops-utils",
|
||||
"id": "def-common.getWindowParameters",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getWindowParameters",
|
||||
"description": [
|
||||
"\nGiven a point in time (e.g. where a user clicks), use simple heuristics to compute:\n\n1. The time window around the click to evaluate for changes\n2. The historical time window prior to the click to use as a baseline.\n\nThe philosophy here is that charts are displayed with different granularities according to their\noverall time window. We select the change point and historical time windows inline with the\noverall time window.\n\nThe algorithm for doing this is based on the typical granularities that exist in machine data.\n"
|
||||
],
|
||||
"signature": [
|
||||
"(clickTime: number, minTime: number, maxTime: number) => ",
|
||||
{
|
||||
"pluginId": "@kbn/aiops-utils",
|
||||
"scope": "common",
|
||||
"docId": "kibKbnAiopsUtilsPluginApi",
|
||||
"section": "def-common.WindowParameters",
|
||||
"text": "WindowParameters"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/aiops-utils",
|
||||
"id": "def-common.getWindowParameters.$1",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "clickTime",
|
||||
"description": [
|
||||
"timestamp of the clicked log rate spike."
|
||||
],
|
||||
"signature": [
|
||||
"number"
|
||||
],
|
||||
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/aiops-utils",
|
||||
"id": "def-common.getWindowParameters.$2",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "minTime",
|
||||
"description": [
|
||||
"minimum timestamp of the time window to be analysed"
|
||||
],
|
||||
"signature": [
|
||||
"number"
|
||||
],
|
||||
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/aiops-utils",
|
||||
"id": "def-common.getWindowParameters.$3",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "maxTime",
|
||||
"description": [
|
||||
"maximum timestamp of the time window to be analysed"
|
||||
],
|
||||
"signature": [
|
||||
"number"
|
||||
],
|
||||
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [
|
||||
"WindowParameters"
|
||||
],
|
||||
"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",
|
||||
|
|
@ -531,6 +638,61 @@
|
|||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/aiops-utils",
|
||||
"id": "def-common.WindowParameters",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "WindowParameters",
|
||||
"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",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "@kbn/aiops-utils",
|
||||
"id": "def-common.WindowParameters.baselineMin",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "baselineMin",
|
||||
"description": [],
|
||||
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/aiops-utils",
|
||||
"id": "def-common.WindowParameters.baselineMax",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "baselineMax",
|
||||
"description": [],
|
||||
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/aiops-utils",
|
||||
"id": "def-common.WindowParameters.deviationMin",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "deviationMin",
|
||||
"description": [],
|
||||
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "@kbn/aiops-utils",
|
||||
"id": "def-common.WindowParameters.deviationMax",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "deviationMax",
|
||||
"description": [],
|
||||
"path": "x-pack/packages/ml/aiops_utils/src/lib/get_window_parameters.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"enums": [],
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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 |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 35 | 0 | 18 | 0 |
|
||||
| 46 | 0 | 24 | 0 |
|
||||
|
||||
## Common
|
||||
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -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-06-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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-28
|
||||
date: 2022-06-29
|
||||
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.
|
||||
---
|
||||
|
|
|
|||
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