github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source
This commit is contained in:
Kibana Machine 2022-07-19 00:43:40 -04:00 • committed by GitHub
parent ec5eb448d5
commit 1a1ecc1e19
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
382 changed files with 2449 additions and 2243 deletions
Download patch file Download diff file Expand all files Collapse all files

30
api_docs/actions.devdocs.json
View file

@ -1553,7 +1553,7 @@
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly message: string; readonly to: string[]; readonly subject: string; readonly cc: string[]; readonly bcc: string[]; readonly kibanaFooterLink: Readonly<{} & { text: string; path: string; }>; }"
"{ readonly to: string[]; readonly message: string; readonly subject: string; readonly cc: string[]; readonly bcc: string[]; readonly kibanaFooterLink: Readonly<{} & { path: string; text: string; }>; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/email.ts",
"deprecated": false,
@ -1581,7 +1581,7 @@
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly source?: string | undefined; readonly group?: string | undefined; readonly component?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"warning\" | \"info\" | \"critical\" | undefined; readonly class?: string | undefined; }"
"{ readonly group?: string | undefined; readonly source?: string | undefined; readonly component?: string | undefined; readonly summary?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"warning\" | \"info\" | \"critical\" | undefined; readonly class?: string | undefined; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts",
"deprecated": false,
@ -1665,7 +1665,7 @@
"label": "ActionParamsType",
"description": [],
"signature": [
"Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; name: string; externalId: string | null; incidentTypes: number[] | null; severityCode: number | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"incidentTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"severity\"; subActionParams: Readonly<{} & {}>; }>"
"Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { name: string; description: string | null; externalId: string | null; incidentTypes: number[] | null; severityCode: number | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"incidentTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"severity\"; subActionParams: Readonly<{} & {}>; }>"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts",
"deprecated": false,
@ -1707,7 +1707,17 @@
"label": "ActionsClient",
"description": [],
"signature": [
"{ create: ({ action: { actionTypeId, name, config, secrets }, }: ",
"{ execute: ({ actionId, params, source, relatedSavedObjects, }: Omit<",
"ExecuteOptions",
"<unknown>, \"request\">) => Promise<",
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.ActionTypeExecutorResult",
"text": "ActionTypeExecutorResult"
},
"<unknown>>; create: ({ action: { actionTypeId, name, config, secrets }, }: ",
"CreateOptions",
") => Promise<",
{
@ -1741,17 +1751,7 @@
},
"<",
"ActionTypeConfig",
">>; execute: ({ actionId, params, source, relatedSavedObjects, }: Omit<",
"ExecuteOptions",
"<unknown>, \"request\">) => Promise<",
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.ActionTypeExecutorResult",
"text": "ActionTypeExecutorResult"
},
"<unknown>>; getAll: () => Promise<",
">>; getAll: () => Promise<",
{
"pluginId": "actions",
"scope": "server",

2
api_docs/actions.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/advanced_settings.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/aiops.mdx
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-18
date: 2022-07-19
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.
---

25
api_docs/alerting.devdocs.json
View file

@ -43,7 +43,7 @@
"The rule to view"
],
"signature": [
"{ id: string; monitoring?: ",
"{ id: string; name: string; monitoring?: ",
{
"pluginId": "alerting",
"scope": "common",
@ -51,7 +51,7 @@
"section": "def-common.RuleMonitoring",
"text": "RuleMonitoring"
},
" | undefined; name: string; tags: string[]; enabled: boolean; params: never; actions: ",
" | undefined; tags: string[]; enabled: boolean; params: never; actions: ",
{
"pluginId": "alerting",
"scope": "common",
@ -4381,7 +4381,7 @@
"label": "freq",
"description": [],
"signature": [
"0 | 2 | 1 | 4 | 3 | 5 | 6 | undefined"
"0 | 2 | 1 | 6 | 4 | 3 | 5 | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false
@ -5320,6 +5320,19 @@
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false
},
{
"parentPluginId": "alerting",
"id": "def-common.RuleSnoozeSchedule.skipRecurrences",
"type": "Array",
"tags": [],
"label": "skipRecurrences",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -6025,7 +6038,7 @@
"label": "RuleSnooze",
"description": [],
"signature": [
"{ duration: number; rRule: SnoozeRRule; id?: string | undefined; }[]"
"{ duration: number; rRule: SnoozeRRule; id?: string | undefined; skipRecurrences?: string[] | undefined; }[]"
],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false,
@ -6109,7 +6122,7 @@
"label": "SanitizedRule",
"description": [],
"signature": [
"{ id: string; monitoring?: ",
"{ id: string; name: string; monitoring?: ",
{
"pluginId": "alerting",
"scope": "common",
@ -6117,7 +6130,7 @@
"section": "def-common.RuleMonitoring",
"text": "RuleMonitoring"
},
" | undefined; name: string; tags: string[]; enabled: boolean; params: Params; actions: ",
" | undefined; tags: string[]; enabled: boolean; params: Params; actions: ",
{
"pluginId": "alerting",
"scope": "common",

4
api_docs/alerting.mdx
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-18
date: 2022-07-19
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.
---
@ -18,7 +18,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 365 | 0 | 356 | 20 |
| 366 | 0 | 357 | 20 |
## Client

172
api_docs/apm.devdocs.json
View file

File diff suppressed because one or more lines are too long

2
api_docs/apm.mdx
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-18
date: 2022-07-19
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
api_docs/banners.devdocs.json
View file

@ -38,7 +38,7 @@
"label": "placement",
"description": [],
"signature": [
"\"disabled\" | \"top\""
"\"top\" | \"disabled\""
],
"path": "x-pack/plugins/banners/common/types.ts",
"deprecated": false
@ -129,7 +129,7 @@
"label": "BannerPlacement",
"description": [],
"signature": [
"\"disabled\" | \"top\""
"\"top\" | \"disabled\""
],
"path": "x-pack/plugins/banners/common/types.ts",
"deprecated": false,

2
api_docs/banners.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/bfetch.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/canvas.mdx
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-18
date: 2022-07-19
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.
---

221
api_docs/cases.devdocs.json
View file

@ -490,7 +490,15 @@
"signature": [
"{ features?: Partial<",
"CasesContextFeatures",
"> | undefined; basePath?: string | undefined; onClose?: (() => void) | undefined; owner: string[]; permissions: { all: boolean; read: boolean; }; releasePhase?: ",
"> | undefined; basePath?: string | undefined; onClose?: (() => void) | undefined; owner: string[]; permissions: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesPermissions",
"text": "CasesPermissions"
},
"; releasePhase?: ",
"ReleasePhase",
" | undefined; hiddenStatuses?: ",
"CaseStatusWithAllStatus",
@ -518,7 +526,15 @@
"signature": [
"{ features?: Partial<",
"CasesContextFeatures",
"> | undefined; basePath?: string | undefined; owner: string[]; permissions: { all: boolean; read: boolean; }; onComponentInitialized?: (() => void) | undefined; actionsNavigation?: ",
"> | undefined; basePath?: string | undefined; owner: string[]; permissions: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesPermissions",
"text": "CasesPermissions"
},
"; onComponentInitialized?: (() => void) | undefined; actionsNavigation?: ",
"CasesNavigation",
"<string, \"configurable\"> | undefined; ruleDetailsNavigation?: ",
"CasesNavigation",
@ -552,7 +568,15 @@
"signature": [
"{ features?: Partial<",
"CasesContextFeatures",
"> | undefined; basePath?: string | undefined; onClose?: (() => void) | undefined; owner: string[]; permissions: { all: boolean; read: boolean; }; releasePhase?: ",
"> | undefined; basePath?: string | undefined; onClose?: (() => void) | undefined; owner: string[]; permissions: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesPermissions",
"text": "CasesPermissions"
},
"; releasePhase?: ",
"ReleasePhase",
" | undefined; afterCaseCreated?: ((theCase: ",
{
@ -596,7 +620,15 @@
"signature": [
"{ features?: Partial<",
"CasesContextFeatures",
"> | undefined; basePath?: string | undefined; owner: string[]; permissions: { all: boolean; read: boolean; }; releasePhase?: ",
"> | undefined; basePath?: string | undefined; owner: string[]; permissions: ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesPermissions",
"text": "CasesPermissions"
},
"; releasePhase?: ",
"ReleasePhase",
" | undefined; maxCasesToShow: number; }"
],
@ -818,7 +850,23 @@
"signature": [
"{ canUseCases: (owners?: ",
"CasesOwners",
"[] | undefined) => { crud: boolean; read: boolean; }; getRuleIdFromEvent: (event: Event) => { id: string; name: string; }; groupAlertsByRule: (items: Event[], owner: string) => ",
"[]) => ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesPermissions",
"text": "CasesPermissions"
},
"; getUICapabilities: (featureCapabilities?: Partial<Record<string, boolean | Record<string, boolean>>> | undefined) => ",
{
"pluginId": "cases",
"scope": "common",
"docId": "kibCasesPluginApi",
"section": "def-common.CasesPermissions",
"text": "CasesPermissions"
},
"; getRuleIdFromEvent: (event: Event) => { id: string; name: string; }; groupAlertsByRule: (items: Event[], owner: string) => ",
{
"pluginId": "cases",
"scope": "public",
@ -1057,6 +1105,24 @@
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "cases",
"id": "def-common.createUICapabilities",
"type": "Function",
"tags": [],
"label": "createUICapabilities",
"description": [
"\nReturn the UI capabilities for each type of operation. These strings must match the values defined in the UI\nhere: x-pack/plugins/cases/public/client/helpers/capabilities.ts"
],
"signature": [
"() => { all: readonly [\"create_cases\", \"read_cases\", \"update_cases\", \"push_cases\"]; read: readonly [\"read_cases\"]; delete: readonly [\"delete_cases\"]; }"
],
"path": "x-pack/plugins/cases/common/utils/capabilities.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.getAllConnectorsUrl",
@ -1163,6 +1229,79 @@
}
],
"interfaces": [
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions",
"type": "Interface",
"tags": [],
"label": "CasesPermissions",
"description": [],
"path": "x-pack/plugins/cases/common/ui/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.all",
"type": "boolean",
"tags": [],
"label": "all",
"description": [],
"path": "x-pack/plugins/cases/common/ui/types.ts",
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.create",
"type": "boolean",
"tags": [],
"label": "create",
"description": [],
"path": "x-pack/plugins/cases/common/ui/types.ts",
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.read",
"type": "boolean",
"tags": [],
"label": "read",
"description": [],
"path": "x-pack/plugins/cases/common/ui/types.ts",
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.update",
"type": "boolean",
"tags": [],
"label": "update",
"description": [],
"path": "x-pack/plugins/cases/common/ui/types.ts",
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.delete",
"type": "boolean",
"tags": [],
"label": "delete",
"description": [],
"path": "x-pack/plugins/cases/common/ui/types.ts",
"deprecated": false
},
{
"parentPluginId": "cases",
"id": "def-common.CasesPermissions.push",
"type": "boolean",
"tags": [],
"label": "push",
"description": [],
"path": "x-pack/plugins/cases/common/ui/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.Ecs",
@ -1398,6 +1537,64 @@
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.CREATE_CASES_CAPABILITY",
"type": "string",
"tags": [],
"label": "CREATE_CASES_CAPABILITY",
"description": [
"\nCases UI Capabilities"
],
"signature": [
"\"create_cases\""
],
"path": "x-pack/plugins/cases/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.DELETE_CASES_CAPABILITY",
"type": "string",
"tags": [],
"label": "DELETE_CASES_CAPABILITY",
"description": [],
"signature": [
"\"delete_cases\""
],
"path": "x-pack/plugins/cases/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.PUSH_CASES_CAPABILITY",
"type": "string",
"tags": [],
"label": "PUSH_CASES_CAPABILITY",
"description": [],
"signature": [
"\"push_cases\""
],
"path": "x-pack/plugins/cases/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.READ_CASES_CAPABILITY",
"type": "string",
"tags": [],
"label": "READ_CASES_CAPABILITY",
"description": [],
"signature": [
"\"read_cases\""
],
"path": "x-pack/plugins/cases/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.SECURITY_SOLUTION_OWNER",
@ -1427,6 +1624,20 @@
"path": "x-pack/plugins/cases/common/ui/types.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "cases",
"id": "def-common.UPDATE_CASES_CAPABILITY",
"type": "string",
"tags": [],
"label": "UPDATE_CASES_CAPABILITY",
"description": [],
"signature": [
"\"update_cases\""
],
"path": "x-pack/plugins/cases/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []

4
api_docs/cases.mdx
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-18
date: 2022-07-19
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 |
|-------------------|-----------|------------------------|-----------------|
| 68 | 0 | 54 | 28 |
| 81 | 0 | 65 | 28 |
## Client

2
api_docs/charts.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/cloud.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/cloud_security_posture.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/console.mdx
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-18
date: 2022-07-19
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.
---

6
api_docs/controls.devdocs.json
View file

@ -2832,7 +2832,7 @@
"label": "chainingSystem",
"description": [],
"signature": [
"\"HIERARCHICAL\" | \"NONE\""
"\"NONE\" | \"HIERARCHICAL\""
],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false
@ -3831,7 +3831,7 @@
"section": "def-common.RawControlGroupAttributes",
"text": "RawControlGroupAttributes"
},
", \"id\" | \"type\">"
", \"type\" | \"id\">"
],
"path": "src/plugins/controls/common/control_group/control_group_persistence.ts",
"deprecated": false,
@ -3893,7 +3893,7 @@
"label": "chainingSystem",
"description": [],
"signature": [
"\"HIERARCHICAL\" | \"NONE\""
"\"NONE\" | \"HIERARCHICAL\""
],
"path": "src/plugins/controls/common/control_group/types.ts",
"deprecated": false

2
api_docs/controls.mdx
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-18
date: 2022-07-19
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.
---

329
api_docs/core.devdocs.json
View file

File diff suppressed because one or more lines are too long

2
api_docs/core.mdx
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-18
date: 2022-07-19
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.
---

4
api_docs/core_application.devdocs.json
View file

@ -2180,7 +2180,7 @@
"section": "def-public.AppStatus",
"text": "AppStatus"
},
" | undefined; searchable?: boolean | undefined; deepLinks?: ",
" | undefined; tooltip?: string | undefined; searchable?: boolean | undefined; deepLinks?: ",
{
"pluginId": "core",
"scope": "public",
@ -2196,7 +2196,7 @@
"section": "def-public.AppNavLinkStatus",
"text": "AppNavLinkStatus"
},
" | undefined; defaultPath?: string | undefined; tooltip?: string | undefined; }"
" | undefined; defaultPath?: string | undefined; }"
],
"path": "src/core/public/application/types.ts",
"deprecated": false,

2
api_docs/core_application.mdx
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-18
date: 2022-07-19
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.
---

6
api_docs/core_chrome.devdocs.json
View file

@ -1924,7 +1924,7 @@
"signature": [
"React.HTMLAttributes<HTMLElement> & ",
"CommonProps",
" & { href?: string | undefined; onClick?: React.MouseEventHandler<HTMLAnchorElement> | undefined; text: React.ReactNode; truncate?: boolean | undefined; color?: \"subdued\" | \"primary\" | \"accent\" | \"success\" | \"warning\" | \"danger\" | \"text\" | \"ghost\" | undefined; 'aria-current'?: boolean | \"date\" | \"page\" | \"time\" | \"true\" | \"false\" | \"step\" | \"location\" | undefined; }"
" & { href?: string | undefined; onClick?: React.MouseEventHandler<HTMLAnchorElement> | undefined; text: React.ReactNode; truncate?: boolean | undefined; color?: \"primary\" | \"success\" | \"accent\" | \"warning\" | \"danger\" | \"text\" | \"subdued\" | \"ghost\" | undefined; 'aria-current'?: boolean | \"true\" | \"false\" | \"page\" | \"step\" | \"location\" | \"date\" | \"time\" | undefined; }"
],
"path": "src/core/public/chrome/types.ts",
"deprecated": false,
@ -1938,9 +1938,9 @@
"label": "ChromeHelpExtensionLinkBase",
"description": [],
"signature": [
"{ iconType?: ",
"{ target?: string | (string & {}) | undefined; 'data-test-subj'?: string | undefined; iconType?: ",
"IconType",
" | undefined; 'data-test-subj'?: string | undefined; rel?: string | undefined; target?: string | (string & {}) | undefined; }"
" | undefined; rel?: string | undefined; }"
],
"path": "src/core/public/chrome/ui/header/header_help_menu.tsx",
"deprecated": false,

2
api_docs/core_chrome.mdx
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-18
date: 2022-07-19
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
api_docs/core_saved_objects.devdocs.json
View file

@ -9168,7 +9168,7 @@
"label": "typeRegistry",
"description": [],
"signature": [
"{ getType: (type: string) => ",
"{ isHidden: (type: string) => boolean; getType: (type: string) => ",
{
"pluginId": "core",
"scope": "server",
@ -9200,7 +9200,7 @@
"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; }"
"<any>[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }"
],
"path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts",
"deprecated": false
@ -12531,7 +12531,7 @@
"label": "typeRegistry",
"description": [],
"signature": [
"{ getType: (type: string) => ",
"{ isHidden: (type: string) => boolean; getType: (type: string) => ",
{
"pluginId": "core",
"scope": "server",
@ -12563,7 +12563,7 @@
"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; }"
"<any>[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (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
@ -13514,7 +13514,7 @@
"\nThe {@link SavedObjectsNamespaceType | namespace type} for the type."
],
"signature": [
"\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\""
"\"single\" | \"multiple\" | \"multiple-isolated\" | \"agnostic\""
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false
@ -14783,7 +14783,7 @@
"\nSee {@link SavedObjectTypeRegistry} for documentation.\n"
],
"signature": [
"{ getType: (type: string) => ",
"{ isHidden: (type: string) => boolean; getType: (type: string) => ",
{
"pluginId": "core",
"scope": "server",
@ -14815,7 +14815,7 @@
"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; }"
"<any>[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }"
],
"path": "src/core/server/saved_objects/saved_objects_type_registry.ts",
"deprecated": false,
@ -15445,7 +15445,7 @@
"label": "SavedObjectsCreatePointInTimeFinderOptions",
"description": [],
"signature": [
"{ filter?: any; search?: string | undefined; type: string | string[]; aggs?: Record<string, ",
"{ type: string | string[]; filter?: any; search?: string | undefined; aggs?: Record<string, ",
"AggregationsAggregationContainer",
"> | undefined; fields?: string[] | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: ",
"SortOrder",
@ -15647,7 +15647,7 @@
"\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n"
],
"signature": [
"\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\""
"\"single\" | \"multiple\" | \"multiple-isolated\" | \"agnostic\""
],
"path": "src/core/server/saved_objects/types.ts",
"deprecated": false,

2
api_docs/core_saved_objects.mdx
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-18
date: 2022-07-19
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.
---

8
api_docs/custom_integrations.devdocs.json
View file

@ -413,7 +413,7 @@
"label": "shipper",
"description": [],
"signature": [
"\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\" | \"placeholders\""
"\"other\" | \"beats\" | \"enterprise_search\" | \"language_clients\" | \"sample_data\" | \"tests\" | \"tutorial\" | \"placeholders\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
@ -685,7 +685,7 @@
"label": "shipper",
"description": [],
"signature": [
"\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\" | \"placeholders\""
"\"other\" | \"beats\" | \"enterprise_search\" | \"language_clients\" | \"sample_data\" | \"tests\" | \"tutorial\" | \"placeholders\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
@ -877,7 +877,7 @@
"\nThe list of all known shippers."
],
"signature": [
"(\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\" | \"placeholders\")[]"
"(\"other\" | \"beats\" | \"enterprise_search\" | \"language_clients\" | \"sample_data\" | \"tests\" | \"tutorial\" | \"placeholders\")[]"
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
@ -893,7 +893,7 @@
"\nA shipper-- an internal or external system capable of storing data in ES/Kibana-- applicable to an Integration."
],
"signature": [
"\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\" | \"placeholders\""
"\"other\" | \"beats\" | \"enterprise_search\" | \"language_clients\" | \"sample_data\" | \"tests\" | \"tutorial\" | \"placeholders\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,

2
api_docs/custom_integrations.mdx
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-18
date: 2022-07-19
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.
---

20
api_docs/dashboard.devdocs.json
View file

@ -1731,7 +1731,7 @@
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]; getOwnField: <K extends keyof ",
"[K]; getActiveIndexFilter: () => string[]; getOwnField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
@ -1863,7 +1863,7 @@
"section": "def-common.ExpressionAstExpression",
"text": "ExpressionAstExpression"
},
"; }"
"; parseActiveIndexPatternFromQueryString: (queryString: string) => string[]; }"
],
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
"deprecated": false
@ -2114,7 +2114,7 @@
"section": "def-common.RawSavedDashboardPanel730ToLatest",
"text": "RawSavedDashboardPanel730ToLatest"
},
", \"title\" | \"type\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }"
", \"type\" | \"version\" | \"title\" | \"panelIndex\" | \"gridData\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
@ -2785,7 +2785,7 @@
"signature": [
"Pick<",
"RawSavedDashboardPanel640To720",
", \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; panelRefName?: string | undefined; }"
", \"version\" | \"title\" | \"panelIndex\" | \"gridData\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; panelRefName?: string | undefined; }"
],
"path": "src/plugins/dashboard/common/bwc/types.ts",
"deprecated": false,
@ -2801,7 +2801,7 @@
"signature": [
"Pick<",
"RawSavedDashboardPanel610",
", \"title\" | \"columns\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\"> & { readonly id: string; readonly type: string; }"
", \"version\" | \"title\" | \"columns\" | \"sort\" | \"panelIndex\" | \"gridData\"> & { readonly id: string; readonly type: string; }"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
@ -2817,7 +2817,7 @@
"signature": [
"Pick<",
"RawSavedDashboardPanel620",
", \"title\" | \"columns\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
", \"version\" | \"title\" | \"columns\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
@ -2833,7 +2833,7 @@
"signature": [
"Pick<",
"RawSavedDashboardPanel620",
", \"title\" | \"columns\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
", \"version\" | \"title\" | \"columns\" | \"sort\" | \"panelIndex\" | \"gridData\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
@ -2849,7 +2849,7 @@
"signature": [
"Pick<",
"RawSavedDashboardPanel640To720",
", \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
", \"version\" | \"title\" | \"panelIndex\" | \"gridData\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
@ -2871,7 +2871,7 @@
"section": "def-common.RawSavedDashboardPanel730ToLatest",
"text": "RawSavedDashboardPanel730ToLatest"
},
", \"title\" | \"type\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }"
", \"type\" | \"version\" | \"title\" | \"panelIndex\" | \"gridData\" | \"embeddableConfig\" | \"panelRefName\"> & { readonly id?: string | undefined; readonly type: string; }"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,
@ -2887,7 +2887,7 @@
"signature": [
"Pick<",
"RawSavedDashboardPanelTo60",
", \"title\" | \"columns\" | \"sort\" | \"size_x\" | \"size_y\" | \"row\" | \"col\" | \"panelIndex\"> & { readonly id: string; readonly type: string; }"
", \"title\" | \"row\" | \"columns\" | \"sort\" | \"size_x\" | \"size_y\" | \"col\" | \"panelIndex\"> & { readonly id: string; readonly type: string; }"
],
"path": "src/plugins/dashboard/common/types.ts",
"deprecated": false,

2
api_docs/dashboard.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/dashboard_enhanced.mdx
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-18
date: 2022-07-19
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.
---

145
api_docs/data.devdocs.json
View file

@ -3275,6 +3275,21 @@
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.SearchSource.getActiveIndexFilter",
"type": "Function",
"tags": [],
"label": "getActiveIndexFilter",
"description": [],
"signature": [
"() => string[]"
],
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-public.SearchSource.getOwnField",
@ -3917,6 +3932,36 @@
"returnComment": [
"The expression AST."
]
},
{
"parentPluginId": "data",
"id": "def-public.SearchSource.parseActiveIndexPatternFromQueryString",
"type": "Function",
"tags": [],
"label": "parseActiveIndexPatternFromQueryString",
"description": [],
"signature": [
"(queryString: string) => string[]"
],
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-public.SearchSource.parseActiveIndexPatternFromQueryString.$1",
"type": "string",
"tags": [],
"label": "queryString",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
@ -8291,6 +8336,9 @@
"tags": [],
"label": "ES_FIELD_TYPES",
"description": [],
"signature": [
"ES_FIELD_TYPES"
],
"path": "node_modules/@types/kbn__field-types/index.d.ts",
"deprecated": false,
"initialIsOpen": false
@ -8302,6 +8350,9 @@
"tags": [],
"label": "KBN_FIELD_TYPES",
"description": [],
"signature": [
"KBN_FIELD_TYPES"
],
"path": "node_modules/@types/kbn__field-types/index.d.ts",
"deprecated": false,
"initialIsOpen": false
@ -8338,7 +8389,7 @@
"label": "AggConfigOptions",
"description": [],
"signature": [
"{ id?: string | undefined; type: ",
"{ type: ",
{
"pluginId": "data",
"scope": "common",
@ -8346,7 +8397,7 @@
"section": "def-common.IAggType",
"text": "IAggType"
},
"; enabled?: boolean | undefined; params?: {} | ",
"; id?: string | undefined; enabled?: boolean | undefined; params?: {} | ",
"SerializableRecord",
" | undefined; schema?: string | undefined; }"
],
@ -9198,7 +9249,7 @@
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]; getOwnField: <K extends keyof ",
"[K]; getActiveIndexFilter: () => string[]; getOwnField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
@ -9330,7 +9381,7 @@
"section": "def-common.ExpressionAstExpression",
"text": "ExpressionAstExpression"
},
"; }"
"; parseActiveIndexPatternFromQueryString: (queryString: string) => string[]; }"
],
"path": "src/plugins/data/common/search/search_source/types.ts",
"deprecated": false,
@ -9395,7 +9446,7 @@
"signature": [
"{ value: number; unit: ",
"Unit",
"; type: \"calendar\" | \"fixed\"; }"
"; type: \"fixed\" | \"calendar\"; }"
],
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts",
"deprecated": false,
@ -10424,7 +10475,7 @@
"signature": [
"(interval: string) => { value: number; unit: ",
"Unit",
"; type: \"calendar\" | \"fixed\"; }"
"; type: \"fixed\" | \"calendar\"; }"
],
"path": "src/plugins/data/public/index.ts",
"deprecated": false,
@ -13291,7 +13342,24 @@
"tags": [],
"label": "clearCache",
"description": [
"\nClear index pattern list cache."
"\nClear index pattern saved objects cache."
],
"signature": [
"() => void"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-server.DataViewsService.clearInstanceCache",
"type": "Function",
"tags": [],
"label": "clearInstanceCache",
"description": [
"\nClear index pattern instance cache"
],
"signature": [
"(id?: string | undefined) => void"
@ -13301,13 +13369,11 @@
"children": [
{
"parentPluginId": "data",
"id": "def-server.DataViewsService.clearCache.$1",
"id": "def-server.DataViewsService.clearInstanceCache.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [
"optionally clear a single id"
],
"description": [],
"signature": [
"string | undefined"
],
@ -15089,7 +15155,7 @@
"label": "elasticsearchClient",
"description": [],
"signature": [
"{ eql: ",
"{ name: string | symbol; transform: ",
"default",
"; search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate",
@ -15123,7 +15189,9 @@
"TransportRequestOptions",
" | undefined): Promise<",
"SearchResponse",
"<TDocument, TAggregations>>; }; create: { <TDocument = unknown>(this: That, params: ",
"<TDocument, TAggregations>>; }; eql: ",
"default",
"; create: { <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
@ -15153,7 +15221,7 @@
"default",
"; security: ",
"default",
"; name: string | symbol; index: { <TDocument = unknown>(this: That, params: ",
"; index: { <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
@ -16219,8 +16287,6 @@
"TermvectorsResponse",
">; }; textStructure: ",
"default",
"; transform: ",
"default",
"; updateByQuery: { (this: That, params: ",
"UpdateByQueryRequest",
" | ",
@ -16638,6 +16704,9 @@
"tags": [],
"label": "ES_FIELD_TYPES",
"description": [],
"signature": [
"ES_FIELD_TYPES"
],
"path": "node_modules/@types/kbn__field-types/index.d.ts",
"deprecated": false,
"initialIsOpen": false
@ -16649,6 +16718,9 @@
"tags": [],
"label": "KBN_FIELD_TYPES",
"description": [],
"signature": [
"KBN_FIELD_TYPES"
],
"path": "node_modules/@types/kbn__field-types/index.d.ts",
"deprecated": false,
"initialIsOpen": false
@ -16729,7 +16801,7 @@
"signature": [
"{ value: number; unit: ",
"Unit",
"; type: \"calendar\" | \"fixed\"; }"
"; type: \"fixed\" | \"calendar\"; }"
],
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts",
"deprecated": false,
@ -20432,7 +20504,24 @@
"tags": [],
"label": "clearCache",
"description": [
"\nClear index pattern list cache."
"\nClear index pattern saved objects cache."
],
"signature": [
"() => void"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.DataViewsService.clearInstanceCache",
"type": "Function",
"tags": [],
"label": "clearInstanceCache",
"description": [
"\nClear index pattern instance cache"
],
"signature": [
"(id?: string | undefined) => void"
@ -20442,13 +20531,11 @@
"children": [
{
"parentPluginId": "data",
"id": "def-common.DataViewsService.clearCache.$1",
"id": "def-common.DataViewsService.clearInstanceCache.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [
"optionally clear a single id"
],
"description": [],
"signature": [
"string | undefined"
],
@ -21429,6 +21516,9 @@
"tags": [],
"label": "KbnFieldType",
"description": [],
"signature": [
"KbnFieldType"
],
"path": "node_modules/@types/kbn__field-types/index.d.ts",
"deprecated": false,
"children": [
@ -22654,6 +22744,9 @@
"tags": [],
"label": "KbnFieldTypeOptions",
"description": [],
"signature": [
"KbnFieldTypeOptions"
],
"path": "node_modules/@types/kbn__field-types/index.d.ts",
"deprecated": false,
"children": [
@ -23053,6 +23146,9 @@
"tags": [],
"label": "ES_FIELD_TYPES",
"description": [],
"signature": [
"ES_FIELD_TYPES"
],
"path": "node_modules/@types/kbn__field-types/index.d.ts",
"deprecated": false,
"initialIsOpen": false
@ -23064,6 +23160,9 @@
"tags": [],
"label": "KBN_FIELD_TYPES",
"description": [],
"signature": [
"KBN_FIELD_TYPES"
],
"path": "node_modules/@types/kbn__field-types/index.d.ts",
"deprecated": false,
"initialIsOpen": false
@ -23200,7 +23299,7 @@
"section": "def-common.DataViewListItem",
"text": "DataViewListItem"
},
"[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<",
"[]>; clearCache: () => void; clearInstanceCache: (id?: string | undefined) => void; getCache: () => Promise<",
"SavedObject",
"<",
"DataViewSavedObjectAttrs",

4
api_docs/data.mdx
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-18
date: 2022-07-19
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.
---
@ -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 |
|-------------------|-----------|------------------------|-----------------|
| 3075 | 34 | 2402 | 21 |
| 3084 | 34 | 2411 | 21 |
## Client

4
api_docs/data_query.mdx
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-18
date: 2022-07-19
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.
---
@ -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 |
|-------------------|-----------|------------------------|-----------------|
| 3075 | 34 | 2402 | 21 |
| 3084 | 34 | 2411 | 21 |
## Client

88
api_docs/data_search.devdocs.json
View file

@ -2860,9 +2860,9 @@
"label": "options",
"description": [],
"signature": [
"{ filter?: any; search?: string | undefined; aggs?: Record<string, ",
"{ filter?: any; search?: string | undefined; page?: number | undefined; aggs?: Record<string, ",
"AggregationsAggregationContainer",
"> | undefined; fields?: string[] | undefined; searchAfter?: string[] | undefined; page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: ",
"> | undefined; fields?: string[] | undefined; searchAfter?: string[] | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: ",
"SortOrder",
" | undefined; searchFields?: string[] | undefined; rootSearchFields?: string[] | undefined; hasReference?: ",
{
@ -6998,7 +6998,7 @@
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]; getOwnField: <K extends keyof ",
"[K]; getActiveIndexFilter: () => string[]; getOwnField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
@ -7130,7 +7130,7 @@
"section": "def-common.ExpressionAstExpression",
"text": "ExpressionAstExpression"
},
"; }"
"; parseActiveIndexPatternFromQueryString: (queryString: string) => string[]; }"
],
"path": "src/plugins/data/common/search/aggs/agg_type.ts",
"deprecated": false
@ -9722,6 +9722,21 @@
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.SearchSource.getActiveIndexFilter",
"type": "Function",
"tags": [],
"label": "getActiveIndexFilter",
"description": [],
"signature": [
"() => string[]"
],
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.SearchSource.getOwnField",
@ -10364,6 +10379,36 @@
"returnComment": [
"The expression AST."
]
},
{
"parentPluginId": "data",
"id": "def-common.SearchSource.parseActiveIndexPatternFromQueryString",
"type": "Function",
"tags": [],
"label": "parseActiveIndexPatternFromQueryString",
"description": [],
"signature": [
"(queryString: string) => string[]"
],
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.SearchSource.parseActiveIndexPatternFromQueryString.$1",
"type": "string",
"tags": [],
"label": "queryString",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/data/common/search/search_source/search_source.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
@ -15163,7 +15208,7 @@
"signature": [
"(interval: string) => { value: number; unit: ",
"Unit",
"; type: \"calendar\" | \"fixed\"; }"
"; type: \"fixed\" | \"calendar\"; }"
],
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts",
"deprecated": false,
@ -20410,6 +20455,19 @@
"description": [],
"path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.AggParamsStdDeviation.showBounds",
"type": "CompoundType",
"tags": [],
"label": "showBounds",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/search/aggs/metrics/std_deviation.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -20694,7 +20752,7 @@
"label": "aggregate",
"description": [],
"signature": [
"\"concat\" | \"min\" | \"max\" | \"sum\" | \"average\""
"\"min\" | \"max\" | \"sum\" | \"concat\" | \"average\""
],
"path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts",
"deprecated": false
@ -26263,7 +26321,7 @@
"label": "AggConfigOptions",
"description": [],
"signature": [
"{ id?: string | undefined; type: ",
"{ type: ",
{
"pluginId": "data",
"scope": "common",
@ -26271,7 +26329,7 @@
"section": "def-common.IAggType",
"text": "IAggType"
},
"; enabled?: boolean | undefined; params?: {} | ",
"; id?: string | undefined; enabled?: boolean | undefined; params?: {} | ",
"SerializableRecord",
" | undefined; schema?: string | undefined; }"
],
@ -27065,7 +27123,7 @@
"label": "CreateAggConfigParams",
"description": [],
"signature": [
"{ id?: string | undefined; type: string | ",
"{ type: string | ",
{
"pluginId": "data",
"scope": "common",
@ -27073,7 +27131,7 @@
"section": "def-common.IAggType",
"text": "IAggType"
},
"; enabled?: boolean | undefined; params?: {} | ",
"; id?: string | undefined; enabled?: boolean | undefined; params?: {} | ",
"SerializableRecord",
" | undefined; schema?: string | undefined; }"
],
@ -29324,7 +29382,7 @@
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]; getOwnField: <K extends keyof ",
"[K]; getActiveIndexFilter: () => string[]; getOwnField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
@ -29456,7 +29514,7 @@
"section": "def-common.ExpressionAstExpression",
"text": "ExpressionAstExpression"
},
"; }"
"; parseActiveIndexPatternFromQueryString: (queryString: string) => string[]; }"
],
"path": "src/plugins/data/common/search/search_source/types.ts",
"deprecated": false,
@ -29625,7 +29683,7 @@
"signature": [
"{ value: number; unit: ",
"Unit",
"; type: \"calendar\" | \"fixed\"; }"
"; type: \"fixed\" | \"calendar\"; }"
],
"path": "src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts",
"deprecated": false,
@ -29716,7 +29774,7 @@
"label": "SearchTypes",
"description": [],
"signature": [
"string | number | boolean | object | string[] | number[] | boolean[] | object[] | undefined"
"string | number | boolean | object | number[] | string[] | boolean[] | object[] | undefined"
],
"path": "src/plugins/data/common/search/expressions/eql_raw_response.ts",
"deprecated": false,
@ -32168,7 +32226,7 @@
"label": "inputTypes",
"description": [],
"signature": [
"(\"kibana_context\" | \"null\")[]"
"(\"null\" | \"kibana_context\")[]"
],
"path": "src/plugins/data/common/search/expressions/kibana.ts",
"deprecated": false

4
api_docs/data_search.mdx
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-18
date: 2022-07-19
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.
---
@ -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 |
|-------------------|-----------|------------------------|-----------------|
| 3075 | 34 | 2402 | 21 |
| 3084 | 34 | 2411 | 21 |
## Client

2
api_docs/data_view_editor.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/data_view_field_editor.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/data_view_management.mdx
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-18
date: 2022-07-19
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.
---

122
api_docs/data_views.devdocs.json
View file

File diff suppressed because one or more lines are too long

4
api_docs/data_views.mdx
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-18
date: 2022-07-19
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 |
|-------------------|-----------|------------------------|-----------------|
| 938 | 1 | 199 | 1 |
| 942 | 1 | 202 | 1 |
## Client

2
api_docs/data_visualizer.mdx
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-18
date: 2022-07-19
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.
---

8
api_docs/deprecations_by_api.mdx
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-18
date: 2022-07-19
tags: ['contributor', 'dev', 'apidocs', 'kibana']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
---
@ -13,6 +13,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| Deprecated API | Referencing plugin(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibExpressionGaugePluginApi" section="def-common.GaugeState.percentageMode" text="percentageMode"/> | visTypeGauge | - |
| <DocLink id="kibExpressionPartitionVisPluginApi" section="def-common.LabelsParams.truncate" text="truncate"/> | visTypePie | - |
| <DocLink id="kibExpressionPartitionVisPluginApi" section="def-common.LabelsParams.last_level" text="last_level"/> | visTypePie | - |
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.create" text="create"/> | alerting, discover, securitySolution | - |
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.create" text="create"/> | alerting, discover, securitySolution | - |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | actions, alerting | - |
@ -56,9 +59,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authz" text="authz"/> | actions, ml, enterpriseSearch, savedObjectsTagging | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | spaces, savedObjectsManagement | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | spaces, savedObjectsManagement | - |
| <DocLink id="kibExpressionGaugePluginApi" section="def-common.GaugeState.percentageMode" text="percentageMode"/> | visTypeGauge | - |
| <DocLink id="kibExpressionPartitionVisPluginApi" section="def-common.LabelsParams.truncate" text="truncate"/> | visTypePie | - |
| <DocLink id="kibExpressionPartitionVisPluginApi" section="def-common.LabelsParams.last_level" text="last_level"/> | visTypePie | - |
| <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | console | - |
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | 8.1 |
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | 8.1 |

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

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

2
api_docs/dev_tools.mdx
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-18
date: 2022-07-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

4
api_docs/discover.devdocs.json
View file

@ -647,7 +647,7 @@
"section": "def-common.SearchSourceFields",
"text": "SearchSourceFields"
},
"[K]; getOwnField: <K extends keyof ",
"[K]; getActiveIndexFilter: () => string[]; getOwnField: <K extends keyof ",
{
"pluginId": "data",
"scope": "common",
@ -779,7 +779,7 @@
"section": "def-common.ExpressionAstExpression",
"text": "ExpressionAstExpression"
},
"; }"
"; parseActiveIndexPatternFromQueryString: (queryString: string) => string[]; }"
],
"path": "src/plugins/discover/public/services/saved_searches/types.ts",
"deprecated": false

2
api_docs/discover.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/discover_enhanced.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/elastic_apm_synthtrace.mdx
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-18
date: 2022-07-19
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
api_docs/embeddable.devdocs.json
View file

@ -9237,7 +9237,7 @@
"section": "def-public.EmbeddableFactory",
"text": "EmbeddableFactory"
},
"<I, O, E, T>, \"create\" | \"type\" | \"isEditable\" | \"getDisplayName\"> & Partial<Pick<",
"<I, O, E, T>, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial<Pick<",
{
"pluginId": "embeddable",
"scope": "public",
@ -9245,7 +9245,7 @@
"section": "def-public.EmbeddableFactory",
"text": "EmbeddableFactory"
},
"<I, O, E, T>, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"grouping\" | \"getIconType\" | \"getDescription\">>"
"<I, O, E, T>, \"telemetry\" | \"inject\" | \"extract\" | \"migrations\" | \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"grouping\" | \"getIconType\" | \"getDescription\">>"
],
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory_definition.ts",
"deprecated": false,

2
api_docs/embeddable.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/embeddable_enhanced.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/encrypted_saved_objects.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/enterprise_search.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/es_ui_shared.mdx
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-18
date: 2022-07-19
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.
---

78
api_docs/event_annotation.devdocs.json
View file

@ -252,6 +252,23 @@
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.fetchEventAnnotations",
"type": "Function",
"tags": [],
"label": "fetchEventAnnotations",
"description": [],
"signature": [
"() => ",
"FetchEventAnnotationsExpressionFunctionDefinition"
],
"path": "src/plugins/event_annotation/common/fetch_event_annotations/index.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
@ -284,6 +301,63 @@
],
"path": "src/plugins/event_annotation/common/event_annotation_group/index.ts",
"deprecated": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.EventAnnotationGroupArgs.index",
"type": "Object",
"tags": [],
"label": "index",
"description": [],
"signature": [
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.IndexPatternExpressionType",
"text": "IndexPatternExpressionType"
},
" | undefined"
],
"path": "src/plugins/event_annotation/common/event_annotation_group/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.FetchEventAnnotationsArgs",
"type": "Interface",
"tags": [],
"label": "FetchEventAnnotationsArgs",
"description": [],
"path": "src/plugins/event_annotation/common/fetch_event_annotations/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "eventAnnotation",
"id": "def-common.FetchEventAnnotationsArgs.group",
"type": "Array",
"tags": [],
"label": "group",
"description": [],
"signature": [
"EventAnnotationGroupOutput",
"[]"
],
"path": "src/plugins/event_annotation/common/fetch_event_annotations/index.ts",
"deprecated": false
},
{
"parentPluginId": "eventAnnotation",
"id": "def-common.FetchEventAnnotationsArgs.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [],
"path": "src/plugins/event_annotation/common/fetch_event_annotations/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
@ -299,7 +373,7 @@
"label": "AvailableAnnotationIcon",
"description": [],
"signature": [
"\"alert\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"tag\" | \"circle\" | \"triangle\""
"\"alert\" | \"circle\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"tag\" | \"triangle\""
],
"path": "src/plugins/event_annotation/common/types.ts",
"deprecated": false,
@ -773,7 +847,7 @@
"label": "options",
"description": [],
"signature": [
"(\"alert\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"tag\" | \"circle\" | \"triangle\")[]"
"(\"alert\" | \"circle\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"tag\" | \"triangle\")[]"
],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false

4
api_docs/event_annotation.mdx
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-18
date: 2022-07-19
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.
---
@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 90 | 0 | 90 | 5 |
| 95 | 0 | 95 | 6 |
## Client

6
api_docs/event_log.devdocs.json
View file

@ -1123,7 +1123,7 @@
"label": "data",
"description": [],
"signature": [
"(Readonly<{ error?: Readonly<{ message?: string | undefined; id?: string | undefined; type?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]"
"(Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; version?: string | undefined; description?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; original?: string | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]"
],
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"deprecated": false
@ -1142,7 +1142,7 @@
"label": "IEvent",
"description": [],
"signature": [
"DeepPartial<DeepWriteable<Readonly<{ error?: Readonly<{ message?: string | undefined; id?: string | undefined; type?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined"
"DeepPartial<DeepWriteable<Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; version?: string | undefined; description?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; original?: string | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined"
],
"path": "x-pack/plugins/event_log/generated/schemas.ts",
"deprecated": false,
@ -1156,7 +1156,7 @@
"label": "IValidatedEvent",
"description": [],
"signature": [
"Readonly<{ error?: Readonly<{ message?: string | undefined; id?: string | undefined; type?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined"
"Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ version?: string | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; version?: string | undefined; description?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; end?: string | undefined; original?: string | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined"
],
"path": "x-pack/plugins/event_log/generated/schemas.ts",
"deprecated": false,

2
api_docs/event_log.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/expression_error.mdx
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-18
date: 2022-07-19
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.
---

8
api_docs/expression_gauge.devdocs.json
View file

@ -714,7 +714,7 @@
"label": "labelMajorMode",
"description": [],
"signature": [
"\"none\" | \"custom\" | \"auto\""
"\"none\" | \"auto\" | \"custom\""
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false
@ -810,7 +810,7 @@
"label": "shape",
"description": [],
"signature": [
"\"arc\" | \"circle\" | \"horizontalBullet\" | \"verticalBullet\""
"\"horizontalBullet\" | \"verticalBullet\" | \"arc\" | \"circle\""
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false
@ -1058,7 +1058,7 @@
"label": "GaugeLabelMajorMode",
"description": [],
"signature": [
"\"none\" | \"custom\" | \"auto\""
"\"none\" | \"auto\" | \"custom\""
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,
@ -1113,7 +1113,7 @@
"label": "GaugeShape",
"description": [],
"signature": [
"\"arc\" | \"circle\" | \"horizontalBullet\" | \"verticalBullet\""
"\"horizontalBullet\" | \"verticalBullet\" | \"arc\" | \"circle\""
],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false,

2
api_docs/expression_gauge.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/expression_heatmap.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/expression_image.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/expression_legacy_metric_vis.mdx
View file

@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis
title: "expressionLegacyMetricVis"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the expressionLegacyMetricVis plugin
date: 2022-07-18
date: 2022-07-19
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---

2
api_docs/expression_metric.devdocs.json
View file

@ -174,7 +174,7 @@
"label": "metricFunction",
"description": [],
"signature": [
"() => { name: \"metric\"; aliases: never[]; type: \"render\"; inputTypes: (\"number\" | \"string\" | \"null\")[]; help: string; args: { label: { types: \"string\"[]; aliases: string[]; help: string; default: string; }; labelFont: { types: \"style\"[]; help: string; default: string; }; metricFont: { types: \"style\"[]; help: string; default: string; }; metricFormat: { types: \"string\"[]; aliases: string[]; help: string; }; }; fn: (input: ",
"() => { name: \"metric\"; aliases: never[]; type: \"render\"; inputTypes: (\"number\" | \"null\" | \"string\")[]; help: string; args: { label: { types: \"string\"[]; aliases: string[]; help: string; default: string; }; labelFont: { types: \"style\"[]; help: string; default: string; }; metricFont: { types: \"style\"[]; help: string; default: string; }; metricFormat: { types: \"string\"[]; aliases: string[]; help: string; }; }; fn: (input: ",
{
"pluginId": "expressionMetric",
"scope": "common",

2
api_docs/expression_metric.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/expression_metric_vis.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/expression_partition_vis.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/expression_repeat_image.devdocs.json
View file

@ -174,7 +174,7 @@
"label": "repeatImageFunction",
"description": [],
"signature": [
"() => { name: \"repeatImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: string; args: { emptyImage: { types: (\"string\" | \"null\")[]; help: string; default: null; }; image: { types: (\"string\" | \"null\")[]; help: string; default: null; }; max: { types: (\"number\" | \"null\")[]; help: string; default: number; }; size: { types: \"number\"[]; default: number; help: string; }; }; fn: (count: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string | null; emptyImage: string | null; size: number; max: number | null; count: number; }; }>; }"
"() => { name: \"repeatImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: string; args: { emptyImage: { types: (\"null\" | \"string\")[]; help: string; default: null; }; image: { types: (\"null\" | \"string\")[]; help: string; default: null; }; max: { types: (\"number\" | \"null\")[]; help: string; default: number; }; size: { types: \"number\"[]; default: number; help: string; }; }; fn: (count: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string | null; emptyImage: string | null; size: number; max: number | null; count: number; }; }>; }"
],
"path": "src/plugins/expression_repeat_image/common/expression_functions/repeat_image_function.ts",
"deprecated": false,

2
api_docs/expression_repeat_image.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/expression_reveal_image.devdocs.json
View file

@ -162,7 +162,7 @@
"label": "revealImageFunction",
"description": [],
"signature": [
"() => { name: \"revealImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: string; args: { image: { types: (\"string\" | \"null\")[]; help: string; default: null; }; emptyImage: { types: (\"string\" | \"null\")[]; help: string; default: null; }; origin: { types: \"string\"[]; help: string; default: string; options: ",
"() => { name: \"revealImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: string; args: { image: { types: (\"null\" | \"string\")[]; help: string; default: null; }; emptyImage: { types: (\"null\" | \"string\")[]; help: string; default: null; }; origin: { types: \"string\"[]; help: string; default: string; options: ",
"Origin",
"[]; }; }; fn: (percent: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string; emptyImage: string; origin: ",
"Origin",

2
api_docs/expression_reveal_image.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/expression_shape.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/expression_tagcloud.mdx
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-18
date: 2022-07-19
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.
---

16
api_docs/expression_x_y.devdocs.json
View file

@ -554,7 +554,7 @@
"label": "seriesType",
"description": [],
"signature": [
"\"area\" | \"line\" | \"bar\""
"\"bar\" | \"line\" | \"area\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false
@ -1331,7 +1331,7 @@
"label": "valueLabels",
"description": [],
"signature": [
"\"show\" | \"hide\""
"\"hide\" | \"show\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false
@ -1794,7 +1794,7 @@
"label": "AvailableReferenceLineIcon",
"description": [],
"signature": [
"\"alert\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"empty\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"tag\" | \"circle\" | \"triangle\""
"\"alert\" | \"circle\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"tag\" | \"triangle\" | \"empty\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
@ -2116,7 +2116,7 @@
"label": "IconPosition",
"description": [],
"signature": [
"\"above\" | \"below\" | \"left\" | \"right\" | \"auto\""
"\"above\" | \"below\" | \"auto\" | \"left\" | \"right\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
@ -2130,7 +2130,7 @@
"label": "LayerType",
"description": [],
"signature": [
"\"data\" | \"annotations\" | \"referenceLine\""
"\"data\" | \"referenceLine\" | \"annotations\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
@ -2287,7 +2287,7 @@
"label": "SeriesType",
"description": [],
"signature": [
"\"area\" | \"line\" | \"bar\""
"\"bar\" | \"line\" | \"area\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
@ -2301,7 +2301,7 @@
"label": "ValueLabelMode",
"description": [],
"signature": [
"\"show\" | \"hide\""
"\"hide\" | \"show\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,
@ -2445,7 +2445,7 @@
"label": "YScaleType",
"description": [],
"signature": [
"\"time\" | \"log\" | \"linear\" | \"sqrt\""
"\"log\" | \"time\" | \"linear\" | \"sqrt\""
],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false,

2
api_docs/expression_x_y.mdx
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-18
date: 2022-07-19
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.
---

36
api_docs/expressions.devdocs.json
View file

@ -6980,7 +6980,7 @@
"\nTracks state of execution.\n\n- `not-started` - before .start() method was called.\n- `pending` - immediately after .start() method is called.\n- `result` - when expression execution completed.\n- `error` - when execution failed with error."
],
"signature": [
"\"error\" | \"not-started\" | \"pending\" | \"result\""
"\"error\" | \"result\" | \"not-started\" | \"pending\""
],
"path": "src/plugins/expressions/common/execution/container.ts",
"deprecated": false
@ -10783,7 +10783,7 @@
"label": "padding",
"description": [],
"signature": [
"\"m\" | \"s\" | \"xs\" | \"l\" | \"xl\" | undefined"
"\"s\" | \"m\" | \"l\" | \"xl\" | \"xs\" | undefined"
],
"path": "src/plugins/expressions/public/react_expression_renderer/react_expression_renderer.tsx",
"deprecated": false
@ -10991,7 +10991,7 @@
"\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES"
],
"signature": [
"\"string\" | \"number\" | \"boolean\" | \"object\" | \"ip\" | \"nested\" | \"conflict\" | \"_source\" | \"attachment\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"histogram\" | \"null\""
"\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"null\" | \"ip\" | \"nested\" | \"conflict\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"histogram\""
],
"path": "src/plugins/expressions/common/expression_types/specs/datatable.ts",
"deprecated": false,
@ -11584,7 +11584,7 @@
"\nAllowed column names in a PointSeries"
],
"signature": [
"\"color\" | \"size\" | \"text\" | \"y\" | \"x\""
"\"color\" | \"size\" | \"x\" | \"y\" | \"text\""
],
"path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts",
"deprecated": false,
@ -17434,7 +17434,7 @@
"\nTracks state of execution.\n\n- `not-started` - before .start() method was called.\n- `pending` - immediately after .start() method is called.\n- `result` - when expression execution completed.\n- `error` - when execution failed with error."
],
"signature": [
"\"error\" | \"not-started\" | \"pending\" | \"result\""
"\"error\" | \"result\" | \"not-started\" | \"pending\""
],
"path": "src/plugins/expressions/common/execution/container.ts",
"deprecated": false
@ -20078,7 +20078,7 @@
"\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES"
],
"signature": [
"\"string\" | \"number\" | \"boolean\" | \"object\" | \"ip\" | \"nested\" | \"conflict\" | \"_source\" | \"attachment\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"histogram\" | \"null\""
"\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"null\" | \"ip\" | \"nested\" | \"conflict\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"histogram\""
],
"path": "src/plugins/expressions/common/expression_types/specs/datatable.ts",
"deprecated": false,
@ -20599,7 +20599,7 @@
"\nAllowed column names in a PointSeries"
],
"signature": [
"\"color\" | \"size\" | \"text\" | \"y\" | \"x\""
"\"color\" | \"size\" | \"x\" | \"y\" | \"text\""
],
"path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts",
"deprecated": false,
@ -27875,7 +27875,7 @@
"label": "type",
"description": [],
"signature": [
"\"string\" | \"number\" | \"boolean\" | \"object\" | \"ip\" | \"nested\" | \"conflict\" | \"_source\" | \"attachment\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"histogram\" | \"null\""
"\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"null\" | \"ip\" | \"nested\" | \"conflict\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"histogram\""
],
"path": "src/plugins/expressions/common/expression_types/specs/datatable.ts",
"deprecated": false
@ -28753,7 +28753,7 @@
"\nTracks state of execution.\n\n- `not-started` - before .start() method was called.\n- `pending` - immediately after .start() method is called.\n- `result` - when expression execution completed.\n- `error` - when execution failed with error."
],
"signature": [
"\"error\" | \"not-started\" | \"pending\" | \"result\""
"\"error\" | \"result\" | \"not-started\" | \"pending\""
],
"path": "src/plugins/expressions/common/execution/container.ts",
"deprecated": false
@ -33590,7 +33590,7 @@
"\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES"
],
"signature": [
"\"string\" | \"number\" | \"boolean\" | \"object\" | \"ip\" | \"nested\" | \"conflict\" | \"_source\" | \"attachment\" | \"date\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"histogram\" | \"null\""
"\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"null\" | \"ip\" | \"nested\" | \"conflict\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"histogram\""
],
"path": "src/plugins/expressions/common/expression_types/specs/datatable.ts",
"deprecated": false,
@ -34668,7 +34668,7 @@
"label": "MathArguments",
"description": [],
"signature": [
"{ expression: string; onError?: \"null\" | \"false\" | \"zero\" | \"throw\" | undefined; }"
"{ expression: string; onError?: \"false\" | \"null\" | \"zero\" | \"throw\" | undefined; }"
],
"path": "src/plugins/expressions/common/expression_functions/specs/math.ts",
"deprecated": false,
@ -34758,7 +34758,7 @@
"\nAllowed column names in a PointSeries"
],
"signature": [
"\"color\" | \"size\" | \"text\" | \"y\" | \"x\""
"\"color\" | \"size\" | \"x\" | \"y\" | \"text\""
],
"path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts",
"deprecated": false,
@ -38182,7 +38182,7 @@
"label": "types",
"description": [],
"signature": [
"(\"string\" | \"null\")[]"
"(\"null\" | \"string\")[]"
],
"path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts",
"deprecated": false
@ -38304,7 +38304,7 @@
"label": "types",
"description": [],
"signature": [
"(\"number\" | \"string\" | \"boolean\" | \"null\")[]"
"(\"number\" | \"null\" | \"boolean\" | \"string\")[]"
],
"path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts",
"deprecated": false
@ -38378,7 +38378,7 @@
"label": "types",
"description": [],
"signature": [
"(\"string\" | \"null\")[]"
"(\"null\" | \"string\")[]"
],
"path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts",
"deprecated": false
@ -38674,7 +38674,7 @@
"label": "options",
"description": [],
"signature": [
"(\"null\" | \"false\" | \"zero\" | \"throw\")[]"
"(\"false\" | \"null\" | \"zero\" | \"throw\")[]"
],
"path": "src/plugins/expressions/common/expression_functions/specs/math.ts",
"deprecated": false
@ -38977,7 +38977,7 @@
"label": "types",
"description": [],
"signature": [
"(\"string\" | \"null\")[]"
"(\"null\" | \"string\")[]"
],
"path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts",
"deprecated": false
@ -40274,7 +40274,7 @@
"label": "options",
"description": [],
"signature": [
"(\"min\" | \"max\" | \"sum\" | \"average\")[]"
"(\"sum\" | \"min\" | \"max\" | \"average\")[]"
],
"path": "src/plugins/expressions/common/expression_functions/specs/overall_metric.ts",
"deprecated": false

2
api_docs/expressions.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/features.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/field_formats.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/file_upload.mdx
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-18
date: 2022-07-19
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.
---

14
api_docs/fleet.devdocs.json
View file

@ -11097,7 +11097,7 @@
"label": "body",
"description": [],
"signature": [
"{ description?: string | undefined; name: string; }"
"{ name: string; description?: string | undefined; }"
],
"path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts",
"deprecated": false
@ -20308,7 +20308,7 @@
"section": "def-common.ValueOf",
"text": "ValueOf"
},
"<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; description?: string | undefined; name: string; updated_at: string; namespace: string; updated_by: string; is_managed: boolean; is_default?: boolean | undefined; is_default_fleet_server?: boolean | undefined; has_fleet_server?: boolean | undefined; monitoring_enabled?: (\"metrics\" | \"logs\")[] | undefined; unenroll_timeout?: number | undefined; is_preconfigured?: boolean | undefined; data_output_id?: string | null | undefined; monitoring_output_id?: string | null | undefined; download_source_id?: string | null | undefined; package_policies: string[] | ",
"<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; name: string; description?: string | undefined; updated_at: string; namespace: string; updated_by: string; is_managed: boolean; is_default?: boolean | undefined; is_default_fleet_server?: boolean | undefined; has_fleet_server?: boolean | undefined; monitoring_enabled?: (\"metrics\" | \"logs\")[] | undefined; unenroll_timeout?: number | undefined; is_preconfigured?: boolean | undefined; data_output_id?: string | null | undefined; monitoring_output_id?: string | null | undefined; download_source_id?: string | null | undefined; package_policies: string[] | ",
{
"pluginId": "fleet",
"scope": "common",
@ -20372,7 +20372,7 @@
"label": "AgentStatus",
"description": [],
"signature": [
"\"error\" | \"offline\" | \"online\" | \"warning\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"updating\" | \"degraded\""
"\"error\" | \"warning\" | \"offline\" | \"online\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"updating\" | \"degraded\""
],
"path": "x-pack/plugins/fleet/common/types/models/agent.ts",
"deprecated": false,
@ -22355,7 +22355,7 @@
"label": "PackagePolicySOAttributes",
"description": [],
"signature": [
"{ package?: ",
"{ name: string; package?: ",
{
"pluginId": "fleet",
"scope": "common",
@ -22363,7 +22363,7 @@
"section": "def-common.PackagePolicyPackage",
"text": "PackagePolicyPackage"
},
" | undefined; description?: string | undefined; name: string; enabled: boolean; updated_at: string; namespace: string; created_at: string; created_by: string; updated_by: string; vars?: ",
" | undefined; description?: string | undefined; enabled: boolean; updated_at: string; namespace: string; created_at: string; created_by: string; updated_by: string; vars?: ",
{
"pluginId": "fleet",
"scope": "common",
@ -22685,7 +22685,7 @@
"label": "RegistrySearchResult",
"description": [],
"signature": [
"{ download: string; title: string; type?: \"integration\" | undefined; description: string; icons?: (",
"{ type?: \"integration\" | undefined; name: string; path: string; version: string; title: string; download: string; description: string; icons?: (",
{
"pluginId": "fleet",
"scope": "common",
@ -22709,7 +22709,7 @@
"section": "def-common.PackageSpecCategory",
"text": "PackageSpecCategory"
},
" | undefined)[] | undefined; name: string; version: string; path: string; internal?: boolean | undefined; data_streams?: ",
" | undefined)[] | undefined; internal?: boolean | undefined; data_streams?: ",
{
"pluginId": "fleet",
"scope": "common",

2
api_docs/fleet.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/global_search.mdx
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-18
date: 2022-07-19
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.
---

20
api_docs/home.devdocs.json
View file

@ -375,7 +375,7 @@
"{@link FeatureCatalogueCategory} to display this feature in."
],
"signature": [
"\"data\" | \"other\" | \"admin\""
"\"other\" | \"data\" | \"admin\""
],
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
"deprecated": false
@ -708,7 +708,7 @@
"label": "FeatureCatalogueCategory",
"description": [],
"signature": [
"\"data\" | \"other\" | \"admin\""
"\"other\" | \"data\" | \"admin\""
],
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
"deprecated": false,
@ -1584,7 +1584,7 @@
"label": "ArtifactsSchema",
"description": [],
"signature": [
"{ readonly application?: Readonly<{} & { label: string; path: string; }> | undefined; readonly exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; readonly dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }"
"{ readonly application?: Readonly<{} & { path: string; label: string; }> | undefined; readonly exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; readonly dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }"
],
"path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts",
"deprecated": false,
@ -1598,7 +1598,7 @@
"label": "InstructionSetSchema",
"description": [],
"signature": [
"{ readonly title?: string | undefined; readonly callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; readonly statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; readonly instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }"
"{ readonly title?: string | undefined; readonly callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; readonly statusCheck?: Readonly<{ error?: string | undefined; title?: string | undefined; success?: string | undefined; text?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; readonly instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }"
],
"path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts",
"deprecated": false,
@ -1612,7 +1612,7 @@
"label": "InstructionsSchema",
"description": [],
"signature": [
"{ readonly params?: Readonly<{ defaultValue?: any; } & { label: string; id: string; type: \"string\" | \"number\"; }>[] | undefined; readonly instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }"
"{ readonly params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; readonly instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; title?: string | undefined; success?: string | undefined; text?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }"
],
"path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts",
"deprecated": false,
@ -1628,7 +1628,7 @@
"signature": [
"{ getSampleDatasets: () => ",
"Writable",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { id: string; type: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; name: string; description: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
"SavedObject",
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ",
{
@ -1662,7 +1662,7 @@
"signature": [
"() => ",
"Writable",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { id: string; type: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>"
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; name: string; description: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>"
],
"path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts",
"deprecated": false,
@ -1716,7 +1716,7 @@
"section": "def-server.TutorialContext",
"text": "TutorialContext"
},
") => Readonly<{ isBeta?: boolean | undefined; savedObjects?: any[] | undefined; euiIconType?: string | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { label: string; id: string; type: \"string\" | \"number\"; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { label: string; id: string; type: \"string\" | \"number\"; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { id: string; name: string; category: \"other\" | \"security\" | \"metrics\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { label: string; id: string; type: \"string\" | \"number\"; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>"
") => Readonly<{ isBeta?: boolean | undefined; savedObjects?: any[] | undefined; euiIconType?: string | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; title?: string | undefined; success?: string | undefined; text?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; title?: string | undefined; success?: string | undefined; text?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { id: string; name: string; category: \"other\" | \"security\" | \"metrics\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; title?: string | undefined; success?: string | undefined; text?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>"
],
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
"deprecated": false,
@ -1752,7 +1752,7 @@
"label": "TutorialSchema",
"description": [],
"signature": [
"{ readonly isBeta?: boolean | undefined; readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { label: string; id: string; type: \"string\" | \"number\"; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { label: string; id: string; type: \"string\" | \"number\"; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { label: string; path: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly id: string; readonly name: string; readonly category: \"other\" | \"security\" | \"metrics\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { label: string; id: string; type: \"string\" | \"number\"; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }"
"{ readonly isBeta?: boolean | undefined; readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; title?: string | undefined; success?: string | undefined; text?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; title?: string | undefined; success?: string | undefined; text?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly id: string; readonly name: string; readonly category: \"other\" | \"security\" | \"metrics\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; title?: string | undefined; success?: string | undefined; text?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }"
],
"path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts",
"deprecated": false,
@ -2021,7 +2021,7 @@
"signature": [
"{ getSampleDatasets: () => ",
"Writable",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { id: string; type: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; name: string; description: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
"SavedObject",
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ",
{

2
api_docs/home.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/index_lifecycle_management.mdx
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-18
date: 2022-07-19
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.
---

26
api_docs/index_management.devdocs.json
View file

@ -851,6 +851,32 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateDatastreams",
"type": "Interface",
"tags": [],
"label": "ComponentTemplateDatastreams",
"description": [],
"path": "x-pack/plugins/index_management/common/types/component_templates.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateDatastreams.data_streams",
"type": "Array",
"tags": [],
"label": "data_streams",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/index_management/common/types/component_templates.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.ComponentTemplateDeserialized",

4
api_docs/index_management.mdx
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-18
date: 2022-07-19
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.
---
@ -18,7 +18,7 @@ Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-ma
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 175 | 0 | 170 | 3 |
| 177 | 0 | 172 | 3 |
## Client

2
api_docs/infra.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/inspector.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/interactive_setup.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/kbn_ace.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/kbn_aiops_components.mdx
View file

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

2
api_docs/kbn_aiops_utils.mdx
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-18
date: 2022-07-19
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.
---

2
api_docs/kbn_alerts.mdx
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-18
date: 2022-07-19
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.
---

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