[api-docs] 2023-02-09 Daily api_docs build (#150659)

Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/243
This commit is contained in:
Kibana Machine 2023-02-09 00:48:16 -05:00 committed by GitHub
parent 1b85815402
commit 6dc52a3c3a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
631 changed files with 7912 additions and 80746 deletions

View file

@ -1905,17 +1905,7 @@
"label": "ActionsClient", "label": "ActionsClient",
"description": [], "description": [],
"signature": [ "signature": [
"{ get: ({ id }: { id: string; }) => Promise<", "{ create: ({ action: { actionTypeId, name, config, secrets }, }: ",
{
"pluginId": "actions",
"scope": "server",
"docId": "kibActionsPluginApi",
"section": "def-server.ActionResult",
"text": "ActionResult"
},
"<",
"ActionTypeConfig",
">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: ({ action: { actionTypeId, name, config, secrets }, }: ",
"CreateOptions", "CreateOptions",
") => Promise<", ") => Promise<",
{ {
@ -1939,17 +1929,17 @@
}, },
"<", "<",
"ActionTypeConfig", "ActionTypeConfig",
">>; execute: ({ actionId, params, source, relatedSavedObjects, }: Omit<", ">>; get: ({ id }: { id: string; }) => Promise<",
"ExecuteOptions",
"<unknown>, \"request\" | \"actionExecutionId\">) => Promise<",
{ {
"pluginId": "actions", "pluginId": "actions",
"scope": "common", "scope": "server",
"docId": "kibActionsPluginApi", "docId": "kibActionsPluginApi",
"section": "def-common.ActionTypeExecutorResult", "section": "def-server.ActionResult",
"text": "ActionTypeExecutorResult" "text": "ActionResult"
}, },
"<unknown>>; getAll: () => Promise<", "<",
"ActionTypeConfig",
">>; getAll: () => Promise<",
{ {
"pluginId": "actions", "pluginId": "actions",
"scope": "server", "scope": "server",
@ -1967,9 +1957,19 @@
}, },
"<", "<",
"ActionTypeConfig", "ActionTypeConfig",
">[]>; getOAuthAccessToken: ({ type, options }: Readonly<{} & { options: Readonly<{} & { config: Readonly<{} & { clientId: string; jwtKeyId: string; userIdentifierValue: string; }>; tokenUrl: string; secrets: Readonly<{ privateKeyPassword?: string | undefined; } & { clientSecret: string; privateKey: string; }>; }> | Readonly<{} & { scope: string; config: Readonly<{} & { clientId: string; tenantId: string; }>; tokenUrl: string; secrets: Readonly<{} & { clientSecret: string; }>; }>; type: \"jwt\" | \"client\"; }>, configurationUtilities: ", ">[]>; getOAuthAccessToken: ({ type, options }: Readonly<{} & { type: \"jwt\" | \"client\"; options: Readonly<{} & { tokenUrl: string; config: Readonly<{} & { clientId: string; jwtKeyId: string; userIdentifierValue: string; }>; secrets: Readonly<{ privateKeyPassword?: string | undefined; } & { clientSecret: string; privateKey: string; }>; }> | Readonly<{} & { tokenUrl: string; config: Readonly<{} & { clientId: string; tenantId: string; }>; secrets: Readonly<{} & { clientSecret: string; }>; scope: string; }>; }>, configurationUtilities: ",
"ActionsConfigurationUtilities", "ActionsConfigurationUtilities",
") => Promise<{ accessToken: string | null; }>; enqueueExecution: (options: ", ") => Promise<{ accessToken: string | null; }>; delete: ({ id }: { id: string; }) => Promise<{}>; execute: ({ actionId, params, source, relatedSavedObjects, }: Omit<",
"ExecuteOptions",
"<unknown>, \"request\" | \"actionExecutionId\">) => Promise<",
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.ActionTypeExecutorResult",
"text": "ActionTypeExecutorResult"
},
"<unknown>>; enqueueExecution: (options: ",
"ExecuteOptions", "ExecuteOptions",
") => Promise<void>; bulkEnqueueExecution: (options: ", ") => Promise<void>; bulkEnqueueExecution: (options: ",
"ExecuteOptions", "ExecuteOptions",
@ -3218,7 +3218,7 @@
"label": "status", "label": "status",
"description": [], "description": [],
"signature": [ "signature": [
"\"error\" | \"ok\"" "\"ok\" | \"error\""
], ],
"path": "x-pack/plugins/actions/common/types.ts", "path": "x-pack/plugins/actions/common/types.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/actions
title: "actions" title: "actions"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the actions plugin description: API docs for the actions plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
--- ---
import actionsObj from './actions.devdocs.json'; import actionsObj from './actions.devdocs.json';
Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for questions regarding this plugin. Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/advancedSettings
title: "advancedSettings" title: "advancedSettings"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the advancedSettings plugin description: API docs for the advancedSettings plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
--- ---
import advancedSettingsObj from './advanced_settings.devdocs.json'; import advancedSettingsObj from './advanced_settings.devdocs.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin. Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/aiops
title: "aiops" title: "aiops"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the aiops plugin description: API docs for the aiops plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
--- ---
import aiopsObj from './aiops.devdocs.json'; import aiopsObj from './aiops.devdocs.json';
AIOps plugin maintained by ML team. AIOps plugin maintained by ML team.
Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for questions regarding this plugin. Contact [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -50,15 +50,7 @@
"The rule to view" "The rule to view"
], ],
"signature": [ "signature": [
"{ name: string; params: never; tags: string[]; id: string; monitoring?: ", "{ id: string; params: never; consumer: string; name: string; actions: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoring",
"text": "RuleMonitoring"
},
" | undefined; enabled: boolean; actions: ",
{ {
"pluginId": "alerting", "pluginId": "alerting",
"scope": "common", "scope": "common",
@ -66,7 +58,7 @@
"section": "def-common.RuleAction", "section": "def-common.RuleAction",
"text": "RuleAction" "text": "RuleAction"
}, },
"[]; throttle?: string | null | undefined; consumer: string; alertTypeId: string; schedule: ", "[]; tags: string[]; enabled: boolean; alertTypeId: string; schedule: ",
{ {
"pluginId": "alerting", "pluginId": "alerting",
"scope": "common", "scope": "common",
@ -82,7 +74,7 @@
"section": "def-common.MappedParams", "section": "def-common.MappedParams",
"text": "MappedParams" "text": "MappedParams"
}, },
" | undefined; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; muteAll: boolean; notifyWhen?: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined; mutedInstanceIds: string[]; executionStatus: ", " | undefined; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle?: string | null | undefined; muteAll: boolean; notifyWhen?: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined; mutedInstanceIds: string[]; executionStatus: ",
{ {
"pluginId": "alerting", "pluginId": "alerting",
"scope": "common", "scope": "common",
@ -90,7 +82,15 @@
"section": "def-common.RuleExecutionStatus", "section": "def-common.RuleExecutionStatus",
"text": "RuleExecutionStatus" "text": "RuleExecutionStatus"
}, },
"; snoozeSchedule?: ", "; monitoring?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoring",
"text": "RuleMonitoring"
},
" | undefined; snoozeSchedule?: ",
{ {
"pluginId": "alerting", "pluginId": "alerting",
"scope": "common", "scope": "common",
@ -1994,7 +1994,7 @@
"section": "def-common.SanitizedRule", "section": "def-common.SanitizedRule",
"text": "SanitizedRule" "text": "SanitizedRule"
}, },
"<never>, \"name\" | \"tags\" | \"id\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"muteAll\" | \"notifyWhen\" | \"snoozeSchedule\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" "<never>, \"id\" | \"consumer\" | \"name\" | \"actions\" | \"tags\" | \"enabled\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"muteAll\" | \"notifyWhen\" | \"snoozeSchedule\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
], ],
"path": "x-pack/plugins/alerting/server/types.ts", "path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false, "deprecated": false,
@ -2208,7 +2208,7 @@
"signature": [ "signature": [
"Pick<", "Pick<",
"AlertFactory", "AlertFactory",
"<State, Context, ActionGroupIds>, \"done\" | \"create\"> & { alertLimit: Pick<{ getValue: () => number; setLimitReached: (reached: boolean) => void; checkLimitUsage: () => void; }, \"getValue\" | \"setLimitReached\">; }" "<State, Context, ActionGroupIds>, \"create\" | \"done\"> & { alertLimit: Pick<{ getValue: () => number; setLimitReached: (reached: boolean) => void; checkLimitUsage: () => void; }, \"getValue\" | \"setLimitReached\">; }"
], ],
"path": "x-pack/plugins/alerting/server/types.ts", "path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false, "deprecated": false,
@ -2289,15 +2289,7 @@
"label": "dataViews", "label": "dataViews",
"description": [], "description": [],
"signature": [ "signature": [
"{ get: (id: string, displayErrors?: boolean, refreshFields?: boolean) => Promise<", "{ create: (spec: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
">; delete: (indexPatternId: string) => Promise<{}>; create: (spec: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -2313,7 +2305,15 @@
"section": "def-common.DataView", "section": "def-common.DataView",
"text": "DataView" "text": "DataView"
}, },
">; find: (search: string, size?: number) => Promise<", ">; get: (id: string, displayErrors?: boolean, refreshFields?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -3077,7 +3077,7 @@
"label": "AlertingRulesConfig", "label": "AlertingRulesConfig",
"description": [], "description": [],
"signature": [ "signature": [
"Pick<Readonly<{} & { run: Readonly<{ timeout?: string | undefined; ruleTypeOverrides?: Readonly<{ timeout?: string | undefined; } & { id: string; }>[] | undefined; } & { actions: Readonly<{ connectorTypeOverrides?: Readonly<{ max?: number | undefined; } & { id: string; }>[] | undefined; } & { max: number; }>; alerts: Readonly<{} & { max: number; }>; }>; minimumScheduleInterval: Readonly<{} & { value: string; enforce: boolean; }>; }>, \"minimumScheduleInterval\"> & { isUsingSecurity: boolean; }" "Pick<Readonly<{} & { minimumScheduleInterval: Readonly<{} & { value: string; enforce: boolean; }>; run: Readonly<{ timeout?: string | undefined; ruleTypeOverrides?: Readonly<{ timeout?: string | undefined; } & { id: string; }>[] | undefined; } & { actions: Readonly<{ connectorTypeOverrides?: Readonly<{ max?: number | undefined; } & { id: string; }>[] | undefined; } & { max: number; }>; alerts: Readonly<{} & { max: number; }>; }>; }>, \"minimumScheduleInterval\"> & { isUsingSecurity: boolean; }"
], ],
"path": "x-pack/plugins/alerting/server/config.ts", "path": "x-pack/plugins/alerting/server/config.ts",
"deprecated": false, "deprecated": false,
@ -3122,7 +3122,7 @@
"label": "BulkEditOperation", "label": "BulkEditOperation",
"description": [], "description": [],
"signature": [ "signature": [
"{ operation: \"delete\" | \"set\" | \"add\"; field: \"tags\"; value: string[]; } | { operation: \"set\" | \"add\"; field: \"actions\"; value: ", "{ operation: \"delete\" | \"add\" | \"set\"; field: \"tags\"; value: string[]; } | { operation: \"add\" | \"set\"; field: \"actions\"; value: ",
"NormalizedAlertAction", "NormalizedAlertAction",
"[]; } | { operation: \"set\"; field: \"schedule\"; value: ", "[]; } | { operation: \"set\"; field: \"schedule\"; value: ",
{ {
@ -3320,31 +3320,7 @@
"label": "RulesClient", "label": "RulesClient",
"description": [], "description": [],
"signature": [ "signature": [
"{ get: <Params extends ", "{ create: <Params extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>(params: ",
"GetParams",
") => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params> | ",
"SanitizedRuleWithLegacyId",
"<Params>>; delete: (params: { id: string; }) => Promise<{}>; aggregate: (params?: { options?: ",
"AggregateOptions",
" | undefined; } | undefined) => Promise<",
"AggregateResult",
">; create: <Params extends ",
{ {
"pluginId": "alerting", "pluginId": "alerting",
"scope": "common", "scope": "common",
@ -3362,24 +3338,6 @@
"section": "def-common.SanitizedRule", "section": "def-common.SanitizedRule",
"text": "SanitizedRule" "text": "SanitizedRule"
}, },
"<Params>>; find: <Params extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>(params?: ",
"FindParams",
" | undefined) => Promise<",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.FindResult",
"text": "FindResult"
},
"<Params>>; update: <Params extends ", "<Params>>; update: <Params extends ",
{ {
"pluginId": "alerting", "pluginId": "alerting",
@ -3398,6 +3356,76 @@
"section": "def-server.PartialRule", "section": "def-server.PartialRule",
"text": "PartialRule" "text": "PartialRule"
}, },
"<Params>>; get: <Params extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>(params: ",
"GetParams",
") => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params> | ",
"SanitizedRuleWithLegacyId",
"<Params>>; delete: (params: { id: string; }) => Promise<{}>; getGlobalExecutionLogWithAuth: (params: ",
"GetGlobalExecutionLogParams",
") => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.IExecutionLogResult",
"text": "IExecutionLogResult"
},
">; getGlobalExecutionKpiWithAuth: (params: ",
"GetGlobalExecutionKPIParams",
") => Promise<{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }>; find: <Params extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>(params?: ",
"FindParams",
" | undefined) => Promise<",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.FindResult",
"text": "FindResult"
},
"<Params>>; muteAll: (options: { id: string; }) => Promise<void>; aggregate: (params?: { options?: ",
"AggregateOptions",
" | undefined; } | undefined) => Promise<",
"AggregateResult",
">; clone: <Params extends ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>(args_0: string, args_1: { newId?: string | undefined; }) => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>>; resolve: <Params extends ", "<Params>>; resolve: <Params extends ",
{ {
"pluginId": "alerting", "pluginId": "alerting",
@ -3416,35 +3444,7 @@
"section": "def-common.ResolvedSanitizedRule", "section": "def-common.ResolvedSanitizedRule",
"text": "ResolvedSanitizedRule" "text": "ResolvedSanitizedRule"
}, },
"<Params>>; enable: (options: { id: string; }) => Promise<void>; disable: (options: { id: string; }) => Promise<void>; clone: <Params extends ", "<Params>>; getAlertState: (params: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleTypeParams",
"text": "RuleTypeParams"
},
" = never>(args_0: string, args_1: { newId?: string | undefined; }) => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<Params>>; getGlobalExecutionLogWithAuth: (params: ",
"GetGlobalExecutionLogParams",
") => Promise<",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.IExecutionLogResult",
"text": "IExecutionLogResult"
},
">; getGlobalExecutionKpiWithAuth: (params: ",
"GetGlobalExecutionKPIParams",
") => Promise<{ success: number; unknown: number; failure: number; warning: number; activeAlerts: number; newAlerts: number; recoveredAlerts: number; erroredActions: number; triggeredActions: number; }>; muteAll: (options: { id: string; }) => Promise<void>; getAlertState: (params: ",
"GetAlertStateParams", "GetAlertStateParams",
") => Promise<void | { alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; } & { actions?: { [x: string]: { date: Date; }; } | undefined; }) | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; pendingRecoveredCount?: number | undefined; } | undefined; }; } | undefined; alertRecoveredInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; } & { actions?: { [x: string]: { date: Date; }; } | undefined; }) | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; pendingRecoveredCount?: number | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; summaryActions?: { [x: string]: { date: Date; }; } | undefined; }>; getAlertSummary: (params: ", ") => Promise<void | { alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; } & { actions?: { [x: string]: { date: Date; }; } | undefined; }) | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; pendingRecoveredCount?: number | undefined; } | undefined; }; } | undefined; alertRecoveredInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; } & { actions?: { [x: string]: { date: Date; }; } | undefined; }) | undefined; flappingHistory?: boolean[] | undefined; flapping?: boolean | undefined; pendingRecoveredCount?: number | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; summaryActions?: { [x: string]: { date: Date; }; } | undefined; }>; getAlertSummary: (params: ",
"GetAlertSummaryParams", "GetAlertSummaryParams",
@ -3588,7 +3588,7 @@
}, },
"<never> | ", "<never> | ",
"RuleWithLegacyId", "RuleWithLegacyId",
"<never>)[]; total: number; }>; updateApiKey: (options: { id: string; }) => Promise<void>; snooze: (options: ", "<never>)[]; total: number; }>; updateApiKey: (options: { id: string; }) => Promise<void>; enable: (options: { id: string; }) => Promise<void>; disable: (options: { id: string; }) => Promise<void>; snooze: (options: ",
"SnoozeParams", "SnoozeParams",
") => Promise<void>; unsnooze: (options: ", ") => Promise<void>; unsnooze: (options: ",
"UnsnoozeParams", "UnsnoozeParams",
@ -5125,7 +5125,7 @@
"label": "freq", "label": "freq",
"description": [], "description": [],
"signature": [ "signature": [
"0 | 2 | 1 | 3 | 4 | 5 | 6 | undefined" "0 | 2 | 6 | 5 | 4 | 3 | 1 | undefined"
], ],
"path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts",
"deprecated": false, "deprecated": false,
@ -5974,7 +5974,7 @@
"label": "status", "label": "status",
"description": [], "description": [],
"signature": [ "signature": [
"\"error\" | \"warning\" | \"unknown\" | \"pending\" | \"ok\" | \"active\"" "\"ok\" | \"error\" | \"active\" | \"pending\" | \"unknown\" | \"warning\""
], ],
"path": "x-pack/plugins/alerting/common/rule.ts", "path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false, "deprecated": false,
@ -7680,7 +7680,7 @@
"label": "RuleAlertingOutcome", "label": "RuleAlertingOutcome",
"description": [], "description": [],
"signature": [ "signature": [
"\"warning\" | \"success\" | \"unknown\" | \"failure\"" "\"unknown\" | \"warning\" | \"failure\" | \"success\""
], ],
"path": "x-pack/plugins/alerting/common/rule.ts", "path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false, "deprecated": false,
@ -7695,7 +7695,7 @@
"label": "RuleExecutionStatuses", "label": "RuleExecutionStatuses",
"description": [], "description": [],
"signature": [ "signature": [
"\"error\" | \"warning\" | \"unknown\" | \"pending\" | \"ok\" | \"active\"" "\"ok\" | \"error\" | \"active\" | \"pending\" | \"unknown\" | \"warning\""
], ],
"path": "x-pack/plugins/alerting/common/rule.ts", "path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false, "deprecated": false,
@ -7933,15 +7933,7 @@
"label": "SanitizedRule", "label": "SanitizedRule",
"description": [], "description": [],
"signature": [ "signature": [
"{ name: string; params: Params; tags: string[]; id: string; monitoring?: ", "{ id: string; params: Params; consumer: string; name: string; actions: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoring",
"text": "RuleMonitoring"
},
" | undefined; enabled: boolean; actions: ",
{ {
"pluginId": "alerting", "pluginId": "alerting",
"scope": "common", "scope": "common",
@ -7949,7 +7941,7 @@
"section": "def-common.RuleAction", "section": "def-common.RuleAction",
"text": "RuleAction" "text": "RuleAction"
}, },
"[]; throttle?: string | null | undefined; consumer: string; alertTypeId: string; schedule: ", "[]; tags: string[]; enabled: boolean; alertTypeId: string; schedule: ",
{ {
"pluginId": "alerting", "pluginId": "alerting",
"scope": "common", "scope": "common",
@ -7965,7 +7957,7 @@
"section": "def-common.MappedParams", "section": "def-common.MappedParams",
"text": "MappedParams" "text": "MappedParams"
}, },
" | undefined; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; muteAll: boolean; notifyWhen?: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined; mutedInstanceIds: string[]; executionStatus: ", " | undefined; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle?: string | null | undefined; muteAll: boolean; notifyWhen?: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null | undefined; mutedInstanceIds: string[]; executionStatus: ",
{ {
"pluginId": "alerting", "pluginId": "alerting",
"scope": "common", "scope": "common",
@ -7973,7 +7965,15 @@
"section": "def-common.RuleExecutionStatus", "section": "def-common.RuleExecutionStatus",
"text": "RuleExecutionStatus" "text": "RuleExecutionStatus"
}, },
"; snoozeSchedule?: ", "; monitoring?: ",
{
"pluginId": "alerting",
"scope": "common",
"docId": "kibAlertingPluginApi",
"section": "def-common.RuleMonitoring",
"text": "RuleMonitoring"
},
" | undefined; snoozeSchedule?: ",
{ {
"pluginId": "alerting", "pluginId": "alerting",
"scope": "common", "scope": "common",
@ -8012,7 +8012,7 @@
"section": "def-common.SanitizedRule", "section": "def-common.SanitizedRule",
"text": "SanitizedRule" "text": "SanitizedRule"
}, },
"<never>, \"name\" | \"tags\" | \"id\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"muteAll\" | \"notifyWhen\" | \"snoozeSchedule\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }" "<never>, \"id\" | \"consumer\" | \"name\" | \"actions\" | \"tags\" | \"enabled\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"throttle\" | \"muteAll\" | \"notifyWhen\" | \"snoozeSchedule\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
], ],
"path": "x-pack/plugins/alerting/common/rule.ts", "path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/alerting
title: "alerting" title: "alerting"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the alerting plugin description: API docs for the alerting plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
--- ---
import alertingObj from './alerting.devdocs.json'; import alertingObj from './alerting.devdocs.json';
Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for questions regarding this plugin. Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) for questions regarding this plugin.
**Code health stats** **Code health stats**

File diff suppressed because it is too large Load diff

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/apm
title: "apm" title: "apm"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the apm plugin description: API docs for the apm plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
--- ---
import apmObj from './apm.devdocs.json'; import apmObj from './apm.devdocs.json';
The user interface for Elastic APM The user interface for Elastic APM
Contact [APM UI](https://github.com/orgs/elastic/teams/apm-ui) for questions regarding this plugin. Contact [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

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

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/banners
title: "banners" title: "banners"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the banners plugin description: API docs for the banners plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
--- ---
import bannersObj from './banners.devdocs.json'; import bannersObj from './banners.devdocs.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin. Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -464,7 +464,7 @@
"section": "def-common.StreamingResponseHandler", "section": "def-common.StreamingResponseHandler",
"text": "StreamingResponseHandler" "text": "StreamingResponseHandler"
}, },
"<Payload, Response>, method?: \"GET\" | \"POST\" | \"PUT\" | \"DELETE\" | undefined, pluginRouter?: ", "<Payload, Response>, method?: \"GET\" | \"DELETE\" | \"POST\" | \"PUT\" | undefined, pluginRouter?: ",
{ {
"pluginId": "@kbn/core-http-server", "pluginId": "@kbn/core-http-server",
"scope": "common", "scope": "common",
@ -488,7 +488,7 @@
"section": "def-common.RouteConfigOptions", "section": "def-common.RouteConfigOptions",
"text": "RouteConfigOptions" "text": "RouteConfigOptions"
}, },
"<\"get\" | \"post\" | \"put\" | \"delete\"> | undefined) => void" "<\"get\" | \"delete\" | \"post\" | \"put\"> | undefined) => void"
], ],
"path": "src/plugins/bfetch/server/plugin.ts", "path": "src/plugins/bfetch/server/plugin.ts",
"deprecated": false, "deprecated": false,
@ -556,7 +556,7 @@
"label": "method", "label": "method",
"description": [], "description": [],
"signature": [ "signature": [
"\"GET\" | \"POST\" | \"PUT\" | \"DELETE\" | undefined" "\"GET\" | \"DELETE\" | \"POST\" | \"PUT\" | undefined"
], ],
"path": "src/plugins/bfetch/server/plugin.ts", "path": "src/plugins/bfetch/server/plugin.ts",
"deprecated": false, "deprecated": false,
@ -608,7 +608,7 @@
"section": "def-common.RouteConfigOptions", "section": "def-common.RouteConfigOptions",
"text": "RouteConfigOptions" "text": "RouteConfigOptions"
}, },
"<\"get\" | \"post\" | \"put\" | \"delete\"> | undefined" "<\"get\" | \"delete\" | \"post\" | \"put\"> | undefined"
], ],
"path": "src/plugins/bfetch/server/plugin.ts", "path": "src/plugins/bfetch/server/plugin.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/bfetch
title: "bfetch" title: "bfetch"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the bfetch plugin description: API docs for the bfetch plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
--- ---
import bfetchObj from './bfetch.devdocs.json'; import bfetchObj from './bfetch.devdocs.json';
Considering using bfetch capabilities when fetching large amounts of data. This services supports batching HTTP requests and streaming responses back. Considering using bfetch capabilities when fetching large amounts of data. This services supports batching HTTP requests and streaming responses back.
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin. Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/canvas
title: "canvas" title: "canvas"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the canvas plugin description: API docs for the canvas plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
--- ---
import canvasObj from './canvas.devdocs.json'; import canvasObj from './canvas.devdocs.json';
Adds Canvas application to Kibana Adds Canvas application to Kibana
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin. Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -565,7 +565,7 @@
"signature": [ "signature": [
"{ features?: Partial<", "{ features?: Partial<",
"CasesContextFeatures", "CasesContextFeatures",
"> | undefined; onClose?: (() => void) | undefined; basePath?: string | undefined; owner: string[]; permissions: ", "> | undefined; owner: string[]; permissions: ",
{ {
"pluginId": "cases", "pluginId": "cases",
"scope": "common", "scope": "common",
@ -573,7 +573,7 @@
"section": "def-common.CasesPermissions", "section": "def-common.CasesPermissions",
"text": "CasesPermissions" "text": "CasesPermissions"
}, },
"; releasePhase?: ", "; basePath?: string | undefined; releasePhase?: ",
"ReleasePhase", "ReleasePhase",
" | undefined; hiddenStatuses?: ", " | undefined; hiddenStatuses?: ",
"CaseStatusWithAllStatus", "CaseStatusWithAllStatus",
@ -585,7 +585,7 @@
"section": "def-common.Case", "section": "def-common.Case",
"text": "Case" "text": "Case"
}, },
" | undefined) => void) | undefined; }" " | undefined) => void) | undefined; onClose?: (() => void) | undefined; }"
], ],
"path": "x-pack/plugins/cases/public/client/ui/get_all_cases_selector_modal.tsx", "path": "x-pack/plugins/cases/public/client/ui/get_all_cases_selector_modal.tsx",
"deprecated": false, "deprecated": false,
@ -602,7 +602,7 @@
"signature": [ "signature": [
"{ features?: Partial<", "{ features?: Partial<",
"CasesContextFeatures", "CasesContextFeatures",
"> | undefined; basePath?: string | undefined; owner: string[]; permissions: ", "> | undefined; owner: string[]; permissions: ",
{ {
"pluginId": "cases", "pluginId": "cases",
"scope": "common", "scope": "common",
@ -626,7 +626,7 @@
}, },
"> | undefined; timelineIntegration?: ", "> | undefined; timelineIntegration?: ",
"CasesTimelineIntegration", "CasesTimelineIntegration",
" | undefined; releasePhase?: ", " | undefined; basePath?: string | undefined; releasePhase?: ",
"ReleasePhase", "ReleasePhase",
" | undefined; }" " | undefined; }"
], ],
@ -645,7 +645,7 @@
"signature": [ "signature": [
"{ features?: Partial<", "{ features?: Partial<",
"CasesContextFeatures", "CasesContextFeatures",
"> | undefined; onClose?: (() => void) | undefined; basePath?: string | undefined; owner: string[]; permissions: ", "> | undefined; owner: string[]; permissions: ",
{ {
"pluginId": "cases", "pluginId": "cases",
"scope": "common", "scope": "common",
@ -653,9 +653,9 @@
"section": "def-common.CasesPermissions", "section": "def-common.CasesPermissions",
"text": "CasesPermissions" "text": "CasesPermissions"
}, },
"; releasePhase?: ", "; basePath?: string | undefined; releasePhase?: ",
"ReleasePhase", "ReleasePhase",
" | undefined; afterCaseCreated?: ((theCase: ", " | undefined; onClose?: (() => void) | undefined; afterCaseCreated?: ((theCase: ",
{ {
"pluginId": "cases", "pluginId": "cases",
"scope": "common", "scope": "common",
@ -714,7 +714,7 @@
"signature": [ "signature": [
"{ features?: Partial<", "{ features?: Partial<",
"CasesContextFeatures", "CasesContextFeatures",
"> | undefined; basePath?: string | undefined; owner: string[]; permissions: ", "> | undefined; owner: string[]; permissions: ",
{ {
"pluginId": "cases", "pluginId": "cases",
"scope": "common", "scope": "common",
@ -722,7 +722,7 @@
"section": "def-common.CasesPermissions", "section": "def-common.CasesPermissions",
"text": "CasesPermissions" "text": "CasesPermissions"
}, },
"; releasePhase?: ", "; basePath?: string | undefined; releasePhase?: ",
"ReleasePhase", "ReleasePhase",
" | undefined; maxCasesToShow: number; }" " | undefined; maxCasesToShow: number; }"
], ],

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/cases
title: "cases" title: "cases"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cases plugin description: API docs for the cases plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
--- ---
import casesObj from './cases.devdocs.json'; import casesObj from './cases.devdocs.json';
The Case management system in Kibana The Case management system in Kibana
Contact [ResponseOps](https://github.com/orgs/elastic/teams/response-ops) for questions regarding this plugin. Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/charts
title: "charts" title: "charts"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the charts plugin description: API docs for the charts plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
--- ---
import chartsObj from './charts.devdocs.json'; import chartsObj from './charts.devdocs.json';
Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/cloud
title: "cloud" title: "cloud"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloud plugin description: API docs for the cloud plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
--- ---
import cloudObj from './cloud.devdocs.json'; import cloudObj from './cloud.devdocs.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin. Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/cloudChat
title: "cloudChat" title: "cloudChat"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudChat plugin description: API docs for the cloudChat plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat']
--- ---
import cloudChatObj from './cloud_chat.devdocs.json'; import cloudChatObj from './cloud_chat.devdocs.json';
Chat available on Elastic Cloud deployments for quicker assistance. Chat available on Elastic Cloud deployments for quicker assistance.
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin. Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/cloudDataMigration
title: "cloudDataMigration" title: "cloudDataMigration"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDataMigration plugin description: API docs for the cloudDataMigration plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
--- ---
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json'; import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';
Static migration page where self-managed users can see text/copy about migrating to Elastic Cloud Static migration page where self-managed users can see text/copy about migrating to Elastic Cloud
Contact [Platform Onboarding](https://github.com/orgs/elastic/teams/platform-onboarding) for questions regarding this plugin. Contact [@elastic/platform-onboarding](https://github.com/orgs/elastic/teams/platform-onboarding) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/cloudDefend
title: "cloudDefend" title: "cloudDefend"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDefend plugin description: API docs for the cloudDefend plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
--- ---
import cloudDefendObj from './cloud_defend.devdocs.json'; import cloudDefendObj from './cloud_defend.devdocs.json';
Defend for Containers Defend for Containers
Contact [Cloud Native Integrations](https://github.com/orgs/elastic/teams/sec-cloudnative-integrations) for questions regarding this plugin. Contact [@elastic/sec-cloudnative-integrations](https://github.com/orgs/elastic/teams/sec-cloudnative-integrations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/cloudExperiments
title: "cloudExperiments" title: "cloudExperiments"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudExperiments plugin description: API docs for the cloudExperiments plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments']
--- ---
import cloudExperimentsObj from './cloud_experiments.devdocs.json'; import cloudExperimentsObj from './cloud_experiments.devdocs.json';
Provides the necessary APIs to implement A/B testing scenarios, fetching the variations in configuration and reporting back metrics to track conversion rates of the experiments. Provides the necessary APIs to implement A/B testing scenarios, fetching the variations in configuration and reporting back metrics to track conversion rates of the experiments.
Contact [Kibana Core](https://github.com/orgs/elastic/teams/@elastic/kibana-core) for questions regarding this plugin. Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture
title: "cloudSecurityPosture" title: "cloudSecurityPosture"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudSecurityPosture plugin description: API docs for the cloudSecurityPosture plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
--- ---
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json'; import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';
The cloud security posture plugin The cloud security posture plugin
Contact [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-posture-security) for questions regarding this plugin. Contact [@elastic/kibana-cloud-security-posture](https://github.com/orgs/elastic/teams/kibana-cloud-security-posture) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/console
title: "console" title: "console"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the console plugin description: API docs for the console plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
--- ---
import consoleObj from './console.devdocs.json'; import consoleObj from './console.devdocs.json';
Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) for questions regarding this plugin. Contact [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -302,7 +302,7 @@
"label": "ProcedureName", "label": "ProcedureName",
"description": [], "description": [],
"signature": [ "signature": [
"\"get\" | \"create\"" "\"create\" | \"get\""
], ],
"path": "src/plugins/content_management/common/rpc.ts", "path": "src/plugins/content_management/common/rpc.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/contentManagement
title: "contentManagement" title: "contentManagement"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the contentManagement plugin description: API docs for the contentManagement plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
--- ---
import contentManagementObj from './content_management.devdocs.json'; import contentManagementObj from './content_management.devdocs.json';
Content management app Content management app
Contact [@elastic/kibana-global-experience](https://github.com/orgs/elastic/teams/@elastic/kibana-global-experience) for questions regarding this plugin. Contact [@elastic/kibana-global-experience](https://github.com/orgs/elastic/teams/kibana-global-experience) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/controls
title: "controls" title: "controls"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the controls plugin description: API docs for the controls plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
--- ---
import controlsObj from './controls.devdocs.json'; import controlsObj from './controls.devdocs.json';
The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin. Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats** **Code health stats**

File diff suppressed because one or more lines are too long

View file

@ -1,62 +0,0 @@
---
####
#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
#### Reach out in #docs-engineering for more info.
####
id: kibCorePluginApi
slug: /kibana-dev-docs/api/core
title: "core"
image: https://source.unsplash.com/400x175/?github
description: API docs for the core plugin
date: 2023-02-08
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core']
---
import coreObj from './core.devdocs.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2848 | 17 | 1030 | 0 |
## Client
### Objects
<DocDefinitionList data={coreObj.client.objects}/>
### Classes
<DocDefinitionList data={coreObj.client.classes}/>
### Interfaces
<DocDefinitionList data={coreObj.client.interfaces}/>
### Enums
<DocDefinitionList data={coreObj.client.enums}/>
### Consts, variables and types
<DocDefinitionList data={coreObj.client.misc}/>
## Server
### Objects
<DocDefinitionList data={coreObj.server.objects}/>
### Functions
<DocDefinitionList data={coreObj.server.functions}/>
### Classes
<DocDefinitionList data={coreObj.server.classes}/>
### Interfaces
<DocDefinitionList data={coreObj.server.interfaces}/>
### Enums
<DocDefinitionList data={coreObj.server.enums}/>
### Consts, variables and types
<DocDefinitionList data={coreObj.server.misc}/>

View file

@ -438,7 +438,7 @@
"label": "categories", "label": "categories",
"description": [], "description": [],
"signature": [ "signature": [
"(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"infrastructure\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" "(\"monitoring\" | \"security\" | \"infrastructure\" | \"cloud\" | \"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]"
], ],
"path": "src/plugins/custom_integrations/common/index.ts", "path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false, "deprecated": false,
@ -452,7 +452,7 @@
"label": "shipper", "label": "shipper",
"description": [], "description": [],
"signature": [ "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", "path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false, "deprecated": false,
@ -488,7 +488,7 @@
"\nA category applicable to an Integration." "\nA category applicable to an Integration."
], ],
"signature": [ "signature": [
"\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"infrastructure\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" "\"monitoring\" | \"security\" | \"infrastructure\" | \"cloud\" | \"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\""
], ],
"path": "src/plugins/custom_integrations/common/index.ts", "path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false, "deprecated": false,
@ -728,7 +728,7 @@
"label": "categories", "label": "categories",
"description": [], "description": [],
"signature": [ "signature": [
"(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"infrastructure\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" "(\"monitoring\" | \"security\" | \"infrastructure\" | \"cloud\" | \"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]"
], ],
"path": "src/plugins/custom_integrations/common/index.ts", "path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false, "deprecated": false,
@ -742,7 +742,7 @@
"label": "shipper", "label": "shipper",
"description": [], "description": [],
"signature": [ "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", "path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false, "deprecated": false,
@ -797,7 +797,7 @@
"label": "type", "label": "type",
"description": [], "description": [],
"signature": [ "signature": [
"\"eui\" | \"svg\"" "\"svg\" | \"eui\""
], ],
"path": "src/plugins/custom_integrations/common/index.ts", "path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false, "deprecated": false,
@ -838,7 +838,7 @@
"label": "id", "label": "id",
"description": [], "description": [],
"signature": [ "signature": [
"\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"infrastructure\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" "\"monitoring\" | \"security\" | \"infrastructure\" | \"cloud\" | \"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\""
], ],
"path": "src/plugins/custom_integrations/common/index.ts", "path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false, "deprecated": false,
@ -860,7 +860,7 @@
"\nThe list of all available categories." "\nThe list of all available categories."
], ],
"signature": [ "signature": [
"(\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"infrastructure\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]" "(\"monitoring\" | \"security\" | \"infrastructure\" | \"cloud\" | \"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\")[]"
], ],
"path": "src/plugins/custom_integrations/common/index.ts", "path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false, "deprecated": false,
@ -877,7 +877,7 @@
"\nA category applicable to an Integration." "\nA category applicable to an Integration."
], ],
"signature": [ "signature": [
"\"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"infrastructure\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\"" "\"monitoring\" | \"security\" | \"infrastructure\" | \"cloud\" | \"custom\" | \"enterprise_search\" | \"sample_data\" | \"aws\" | \"azure\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"microsoft_365\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\" | \"communications\" | \"file_storage\" | \"language_client\" | \"upload_file\" | \"website_search\" | \"geo\""
], ],
"path": "src/plugins/custom_integrations/common/index.ts", "path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false, "deprecated": false,
@ -948,7 +948,7 @@
"\nThe list of all known shippers." "\nThe list of all known shippers."
], ],
"signature": [ "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", "path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false, "deprecated": false,
@ -965,7 +965,7 @@
"\nA shipper-- an internal or external system capable of storing data in ES/Kibana-- applicable to an Integration." "\nA shipper-- an internal or external system capable of storing data in ES/Kibana-- applicable to an Integration."
], ],
"signature": [ "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", "path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/customIntegrations
title: "customIntegrations" title: "customIntegrations"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the customIntegrations plugin description: API docs for the customIntegrations plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
--- ---
import customIntegrationsObj from './custom_integrations.devdocs.json'; import customIntegrationsObj from './custom_integrations.devdocs.json';
Add custom data integrations so they can be displayed in the Fleet integrations app Add custom data integrations so they can be displayed in the Fleet integrations app
Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regarding this plugin. Contact [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -3385,16 +3385,16 @@
"pluginId": "dashboard", "pluginId": "dashboard",
"scope": "common", "scope": "common",
"docId": "kibDashboardPluginApi", "docId": "kibDashboardPluginApi",
"section": "def-common.DashboardContainerByReferenceInput", "section": "def-common.DashboardContainerByValueInput",
"text": "DashboardContainerByReferenceInput" "text": "DashboardContainerByValueInput"
}, },
" | ", " | ",
{ {
"pluginId": "dashboard", "pluginId": "dashboard",
"scope": "common", "scope": "common",
"docId": "kibDashboardPluginApi", "docId": "kibDashboardPluginApi",
"section": "def-common.DashboardContainerByValueInput", "section": "def-common.DashboardContainerByReferenceInput",
"text": "DashboardContainerByValueInput" "text": "DashboardContainerByReferenceInput"
} }
], ],
"path": "src/plugins/dashboard/common/dashboard_container/types.ts", "path": "src/plugins/dashboard/common/dashboard_container/types.ts",
@ -3451,7 +3451,7 @@
"\nFor BWC reasons, dashboard state is stored with panels as an array instead of a map" "\nFor BWC reasons, dashboard state is stored with panels as an array instead of a map"
], ],
"signature": [ "signature": [
"{ description?: string | undefined; query?: ", "{ id?: string | undefined; tags?: string[] | undefined; description?: string | undefined; title?: string | undefined; query?: ",
{ {
"pluginId": "@kbn/es-query", "pluginId": "@kbn/es-query",
"scope": "common", "scope": "common",
@ -3459,7 +3459,31 @@
"section": "def-common.Query", "section": "def-common.Query",
"text": "Query" "text": "Query"
}, },
" | undefined; tags?: string[] | undefined; id?: string | undefined; title?: string | undefined; viewMode?: ", " | undefined; refreshInterval?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" | undefined; filters?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined; executionContext?: ",
{
"pluginId": "@kbn/core-execution-context-common",
"scope": "common",
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
"section": "def-common.KibanaExecutionContext",
"text": "KibanaExecutionContext"
},
" | undefined; viewMode?: ",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "common", "scope": "common",
@ -3475,23 +3499,7 @@
"section": "def-common.SerializableRecord", "section": "def-common.SerializableRecord",
"text": "SerializableRecord" "text": "SerializableRecord"
}, },
" | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; syncCursor?: boolean | undefined; syncTooltips?: boolean | undefined; executionContext?: ", " | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; syncCursor?: boolean | undefined; syncTooltips?: boolean | undefined; timeRange?: ",
{
"pluginId": "@kbn/core-execution-context-common",
"scope": "common",
"docId": "kibKbnCoreExecutionContextCommonPluginApi",
"section": "def-common.KibanaExecutionContext",
"text": "KibanaExecutionContext"
},
" | undefined; filters?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined; timeRange?: ",
{ {
"pluginId": "@kbn/es-query", "pluginId": "@kbn/es-query",
"scope": "common", "scope": "common",
@ -3507,15 +3515,7 @@
"section": "def-common.PersistableControlGroupInput", "section": "def-common.PersistableControlGroupInput",
"text": "PersistableControlGroupInput" "text": "PersistableControlGroupInput"
}, },
" | undefined; timeRestore?: boolean | undefined; refreshInterval?: ", " | undefined; isEmbeddedExternally?: boolean | undefined; timeRestore?: boolean | undefined; useMargins?: boolean | undefined; panels?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataQueryPluginApi",
"section": "def-common.RefreshInterval",
"text": "RefreshInterval"
},
" | undefined; isEmbeddedExternally?: boolean | undefined; useMargins?: boolean | undefined; panels?: ",
{ {
"pluginId": "dashboard", "pluginId": "dashboard",
"scope": "common", "scope": "common",

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/dashboard
title: "dashboard" title: "dashboard"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboard plugin description: API docs for the dashboard plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
--- ---
import dashboardObj from './dashboard.devdocs.json'; import dashboardObj from './dashboard.devdocs.json';
Adds the Dashboard app to Kibana Adds the Dashboard app to Kibana
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin. Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/dashboardEnhanced
title: "dashboardEnhanced" title: "dashboardEnhanced"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboardEnhanced plugin description: API docs for the dashboardEnhanced plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
--- ---
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json'; import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin. Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -2690,7 +2690,7 @@
"section": "def-common.PluginInitializerContext", "section": "def-common.PluginInitializerContext",
"text": "PluginInitializerContext" "text": "PluginInitializerContext"
}, },
"<Readonly<{} & { search: Readonly<{} & { aggs: Readonly<{} & { shardDelay: Readonly<{} & { enabled: boolean; }>; }>; asyncSearch: Readonly<{ pollInterval?: number | undefined; } & { waitForCompletion: moment.Duration; keepAlive: moment.Duration; batchedReduceSize: number; }>; sessions: Readonly<{} & { enabled: boolean; notTouchedTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; }>; }>; }>>" "<Readonly<{} & { search: Readonly<{} & { aggs: Readonly<{} & { shardDelay: Readonly<{} & { enabled: boolean; }>; }>; asyncSearch: Readonly<{ pollInterval?: number | undefined; } & { waitForCompletion: moment.Duration; keepAlive: moment.Duration; batchedReduceSize: number; }>; sessions: Readonly<{} & { enabled: boolean; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; notTouchedTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; }>; }>; }>>"
], ],
"path": "src/plugins/data/public/plugin.ts", "path": "src/plugins/data/public/plugin.ts",
"deprecated": false, "deprecated": false,
@ -9139,7 +9139,7 @@
"label": "AggConfigOptions", "label": "AggConfigOptions",
"description": [], "description": [],
"signature": [ "signature": [
"{ schema?: string | undefined; type: ", "{ type: ",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
@ -9147,7 +9147,7 @@
"section": "def-common.IAggType", "section": "def-common.IAggType",
"text": "IAggType" "text": "IAggType"
}, },
"; params?: {} | ", "; id?: string | undefined; params?: {} | ",
{ {
"pluginId": "@kbn/utility-types", "pluginId": "@kbn/utility-types",
"scope": "common", "scope": "common",
@ -9155,7 +9155,7 @@
"section": "def-common.SerializableRecord", "section": "def-common.SerializableRecord",
"text": "SerializableRecord" "text": "SerializableRecord"
}, },
" | undefined; id?: string | undefined; enabled?: boolean | undefined; }" " | undefined; schema?: string | undefined; enabled?: boolean | undefined; }"
], ],
"path": "src/plugins/data/common/search/aggs/agg_config.ts", "path": "src/plugins/data/common/search/aggs/agg_config.ts",
"deprecated": false, "deprecated": false,
@ -10092,7 +10092,19 @@
"section": "def-common.SearchSource", "section": "def-common.SearchSource",
"text": "SearchSource" "text": "SearchSource"
}, },
"; history: ", "; fetch: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; history: ",
"SearchRequest", "SearchRequest",
"[]; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: <K extends keyof ", "[]; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: <K extends keyof ",
{ {
@ -10260,19 +10272,7 @@
"SearchResponse", "SearchResponse",
"<T, Record<string, ", "<T, Record<string, ",
"AggregationsAggregate", "AggregationsAggregate",
">>>>; fetch: (options?: ", ">>>>; onRequestStart: (handler: (searchSource: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; onRequestStart: (handler: (searchSource: ",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
@ -10682,7 +10682,7 @@
"path": "packages/core/saved-objects/core-saved-objects-browser-internal/src/saved_objects_client.ts" "path": "packages/core/saved-objects/core-saved-objects-browser-internal/src/saved_objects_client.ts"
}, },
{ {
"plugin": "core", "plugin": "@kbn/core",
"path": "src/core/public/index.ts" "path": "src/core/public/index.ts"
}, },
{ {
@ -11010,7 +11010,7 @@
"path": "packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/export/apply_export_transforms.ts" "path": "packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/export/apply_export_transforms.ts"
}, },
{ {
"plugin": "core", "plugin": "@kbn/core",
"path": "src/core/types/index.ts" "path": "src/core/types/index.ts"
}, },
{ {
@ -13123,7 +13123,7 @@
"section": "def-common.FieldFormatsRegistry", "section": "def-common.FieldFormatsRegistry",
"text": "FieldFormatsRegistry" "text": "FieldFormatsRegistry"
}, },
", \"init\" | \"register\"> & { deserialize: ", ", \"register\" | \"init\"> & { deserialize: ",
{ {
"pluginId": "fieldFormats", "pluginId": "fieldFormats",
"scope": "common", "scope": "common",
@ -13316,7 +13316,7 @@
"section": "def-common.PluginInitializerContext", "section": "def-common.PluginInitializerContext",
"text": "PluginInitializerContext" "text": "PluginInitializerContext"
}, },
"<Readonly<{} & { search: Readonly<{} & { aggs: Readonly<{} & { shardDelay: Readonly<{} & { enabled: boolean; }>; }>; asyncSearch: Readonly<{ pollInterval?: number | undefined; } & { waitForCompletion: moment.Duration; keepAlive: moment.Duration; batchedReduceSize: number; }>; sessions: Readonly<{} & { enabled: boolean; notTouchedTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; }>; }>; }>>" "<Readonly<{} & { search: Readonly<{} & { aggs: Readonly<{} & { shardDelay: Readonly<{} & { enabled: boolean; }>; }>; asyncSearch: Readonly<{ pollInterval?: number | undefined; } & { waitForCompletion: moment.Duration; keepAlive: moment.Duration; batchedReduceSize: number; }>; sessions: Readonly<{} & { enabled: boolean; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; notTouchedTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; }>; }>; }>>"
], ],
"path": "src/plugins/data/server/plugin.ts", "path": "src/plugins/data/server/plugin.ts",
"deprecated": false, "deprecated": false,
@ -15330,16 +15330,16 @@
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
"docId": "kibDataViewsPluginApi", "docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField", "section": "def-common.FieldSpec",
"text": "DataViewField" "text": "FieldSpec"
}, },
" | ", " | ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
"docId": "kibDataViewsPluginApi", "docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec", "section": "def-common.DataViewField",
"text": "FieldSpec" "text": "DataViewField"
}, },
") => ", ") => ",
{ {
@ -15368,16 +15368,16 @@
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
"docId": "kibDataViewsPluginApi", "docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField", "section": "def-common.FieldSpec",
"text": "DataViewField" "text": "FieldSpec"
}, },
" | ", " | ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
"docId": "kibDataViewsPluginApi", "docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec", "section": "def-common.DataViewField",
"text": "FieldSpec" "text": "DataViewField"
} }
], ],
"path": "src/plugins/data_views/common/data_views/data_view.ts", "path": "src/plugins/data_views/common/data_views/data_view.ts",
@ -18156,7 +18156,59 @@
"label": "elasticsearchClient", "label": "elasticsearchClient",
"description": [], "description": [],
"signature": [ "signature": [
"{ name: string | symbol; get: { <TDocument = unknown>(this: That, params: ", "{ create: { <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"WriteResponseBase",
">; <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"WriteResponseBase",
", unknown>>; <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"WriteResponseBase",
">; }; update: { <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"UpdateResponse",
"<TDocumentR>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"UpdateResponse",
"<TDocumentR>, unknown>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"UpdateResponse",
"<TDocumentR>>; }; get: { <TDocument = unknown>(this: That, params: ",
"GetRequest", "GetRequest",
" | ", " | ",
"GetRequest", "GetRequest",
@ -18208,9 +18260,7 @@
"TransportRequestOptions", "TransportRequestOptions",
" | undefined): Promise<", " | undefined): Promise<",
"WriteResponseBase", "WriteResponseBase",
">; }; cluster: ", ">; }; helpers: ",
"default",
"; eql: ",
"default", "default",
"; search: { <TDocument = unknown, TAggregations = Record<string, ", "; search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate", "AggregationsAggregate",
@ -18244,98 +18294,88 @@
"TransportRequestOptions", "TransportRequestOptions",
" | undefined): Promise<", " | undefined): Promise<",
"SearchResponse", "SearchResponse",
"<TDocument, TAggregations>>; }; create: { <TDocument = unknown>(this: That, params: ", "<TDocument, TAggregations>>; }; name: string | symbol; monitoring: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"WriteResponseBase",
">; <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"WriteResponseBase",
", unknown>>; <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"WriteResponseBase",
">; }; monitoring: ",
"default", "default",
"; security: ", "; count: { (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"CountResponse",
">; (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"CountResponse",
", unknown>>; (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"CountResponse",
">; }; exists: { (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<boolean>; (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<boolean, unknown>>; (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<boolean>; }; security: ",
"default", "default",
"; index: { <TDocument = unknown>(this: That, params: ", "; ping: { (this: That, params?: ",
"IndexRequest", "PingRequest",
"<TDocument> | ", " | ",
"IndexRequest", "PingRequest",
"<TDocument>, options?: ", " | undefined, options?: ",
"TransportRequestOptionsWithOutMeta", "TransportRequestOptionsWithOutMeta",
" | undefined): Promise<", " | undefined): Promise<boolean>; (this: That, params?: ",
"WriteResponseBase", "PingRequest",
">; <TDocument = unknown>(this: That, params: ", " | ",
"IndexRequest", "PingRequest",
"<TDocument> | ", " | undefined, options?: ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithMeta", "TransportRequestOptionsWithMeta",
" | undefined): Promise<", " | undefined): Promise<",
"TransportResult", "TransportResult",
"<", "<boolean, unknown>>; (this: That, params?: ",
"WriteResponseBase", "PingRequest",
", unknown>>; <TDocument = unknown>(this: That, params: ", " | ",
"IndexRequest", "PingRequest",
"<TDocument> | ", " | undefined, options?: ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptions", "TransportRequestOptions",
" | undefined): Promise<", " | undefined): Promise<boolean>; }; nodes: ",
"WriteResponseBase", "default",
">; }; update: { <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ", "; indices: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"UpdateResponse",
"<TDocumentR>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"UpdateResponse",
"<TDocumentR>, unknown>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"UpdateResponse",
"<TDocumentR>>; }; asyncSearch: ",
"default", "default",
"; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"default", "default",
"; helpers: ",
"default",
"; child: (opts: ", "; child: (opts: ",
"ClientOptions", "ClientOptions",
") => ", ") => ",
"default", "default",
"; asyncSearch: ",
"default",
"; autoscaling: ", "; autoscaling: ",
"default", "default",
"; bulk: { <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ", "; bulk: { <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
@ -18420,33 +18460,9 @@
"TransportRequestOptions", "TransportRequestOptions",
" | undefined): Promise<", " | undefined): Promise<",
"ClosePointInTimeResponse", "ClosePointInTimeResponse",
">; }; count: { (this: That, params?: ", ">; }; cluster: ",
"CountRequest", "default",
" | ", "; danglingIndices: ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"CountResponse",
">; (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"CountResponse",
", unknown>>; (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"CountResponse",
">; }; danglingIndices: ",
"default", "default",
"; deleteByQuery: { (this: That, params: ", "; deleteByQuery: { (this: That, params: ",
"DeleteByQueryRequest", "DeleteByQueryRequest",
@ -18528,27 +18544,9 @@
"AcknowledgedResponseBase", "AcknowledgedResponseBase",
">; }; enrich: ", ">; }; enrich: ",
"default", "default",
"; exists: { (this: That, params: ", "; eql: ",
"ExistsRequest", "default",
" | ", "; existsSource: { (this: That, params: ",
"ExistsRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<boolean>; (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<boolean, unknown>>; (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<boolean>; }; existsSource: { (this: That, params: ",
"ExistsSourceRequest", "ExistsSourceRequest",
" | ", " | ",
"ExistsSourceRequest", "ExistsSourceRequest",
@ -18726,9 +18724,33 @@
"default", "default",
"; ilm: ", "; ilm: ",
"default", "default",
"; indices: ", "; index: { <TDocument = unknown>(this: That, params: ",
"default", "IndexRequest",
"; info: { (this: That, params?: ", "<TDocument> | ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"WriteResponseBase",
">; <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"WriteResponseBase",
", unknown>>; <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"WriteResponseBase",
">; }; info: { (this: That, params?: ",
"InfoRequest", "InfoRequest",
" | ", " | ",
"InfoRequest", "InfoRequest",
@ -18906,9 +18928,7 @@
"TransportRequestOptions", "TransportRequestOptions",
" | undefined): Promise<", " | undefined): Promise<",
"MtermvectorsResponse", "MtermvectorsResponse",
">; }; nodes: ", ">; }; openPointInTime: { (this: That, params: ",
"default",
"; openPointInTime: { (this: That, params: ",
"OpenPointInTimeRequest", "OpenPointInTimeRequest",
" | ", " | ",
"OpenPointInTimeRequest", "OpenPointInTimeRequest",
@ -18934,27 +18954,7 @@
"TransportRequestOptions", "TransportRequestOptions",
" | undefined): Promise<", " | undefined): Promise<",
"OpenPointInTimeResponse", "OpenPointInTimeResponse",
">; }; ping: { (this: That, params?: ", ">; }; putScript: { (this: That, params: ",
"PingRequest",
" | ",
"PingRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<boolean>; (this: That, params?: ",
"PingRequest",
" | ",
"PingRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<boolean, unknown>>; (this: That, params?: ",
"PingRequest",
" | ",
"PingRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<boolean>; }; putScript: { (this: That, params: ",
"PutScriptRequest", "PutScriptRequest",
" | ", " | ",
"PutScriptRequest", "PutScriptRequest",
@ -19532,7 +19532,7 @@
"label": "timeSeriesMetric", "label": "timeSeriesMetric",
"description": [], "description": [],
"signature": [ "signature": [
"\"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined" "\"histogram\" | \"summary\" | \"gauge\" | \"counter\" | undefined"
], ],
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts", "path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false, "deprecated": false,
@ -22941,16 +22941,16 @@
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
"docId": "kibDataViewsPluginApi", "docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField", "section": "def-common.FieldSpec",
"text": "DataViewField" "text": "FieldSpec"
}, },
" | ", " | ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
"docId": "kibDataViewsPluginApi", "docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec", "section": "def-common.DataViewField",
"text": "FieldSpec" "text": "DataViewField"
}, },
") => ", ") => ",
{ {
@ -22979,16 +22979,16 @@
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
"docId": "kibDataViewsPluginApi", "docId": "kibDataViewsPluginApi",
"section": "def-common.DataViewField", "section": "def-common.FieldSpec",
"text": "DataViewField" "text": "FieldSpec"
}, },
" | ", " | ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
"docId": "kibDataViewsPluginApi", "docId": "kibDataViewsPluginApi",
"section": "def-common.FieldSpec", "section": "def-common.DataViewField",
"text": "FieldSpec" "text": "DataViewField"
} }
], ],
"path": "src/plugins/data_views/common/data_views/data_view.ts", "path": "src/plugins/data_views/common/data_views/data_view.ts",
@ -23770,7 +23770,7 @@
"section": "def-common.RuntimeFieldSpec", "section": "def-common.RuntimeFieldSpec",
"text": "RuntimeFieldSpec" "text": "RuntimeFieldSpec"
}, },
" | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; parentName?: string | undefined; }" " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"histogram\" | \"summary\" | \"gauge\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; parentName?: string | undefined; }"
], ],
"path": "src/plugins/data_views/common/fields/data_view_field.ts", "path": "src/plugins/data_views/common/fields/data_view_field.ts",
"deprecated": false, "deprecated": false,
@ -24137,7 +24137,7 @@
"\nreturns type of TSDB metric or undefined" "\nreturns type of TSDB metric or undefined"
], ],
"signature": [ "signature": [
"\"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined" "\"histogram\" | \"summary\" | \"gauge\" | \"counter\" | undefined"
], ],
"path": "src/plugins/data_views/common/fields/data_view_field.ts", "path": "src/plugins/data_views/common/fields/data_view_field.ts",
"deprecated": false, "deprecated": false,
@ -27733,15 +27733,7 @@
"\nData views service interface" "\nData views service interface"
], ],
"signature": [ "signature": [
"{ get: (id: string, displayErrors?: boolean, refreshFields?: boolean) => Promise<", "{ create: (spec: ",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
">; delete: (indexPatternId: string) => Promise<{}>; create: (spec: ",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -27757,7 +27749,15 @@
"section": "def-common.DataView", "section": "def-common.DataView",
"text": "DataView" "text": "DataView"
}, },
">; find: (search: string, size?: number) => Promise<", ">; get: (id: string, displayErrors?: boolean, refreshFields?: boolean) => Promise<",
{
"pluginId": "dataViews",
"scope": "common",
"docId": "kibDataViewsPluginApi",
"section": "def-common.DataView",
"text": "DataView"
},
">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<",
{ {
"pluginId": "dataViews", "pluginId": "dataViews",
"scope": "common", "scope": "common",
@ -28135,7 +28135,7 @@
"section": "def-common.RuntimeFieldSpec", "section": "def-common.RuntimeFieldSpec",
"text": "RuntimeFieldSpec" "text": "RuntimeFieldSpec"
}, },
" | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"gauge\" | \"histogram\" | \"summary\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; parentName?: string | undefined; }" " | undefined; fixedInterval?: string[] | undefined; timeZone?: string[] | undefined; timeSeriesDimension?: boolean | undefined; timeSeriesMetric?: \"histogram\" | \"summary\" | \"gauge\" | \"counter\" | undefined; shortDotsEnable?: boolean | undefined; isMapped?: boolean | undefined; parentName?: string | undefined; }"
], ],
"path": "src/plugins/data_views/common/types.ts", "path": "src/plugins/data_views/common/types.ts",
"deprecated": false, "deprecated": false,
@ -28511,7 +28511,7 @@
"path": "packages/core/saved-objects/core-saved-objects-browser-internal/src/saved_objects_client.ts" "path": "packages/core/saved-objects/core-saved-objects-browser-internal/src/saved_objects_client.ts"
}, },
{ {
"plugin": "core", "plugin": "@kbn/core",
"path": "src/core/public/index.ts" "path": "src/core/public/index.ts"
}, },
{ {
@ -28839,7 +28839,7 @@
"path": "packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/export/apply_export_transforms.ts" "path": "packages/core/saved-objects/core-saved-objects-import-export-server-internal/src/export/apply_export_transforms.ts"
}, },
{ {
"plugin": "core", "plugin": "@kbn/core",
"path": "src/core/types/index.ts" "path": "src/core/types/index.ts"
}, },
{ {

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/data
title: "data" title: "data"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the data plugin description: API docs for the data plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
--- ---
import dataObj from './data.devdocs.json'; import dataObj from './data.devdocs.json';
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin. Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/data-query
title: "data.query" title: "data.query"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the data.query plugin description: API docs for the data.query plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
--- ---
import dataQueryObj from './data_query.devdocs.json'; import dataQueryObj from './data_query.devdocs.json';
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin. Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -194,7 +194,7 @@
"\nCurrent session management\n{@link ISessionService}" "\nCurrent session management\n{@link ISessionService}"
], ],
"signature": [ "signature": [
"{ start: () => string; save: () => Promise<void>; destroy: () => void; readonly state$: ", "{ start: () => string; save: () => Promise<void>; clear: () => void; destroy: () => void; readonly state$: ",
"Observable", "Observable",
"<", "<",
{ {
@ -212,7 +212,7 @@
"Observable", "Observable",
"<boolean>; hasAccess: () => boolean; trackSearch: (searchDescriptor: TrackSearchDescriptor) => TrackSearchHandler; getSessionId: () => string | undefined; getSession$: () => ", "<boolean>; hasAccess: () => boolean; trackSearch: (searchDescriptor: TrackSearchDescriptor) => TrackSearchHandler; getSessionId: () => string | undefined; getSession$: () => ",
"Observable", "Observable",
"<string | undefined>; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; continue: (sessionId: string) => void; clear: () => void; cancel: () => Promise<void>; renameCurrentSession: (newName: string) => Promise<void>; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required<Pick<", "<string | undefined>; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; continue: (sessionId: string) => void; cancel: () => Promise<void>; renameCurrentSession: (newName: string) => Promise<void>; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required<Pick<",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
@ -252,26 +252,8 @@
"\nSearch sessions SO CRUD\n{@link ISessionsClient}" "\nSearch sessions SO CRUD\n{@link ISessionsClient}"
], ],
"signature": [ "signature": [
"{ get: (sessionId: string) => Promise<", "{ create: ({ name, appId, locatorId, initialState, restoreState, sessionId, }: { name: string; appId: string; locatorId: string; initialState: Record<string, unknown>; restoreState: Record<string, unknown>; sessionId: string; }) => Promise<",
"SearchSessionSavedObject", "SearchSessionSavedObject",
">; delete: (sessionId: string) => Promise<void>; create: ({ name, appId, locatorId, initialState, restoreState, sessionId, }: { name: string; appId: string; locatorId: string; initialState: Record<string, unknown>; restoreState: Record<string, unknown>; sessionId: string; }) => Promise<",
"SearchSessionSavedObject",
">; find: (options: Omit<",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-common.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\">) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSessionsFindResponse",
"text": "SearchSessionsFindResponse"
},
">; update: (sessionId: string, attributes: unknown) => Promise<", ">; update: (sessionId: string, attributes: unknown) => Promise<",
{ {
"pluginId": "@kbn/core-saved-objects-api-server", "pluginId": "@kbn/core-saved-objects-api-server",
@ -288,23 +270,25 @@
"section": "def-common.SearchSessionSavedObjectAttributes", "section": "def-common.SearchSessionSavedObjectAttributes",
"text": "SearchSessionSavedObjectAttributes" "text": "SearchSessionSavedObjectAttributes"
}, },
">>; rename: (sessionId: string, newName: string) => Promise<", ">>; get: (sessionId: string) => Promise<",
"SearchSessionSavedObject",
">; delete: (sessionId: string) => Promise<void>; find: (options: Omit<",
{ {
"pluginId": "@kbn/core-saved-objects-api-server", "pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common", "scope": "common",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi", "docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-common.SavedObjectsUpdateResponse", "section": "def-common.SavedObjectsFindOptions",
"text": "SavedObjectsUpdateResponse" "text": "SavedObjectsFindOptions"
}, },
"<Pick<", ", \"type\">) => Promise<",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
"docId": "kibDataSearchPluginApi", "docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSessionSavedObjectAttributes", "section": "def-common.SearchSessionsFindResponse",
"text": "SearchSessionSavedObjectAttributes" "text": "SearchSessionsFindResponse"
}, },
", \"name\">>>; extend: (sessionId: string, expires: string) => Promise<", ">; extend: (sessionId: string, expires: string) => Promise<",
{ {
"pluginId": "@kbn/core-saved-objects-api-server", "pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common", "scope": "common",
@ -320,7 +304,23 @@
"section": "def-common.SearchSessionSavedObjectAttributes", "section": "def-common.SearchSessionSavedObjectAttributes",
"text": "SearchSessionSavedObjectAttributes" "text": "SearchSessionSavedObjectAttributes"
}, },
", unknown>>; }" ", unknown>>; rename: (sessionId: string, newName: string) => Promise<",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-common.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSessionSavedObjectAttributes",
"text": "SearchSessionSavedObjectAttributes"
},
", \"name\">>>; }"
], ],
"path": "src/plugins/data/public/search/types.ts", "path": "src/plugins/data/public/search/types.ts",
"deprecated": false, "deprecated": false,
@ -662,7 +662,7 @@
"\nCurrent session management\n{@link ISessionService}" "\nCurrent session management\n{@link ISessionService}"
], ],
"signature": [ "signature": [
"{ start: () => string; save: () => Promise<void>; destroy: () => void; readonly state$: ", "{ start: () => string; save: () => Promise<void>; clear: () => void; destroy: () => void; readonly state$: ",
"Observable", "Observable",
"<", "<",
{ {
@ -680,7 +680,7 @@
"Observable", "Observable",
"<boolean>; hasAccess: () => boolean; trackSearch: (searchDescriptor: TrackSearchDescriptor) => TrackSearchHandler; getSessionId: () => string | undefined; getSession$: () => ", "<boolean>; hasAccess: () => boolean; trackSearch: (searchDescriptor: TrackSearchDescriptor) => TrackSearchHandler; getSessionId: () => string | undefined; getSession$: () => ",
"Observable", "Observable",
"<string | undefined>; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; continue: (sessionId: string) => void; clear: () => void; cancel: () => Promise<void>; renameCurrentSession: (newName: string) => Promise<void>; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required<Pick<", "<string | undefined>; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; continue: (sessionId: string) => void; cancel: () => Promise<void>; renameCurrentSession: (newName: string) => Promise<void>; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required<Pick<",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
@ -720,26 +720,8 @@
"\nSearch sessions SO CRUD\n{@link ISessionsClient}" "\nSearch sessions SO CRUD\n{@link ISessionsClient}"
], ],
"signature": [ "signature": [
"{ get: (sessionId: string) => Promise<", "{ create: ({ name, appId, locatorId, initialState, restoreState, sessionId, }: { name: string; appId: string; locatorId: string; initialState: Record<string, unknown>; restoreState: Record<string, unknown>; sessionId: string; }) => Promise<",
"SearchSessionSavedObject", "SearchSessionSavedObject",
">; delete: (sessionId: string) => Promise<void>; create: ({ name, appId, locatorId, initialState, restoreState, sessionId, }: { name: string; appId: string; locatorId: string; initialState: Record<string, unknown>; restoreState: Record<string, unknown>; sessionId: string; }) => Promise<",
"SearchSessionSavedObject",
">; find: (options: Omit<",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-common.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\">) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSessionsFindResponse",
"text": "SearchSessionsFindResponse"
},
">; update: (sessionId: string, attributes: unknown) => Promise<", ">; update: (sessionId: string, attributes: unknown) => Promise<",
{ {
"pluginId": "@kbn/core-saved-objects-api-server", "pluginId": "@kbn/core-saved-objects-api-server",
@ -756,23 +738,25 @@
"section": "def-common.SearchSessionSavedObjectAttributes", "section": "def-common.SearchSessionSavedObjectAttributes",
"text": "SearchSessionSavedObjectAttributes" "text": "SearchSessionSavedObjectAttributes"
}, },
">>; rename: (sessionId: string, newName: string) => Promise<", ">>; get: (sessionId: string) => Promise<",
"SearchSessionSavedObject",
">; delete: (sessionId: string) => Promise<void>; find: (options: Omit<",
{ {
"pluginId": "@kbn/core-saved-objects-api-server", "pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common", "scope": "common",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi", "docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-common.SavedObjectsUpdateResponse", "section": "def-common.SavedObjectsFindOptions",
"text": "SavedObjectsUpdateResponse" "text": "SavedObjectsFindOptions"
}, },
"<Pick<", ", \"type\">) => Promise<",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
"docId": "kibDataSearchPluginApi", "docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSessionSavedObjectAttributes", "section": "def-common.SearchSessionsFindResponse",
"text": "SearchSessionSavedObjectAttributes" "text": "SearchSessionsFindResponse"
}, },
", \"name\">>>; extend: (sessionId: string, expires: string) => Promise<", ">; extend: (sessionId: string, expires: string) => Promise<",
{ {
"pluginId": "@kbn/core-saved-objects-api-server", "pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common", "scope": "common",
@ -788,7 +772,23 @@
"section": "def-common.SearchSessionSavedObjectAttributes", "section": "def-common.SearchSessionSavedObjectAttributes",
"text": "SearchSessionSavedObjectAttributes" "text": "SearchSessionSavedObjectAttributes"
}, },
", unknown>>; }" ", unknown>>; rename: (sessionId: string, newName: string) => Promise<",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-common.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSessionSavedObjectAttributes",
"text": "SearchSessionSavedObjectAttributes"
},
", \"name\">>>; }"
], ],
"path": "src/plugins/data/public/search/types.ts", "path": "src/plugins/data/public/search/types.ts",
"deprecated": false, "deprecated": false,
@ -1300,26 +1300,8 @@
"label": "ISessionsClient", "label": "ISessionsClient",
"description": [], "description": [],
"signature": [ "signature": [
"{ get: (sessionId: string) => Promise<", "{ create: ({ name, appId, locatorId, initialState, restoreState, sessionId, }: { name: string; appId: string; locatorId: string; initialState: Record<string, unknown>; restoreState: Record<string, unknown>; sessionId: string; }) => Promise<",
"SearchSessionSavedObject", "SearchSessionSavedObject",
">; delete: (sessionId: string) => Promise<void>; create: ({ name, appId, locatorId, initialState, restoreState, sessionId, }: { name: string; appId: string; locatorId: string; initialState: Record<string, unknown>; restoreState: Record<string, unknown>; sessionId: string; }) => Promise<",
"SearchSessionSavedObject",
">; find: (options: Omit<",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-common.SavedObjectsFindOptions",
"text": "SavedObjectsFindOptions"
},
", \"type\">) => Promise<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSessionsFindResponse",
"text": "SearchSessionsFindResponse"
},
">; update: (sessionId: string, attributes: unknown) => Promise<", ">; update: (sessionId: string, attributes: unknown) => Promise<",
{ {
"pluginId": "@kbn/core-saved-objects-api-server", "pluginId": "@kbn/core-saved-objects-api-server",
@ -1336,23 +1318,25 @@
"section": "def-common.SearchSessionSavedObjectAttributes", "section": "def-common.SearchSessionSavedObjectAttributes",
"text": "SearchSessionSavedObjectAttributes" "text": "SearchSessionSavedObjectAttributes"
}, },
">>; rename: (sessionId: string, newName: string) => Promise<", ">>; get: (sessionId: string) => Promise<",
"SearchSessionSavedObject",
">; delete: (sessionId: string) => Promise<void>; find: (options: Omit<",
{ {
"pluginId": "@kbn/core-saved-objects-api-server", "pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common", "scope": "common",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi", "docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-common.SavedObjectsUpdateResponse", "section": "def-common.SavedObjectsFindOptions",
"text": "SavedObjectsUpdateResponse" "text": "SavedObjectsFindOptions"
}, },
"<Pick<", ", \"type\">) => Promise<",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
"docId": "kibDataSearchPluginApi", "docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSessionSavedObjectAttributes", "section": "def-common.SearchSessionsFindResponse",
"text": "SearchSessionSavedObjectAttributes" "text": "SearchSessionsFindResponse"
}, },
", \"name\">>>; extend: (sessionId: string, expires: string) => Promise<", ">; extend: (sessionId: string, expires: string) => Promise<",
{ {
"pluginId": "@kbn/core-saved-objects-api-server", "pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common", "scope": "common",
@ -1368,7 +1352,23 @@
"section": "def-common.SearchSessionSavedObjectAttributes", "section": "def-common.SearchSessionSavedObjectAttributes",
"text": "SearchSessionSavedObjectAttributes" "text": "SearchSessionSavedObjectAttributes"
}, },
", unknown>>; }" ", unknown>>; rename: (sessionId: string, newName: string) => Promise<",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-common.SavedObjectsUpdateResponse",
"text": "SavedObjectsUpdateResponse"
},
"<Pick<",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSessionSavedObjectAttributes",
"text": "SearchSessionSavedObjectAttributes"
},
", \"name\">>>; }"
], ],
"path": "src/plugins/data/public/search/session/sessions_client.ts", "path": "src/plugins/data/public/search/session/sessions_client.ts",
"deprecated": false, "deprecated": false,
@ -1383,7 +1383,7 @@
"label": "ISessionService", "label": "ISessionService",
"description": [], "description": [],
"signature": [ "signature": [
"{ start: () => string; save: () => Promise<void>; destroy: () => void; readonly state$: ", "{ start: () => string; save: () => Promise<void>; clear: () => void; destroy: () => void; readonly state$: ",
"Observable", "Observable",
"<", "<",
{ {
@ -1401,7 +1401,7 @@
"Observable", "Observable",
"<boolean>; hasAccess: () => boolean; trackSearch: (searchDescriptor: TrackSearchDescriptor) => TrackSearchHandler; getSessionId: () => string | undefined; getSession$: () => ", "<boolean>; hasAccess: () => boolean; trackSearch: (searchDescriptor: TrackSearchDescriptor) => TrackSearchHandler; getSessionId: () => string | undefined; getSession$: () => ",
"Observable", "Observable",
"<string | undefined>; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; continue: (sessionId: string) => void; clear: () => void; cancel: () => Promise<void>; renameCurrentSession: (newName: string) => Promise<void>; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required<Pick<", "<string | undefined>; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; continue: (sessionId: string) => void; cancel: () => Promise<void>; renameCurrentSession: (newName: string) => Promise<void>; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required<Pick<",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
@ -1606,7 +1606,7 @@
"label": "config", "label": "config",
"description": [], "description": [],
"signature": [ "signature": [
"Readonly<{} & { search: Readonly<{} & { aggs: Readonly<{} & { shardDelay: Readonly<{} & { enabled: boolean; }>; }>; asyncSearch: Readonly<{ pollInterval?: number | undefined; } & { waitForCompletion: moment.Duration; keepAlive: moment.Duration; batchedReduceSize: number; }>; sessions: Readonly<{} & { enabled: boolean; notTouchedTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; }>; }>; }>" "Readonly<{} & { search: Readonly<{} & { aggs: Readonly<{} & { shardDelay: Readonly<{} & { enabled: boolean; }>; }>; asyncSearch: Readonly<{ pollInterval?: number | undefined; } & { waitForCompletion: moment.Duration; keepAlive: moment.Duration; batchedReduceSize: number; }>; sessions: Readonly<{} & { enabled: boolean; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; notTouchedTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; }>; }>; }>"
], ],
"path": "src/plugins/data/server/search/session/session_service.ts", "path": "src/plugins/data/server/search/session/session_service.ts",
"deprecated": false, "deprecated": false,
@ -2846,7 +2846,7 @@
"section": "def-common.SearchSessionStatusResponse", "section": "def-common.SearchSessionStatusResponse",
"text": "SearchSessionStatusResponse" "text": "SearchSessionStatusResponse"
}, },
">; getConfig: () => Readonly<{} & { enabled: boolean; notTouchedTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; }>; }" ">; getConfig: () => Readonly<{} & { enabled: boolean; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; notTouchedTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; }>; }"
], ],
"path": "src/plugins/data/server/search/session/session_service.ts", "path": "src/plugins/data/server/search/session/session_service.ts",
"deprecated": false, "deprecated": false,
@ -3134,11 +3134,9 @@
"label": "options", "label": "options",
"description": [], "description": [],
"signature": [ "signature": [
"{ filter?: any; search?: string | undefined; fields?: string[] | undefined; aggs?: Record<string, ", "{ page?: number | undefined; filter?: any; aggs?: Record<string, ",
"AggregationsAggregationContainer", "AggregationsAggregationContainer",
"> | undefined; searchAfter?: ", "> | undefined; search?: string | undefined; namespaces?: string[] | undefined; sortField?: string | undefined; fields?: string[] | undefined; preference?: string | undefined; pit?: ",
"SortResults",
" | undefined; pit?: ",
{ {
"pluginId": "@kbn/core-saved-objects-api-server", "pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common", "scope": "common",
@ -3146,9 +3144,11 @@
"section": "def-common.SavedObjectsPitParams", "section": "def-common.SavedObjectsPitParams",
"text": "SavedObjectsPitParams" "text": "SavedObjectsPitParams"
}, },
" | undefined; page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: ", " | undefined; perPage?: number | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; searchFields?: string[] | undefined; rootSearchFields?: string[] | undefined; sortOrder?: ",
"SortOrder", "SortOrder",
" | undefined; searchFields?: string[] | undefined; rootSearchFields?: string[] | undefined; hasReference?: ", " | undefined; searchAfter?: ",
"SortResults",
" | undefined; hasReference?: ",
{ {
"pluginId": "@kbn/core-saved-objects-api-server", "pluginId": "@kbn/core-saved-objects-api-server",
"scope": "common", "scope": "common",
@ -3180,7 +3180,7 @@
"section": "def-common.SavedObjectsFindOptionsReference", "section": "def-common.SavedObjectsFindOptionsReference",
"text": "SavedObjectsFindOptionsReference" "text": "SavedObjectsFindOptionsReference"
}, },
"[] | undefined; hasNoReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map<string, string[] | undefined> | undefined; preference?: string | undefined; }" "[] | undefined; hasNoReferenceOperator?: \"AND\" | \"OR\" | undefined; typeToNamespacesMap?: Map<string, string[] | undefined> | undefined; }"
], ],
"path": "src/plugins/data/server/search/session/types.ts", "path": "src/plugins/data/server/search/session/types.ts",
"deprecated": false, "deprecated": false,
@ -7225,7 +7225,19 @@
"section": "def-common.SearchSource", "section": "def-common.SearchSource",
"text": "SearchSource" "text": "SearchSource"
}, },
"; history: ", "; fetch: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; history: ",
"SearchRequest", "SearchRequest",
"[]; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: <K extends keyof ", "[]; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: <K extends keyof ",
{ {
@ -7393,19 +7405,7 @@
"SearchResponse", "SearchResponse",
"<T, Record<string, ", "<T, Record<string, ",
"AggregationsAggregate", "AggregationsAggregate",
">>>>; fetch: (options?: ", ">>>>; onRequestStart: (handler: (searchSource: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; onRequestStart: (handler: (searchSource: ",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
@ -8922,6 +8922,7 @@
"label": "filterFieldTypes", "label": "filterFieldTypes",
"description": [], "description": [],
"signature": [ "signature": [
"\"*\" | ",
{ {
"pluginId": "@kbn/field-types", "pluginId": "@kbn/field-types",
"scope": "common", "scope": "common",
@ -8929,7 +8930,7 @@
"section": "def-common.KBN_FIELD_TYPES", "section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES" "text": "KBN_FIELD_TYPES"
}, },
" | \"*\" | ", " | ",
{ {
"pluginId": "@kbn/field-types", "pluginId": "@kbn/field-types",
"scope": "common", "scope": "common",
@ -15698,7 +15699,7 @@
"section": "def-common.DataView", "section": "def-common.DataView",
"text": "DataView" "text": "DataView"
}, },
", aggName: \"date_histogram\" | \"date_range\", getConfig: <T = any>(key: string) => T, { shouldDetectTimeZone }: { shouldDetectTimeZone?: boolean | undefined; } | undefined) => string" ", aggName: \"date_range\" | \"date_histogram\", getConfig: <T = any>(key: string) => T, { shouldDetectTimeZone }: { shouldDetectTimeZone?: boolean | undefined; } | undefined) => string"
], ],
"path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts",
"deprecated": false, "deprecated": false,
@ -15782,7 +15783,7 @@
"label": "aggName", "label": "aggName",
"description": [], "description": [],
"signature": [ "signature": [
"\"date_histogram\" | \"date_range\"" "\"date_range\" | \"date_histogram\""
], ],
"path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts", "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.ts",
"deprecated": false, "deprecated": false,
@ -26200,7 +26201,7 @@
"label": "aggregate", "label": "aggregate",
"description": [], "description": [],
"signature": [ "signature": [
"\"min\" | \"max\" | \"concat\" | \"sum\" | \"average\"" "\"min\" | \"max\" | \"sum\" | \"concat\" | \"average\""
], ],
"path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts", "path": "src/plugins/data/common/search/aggs/metrics/top_hit.ts",
"deprecated": false, "deprecated": false,
@ -31599,7 +31600,7 @@
"label": "AggConfigOptions", "label": "AggConfigOptions",
"description": [], "description": [],
"signature": [ "signature": [
"{ schema?: string | undefined; type: ", "{ type: ",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
@ -31607,7 +31608,7 @@
"section": "def-common.IAggType", "section": "def-common.IAggType",
"text": "IAggType" "text": "IAggType"
}, },
"; params?: {} | ", "; id?: string | undefined; params?: {} | ",
{ {
"pluginId": "@kbn/utility-types", "pluginId": "@kbn/utility-types",
"scope": "common", "scope": "common",
@ -31615,7 +31616,7 @@
"section": "def-common.SerializableRecord", "section": "def-common.SerializableRecord",
"text": "SerializableRecord" "text": "SerializableRecord"
}, },
" | undefined; id?: string | undefined; enabled?: boolean | undefined; }" " | undefined; schema?: string | undefined; enabled?: boolean | undefined; }"
], ],
"path": "src/plugins/data/common/search/aggs/agg_config.ts", "path": "src/plugins/data/common/search/aggs/agg_config.ts",
"deprecated": false, "deprecated": false,
@ -32524,7 +32525,7 @@
"label": "CreateAggConfigParams", "label": "CreateAggConfigParams",
"description": [], "description": [],
"signature": [ "signature": [
"{ schema?: string | undefined; type: string | ", "{ type: string | ",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
@ -32532,7 +32533,7 @@
"section": "def-common.IAggType", "section": "def-common.IAggType",
"text": "IAggType" "text": "IAggType"
}, },
"; params?: {} | ", "; id?: string | undefined; params?: {} | ",
{ {
"pluginId": "@kbn/utility-types", "pluginId": "@kbn/utility-types",
"scope": "common", "scope": "common",
@ -32540,7 +32541,7 @@
"section": "def-common.SerializableRecord", "section": "def-common.SerializableRecord",
"text": "SerializableRecord" "text": "SerializableRecord"
}, },
" | undefined; id?: string | undefined; enabled?: boolean | undefined; }" " | undefined; schema?: string | undefined; enabled?: boolean | undefined; }"
], ],
"path": "src/plugins/data/common/search/aggs/agg_configs.ts", "path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"deprecated": false, "deprecated": false,
@ -34273,6 +34274,7 @@
"label": "FieldTypes", "label": "FieldTypes",
"description": [], "description": [],
"signature": [ "signature": [
"\"*\" | ",
{ {
"pluginId": "@kbn/field-types", "pluginId": "@kbn/field-types",
"scope": "common", "scope": "common",
@ -34280,7 +34282,7 @@
"section": "def-common.KBN_FIELD_TYPES", "section": "def-common.KBN_FIELD_TYPES",
"text": "KBN_FIELD_TYPES" "text": "KBN_FIELD_TYPES"
}, },
" | \"*\" | ", " | ",
{ {
"pluginId": "@kbn/field-types", "pluginId": "@kbn/field-types",
"scope": "common", "scope": "common",
@ -34968,7 +34970,19 @@
"section": "def-common.SearchSource", "section": "def-common.SearchSource",
"text": "SearchSource" "text": "SearchSource"
}, },
"; history: ", "; fetch: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; history: ",
"SearchRequest", "SearchRequest",
"[]; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: <K extends keyof ", "[]; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: <K extends keyof ",
{ {
@ -35136,19 +35150,7 @@
"SearchResponse", "SearchResponse",
"<T, Record<string, ", "<T, Record<string, ",
"AggregationsAggregate", "AggregationsAggregate",
">>>>; fetch: (options?: ", ">>>>; onRequestStart: (handler: (searchSource: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; onRequestStart: (handler: (searchSource: ",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
@ -35500,7 +35502,7 @@
"label": "SearchTypes", "label": "SearchTypes",
"description": [], "description": [],
"signature": [ "signature": [
"string | number | boolean | object | string[] | number[] | boolean[] | object[] | undefined" "string | number | boolean | object | string[] | boolean[] | number[] | object[] | undefined"
], ],
"path": "src/plugins/data/common/search/expressions/eql_raw_response.ts", "path": "src/plugins/data/common/search/expressions/eql_raw_response.ts",
"deprecated": false, "deprecated": false,
@ -36124,7 +36126,7 @@
"label": "types", "label": "types",
"description": [], "description": [],
"signature": [ "signature": [
"(\"number\" | \"string\")[]" "(\"string\" | \"number\")[]"
], ],
"path": "src/plugins/data/common/search/expressions/date_range.ts", "path": "src/plugins/data/common/search/expressions/date_range.ts",
"deprecated": false, "deprecated": false,
@ -36165,7 +36167,7 @@
"label": "types", "label": "types",
"description": [], "description": [],
"signature": [ "signature": [
"(\"number\" | \"string\")[]" "(\"string\" | \"number\")[]"
], ],
"path": "src/plugins/data/common/search/expressions/date_range.ts", "path": "src/plugins/data/common/search/expressions/date_range.ts",
"deprecated": false, "deprecated": false,
@ -37897,7 +37899,7 @@
"label": "types", "label": "types",
"description": [], "description": [],
"signature": [ "signature": [
"(\"number\" | \"string\")[]" "(\"string\" | \"number\")[]"
], ],
"path": "src/plugins/data/common/search/expressions/geo_point.ts", "path": "src/plugins/data/common/search/expressions/geo_point.ts",
"deprecated": false, "deprecated": false,
@ -38293,7 +38295,7 @@
"label": "inputTypes", "label": "inputTypes",
"description": [], "description": [],
"signature": [ "signature": [
"(\"null\" | \"kibana_context\")[]" "(\"kibana_context\" | \"null\")[]"
], ],
"path": "src/plugins/data/common/search/expressions/kibana.ts", "path": "src/plugins/data/common/search/expressions/kibana.ts",
"deprecated": false, "deprecated": false,
@ -41107,7 +41109,7 @@
"label": "types", "label": "types",
"description": [], "description": [],
"signature": [ "signature": [
"(\"number\" | \"string\")[]" "(\"string\" | \"number\")[]"
], ],
"path": "src/plugins/data/common/search/expressions/range.ts", "path": "src/plugins/data/common/search/expressions/range.ts",
"deprecated": false, "deprecated": false,
@ -41148,7 +41150,7 @@
"label": "types", "label": "types",
"description": [], "description": [],
"signature": [ "signature": [
"(\"number\" | \"string\")[]" "(\"string\" | \"number\")[]"
], ],
"path": "src/plugins/data/common/search/expressions/range.ts", "path": "src/plugins/data/common/search/expressions/range.ts",
"deprecated": false, "deprecated": false,
@ -41189,7 +41191,7 @@
"label": "types", "label": "types",
"description": [], "description": [],
"signature": [ "signature": [
"(\"number\" | \"string\")[]" "(\"string\" | \"number\")[]"
], ],
"path": "src/plugins/data/common/search/expressions/range.ts", "path": "src/plugins/data/common/search/expressions/range.ts",
"deprecated": false, "deprecated": false,
@ -41230,7 +41232,7 @@
"label": "types", "label": "types",
"description": [], "description": [],
"signature": [ "signature": [
"(\"number\" | \"string\")[]" "(\"string\" | \"number\")[]"
], ],
"path": "src/plugins/data/common/search/expressions/range.ts", "path": "src/plugins/data/common/search/expressions/range.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/data-search
title: "data.search" title: "data.search"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the data.search plugin description: API docs for the data.search plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
--- ---
import dataSearchObj from './data_search.devdocs.json'; import dataSearchObj from './data_search.devdocs.json';
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin. Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/dataViewEditor
title: "dataViewEditor" title: "dataViewEditor"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewEditor plugin description: API docs for the dataViewEditor plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
--- ---
import dataViewEditorObj from './data_view_editor.devdocs.json'; import dataViewEditorObj from './data_view_editor.devdocs.json';
This plugin provides the ability to create data views via a modal flyout inside Kibana apps This plugin provides the ability to create data views via a modal flyout inside Kibana apps
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin. Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor
title: "dataViewFieldEditor" title: "dataViewFieldEditor"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewFieldEditor plugin description: API docs for the dataViewFieldEditor plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
--- ---
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json'; import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';
Reusable data view field editor across Kibana Reusable data view field editor across Kibana
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin. Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/dataViewManagement
title: "dataViewManagement" title: "dataViewManagement"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewManagement plugin description: API docs for the dataViewManagement plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
--- ---
import dataViewManagementObj from './data_view_management.devdocs.json'; import dataViewManagementObj from './data_view_management.devdocs.json';
Data view management app Data view management app
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin. Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin.
**Code health stats** **Code health stats**

File diff suppressed because one or more lines are too long

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/dataViews
title: "dataViews" title: "dataViews"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViews plugin description: API docs for the dataViews plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
--- ---
import dataViewsObj from './data_views.devdocs.json'; import dataViewsObj from './data_views.devdocs.json';
Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters.
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin. Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/dataVisualizer
title: "dataVisualizer" title: "dataVisualizer"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the dataVisualizer plugin description: API docs for the dataVisualizer plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
--- ---
import dataVisualizerObj from './data_visualizer.devdocs.json'; import dataVisualizerObj from './data_visualizer.devdocs.json';
The Data Visualizer tools help you understand your data, by analyzing the metrics and fields in a log file or an existing Elasticsearch index. The Data Visualizer tools help you understand your data, by analyzing the metrics and fields in a log file or an existing Elasticsearch index.
Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for questions regarding this plugin. Contact [@elastic/ml-ui](https://github.com/orgs/elastic/teams/ml-ui) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
title: Deprecated API usage by API title: Deprecated API usage by API
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---
@ -16,37 +16,29 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Deprecated API | Referencing plugin(s) | Remove By | | 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-public.SearchSource.create" text="create"/> | alerting, discover, securitySolution | - |
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | - | | <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | - |
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.create" text="create"/> | alerting, discover, securitySolution | - | | <DocLink id="kibDataPluginApi" section="def-common.SearchSource.create" text="create"/> | alerting, discover, securitySolution | - |
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | - | | <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | - |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | actions, alerting | - | | <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | actions, alerting | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectAttributes" text="SavedObjectAttributes"/> | @kbn/core-saved-objects-common, @kbn/core-saved-objects-server, actions, alerting, canvas, enterpriseSearch, securitySolution, taskManager, dashboard, savedSearch, @kbn/core-saved-objects-server-internal | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsType.convertToMultiNamespaceTypeVersion" text="convertToMultiNamespaceTypeVersion"/> | @kbn/core-saved-objects-migration-server-internal, actions, dataViews, data, alerting, savedObjectsTagging, canvas, lens, cases, graph, lists, maps, securitySolution, dashboard, savedSearch, visualizations, @kbn/core-test-helpers-so-type-serializer | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectsType.convertToMultiNamespaceTypeVersion" text="convertToMultiNamespaceTypeVersion"/> | @kbn/core-saved-objects-migration-server-internal, actions, dataViews, data, alerting, savedObjectsTagging, canvas, lens, cases, graph, lists, maps, securitySolution, dashboard, savedSearch, visualizations, @kbn/core-test-helpers-so-type-serializer | - | | <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectsType.convertToMultiNamespaceTypeVersion" text="convertToMultiNamespaceTypeVersion"/> | @kbn/core-saved-objects-migration-server-internal, actions, dataViews, data, alerting, savedObjectsTagging, canvas, lens, cases, graph, lists, maps, securitySolution, dashboard, savedSearch, visualizations, @kbn/core-test-helpers-so-type-serializer | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | @kbn/core-saved-objects-common, core, actions, alerting, canvas, enterpriseSearch, securitySolution, taskManager, dashboard, savedSearch, @kbn/core-saved-objects-server-internal, savedObjects, embeddable, visualizations, fleet, infra, graph, ml | - | | <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectAttributes" text="SavedObjectAttributes"/> | @kbn/core-saved-objects-common, @kbn/core, actions, alerting, canvas, enterpriseSearch, securitySolution, taskManager, dashboard, savedSearch, @kbn/core-saved-objects-server-internal, savedObjects, embeddable, visualizations, fleet, infra, graph, ml | - |
| <DocLink id="kibDataPluginApi" section="def-public.syncQueryStateWithUrl" text="syncQueryStateWithUrl"/> | discover, monitoring | - | | <DocLink id="kibDataPluginApi" section="def-public.syncQueryStateWithUrl" text="syncQueryStateWithUrl"/> | discover, monitoring | - |
| <DocLink id="kibDataPluginApi" section="def-public.SavedObject" text="SavedObject"/> | @kbn/core-saved-objects-common, @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, core, home, dataViews, discover, savedObjectsTagging, savedObjectsFinder, fleet, canvas, osquery, securitySolution, synthetics, savedObjects, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-server, @kbn/core-saved-objects-import-export-server-internal, apm, savedObjectsTaggingOss, cases, lists, upgradeAssistant, savedObjectsManagement, @kbn/core-ui-settings-server-internal, data, dashboard | - | | <DocLink id="kibDataPluginApi" section="def-public.SavedObject" text="SavedObject"/> | @kbn/core-saved-objects-common, @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, @kbn/core, home, dataViews, discover, savedObjectsTagging, savedObjectsFinder, fleet, canvas, osquery, securitySolution, synthetics, savedObjects, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-server, @kbn/core-saved-objects-import-export-server-internal, apm, savedObjectsTaggingOss, cases, lists, upgradeAssistant, savedObjectsManagement, @kbn/core-ui-settings-server-internal, dashboard | - |
| <DocLink id="kibDataPluginApi" section="def-common.SavedObject" text="SavedObject"/> | @kbn/core-saved-objects-common, @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, core, home, dataViews, discover, savedObjectsTagging, savedObjectsFinder, fleet, canvas, osquery, securitySolution, synthetics, savedObjects, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-server, @kbn/core-saved-objects-import-export-server-internal, apm, savedObjectsTaggingOss, cases, lists, upgradeAssistant, savedObjectsManagement, @kbn/core-ui-settings-server-internal, data | - | | <DocLink id="kibDataPluginApi" section="def-common.SavedObject" text="SavedObject"/> | @kbn/core-saved-objects-common, @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-api-server, @kbn/core, home, dataViews, discover, savedObjectsTagging, savedObjectsFinder, fleet, canvas, osquery, securitySolution, synthetics, savedObjects, @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-server, @kbn/core-saved-objects-import-export-server-internal, apm, savedObjectsTaggingOss, cases, lists, upgradeAssistant, savedObjectsManagement, @kbn/core-ui-settings-server-internal, data | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.title" text="title"/> | @kbn/es-query, securitySolution, timelines, lists, threatIntelligence, dataViews, unifiedSearch, triggersActionsUi, savedObjectsManagement, controls, unifiedFieldList, lens, discover, aiops, ml, infra, visTypeTimeseries, apm, observability, dataVisualizer, fleet, canvas, graph, stackAlerts, synthetics, transform, upgradeAssistant, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - | | <DocLink id="kibDataPluginApi" section="def-common.DataView.title" text="title"/> | @kbn/es-query, securitySolution, timelines, lists, threatIntelligence, dataViews, unifiedSearch, triggersActionsUi, savedObjectsManagement, controls, unifiedFieldList, lens, discover, aiops, ml, infra, visTypeTimeseries, apm, observability, dataVisualizer, fleet, canvas, graph, stackAlerts, synthetics, transform, upgradeAssistant, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - |
| <DocLink id="kibDataPluginApi" section="def-common.EsQuerySearchAfter" text="EsQuerySearchAfter"/> | discover | - | | <DocLink id="kibDataPluginApi" section="def-common.EsQuerySearchAfter" text="EsQuerySearchAfter"/> | discover | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.title" text="title"/> | @kbn/es-query, securitySolution, timelines, lists, threatIntelligence, dataViews, unifiedSearch, triggersActionsUi, savedObjectsManagement, controls, unifiedFieldList, lens, discover, aiops, ml, infra, visTypeTimeseries, apm, observability, dataVisualizer, fleet, canvas, graph, stackAlerts, synthetics, transform, upgradeAssistant, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - | | <DocLink id="kibDataPluginApi" section="def-server.DataView.title" text="title"/> | @kbn/es-query, securitySolution, timelines, lists, threatIntelligence, dataViews, unifiedSearch, triggersActionsUi, savedObjectsManagement, controls, unifiedFieldList, lens, discover, aiops, ml, infra, visTypeTimeseries, apm, observability, dataVisualizer, fleet, canvas, graph, stackAlerts, synthetics, transform, upgradeAssistant, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega, data | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | @kbn/es-query, securitySolution, timelines, lists, threatIntelligence, data, unifiedSearch, triggersActionsUi, savedObjectsManagement, controls, unifiedFieldList, lens, discover, aiops, ml, infra, visTypeTimeseries, apm, observability, dataVisualizer, fleet, canvas, graph, stackAlerts, synthetics, transform, upgradeAssistant, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega | - | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | @kbn/es-query, securitySolution, timelines, lists, threatIntelligence, data, unifiedSearch, triggersActionsUi, savedObjectsManagement, controls, unifiedFieldList, lens, discover, aiops, ml, infra, visTypeTimeseries, apm, observability, dataVisualizer, fleet, canvas, graph, stackAlerts, synthetics, transform, upgradeAssistant, ux, maps, dataViewManagement, inputControlVis, visDefaultEditor, presentationUtil, visTypeTimelion, visTypeVega | - |
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.executeTriggerActions" text="executeTriggerActions"/> | data, discover, imageEmbeddable, embeddable | - | | <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.executeTriggerActions" text="executeTriggerActions"/> | data, discover, imageEmbeddable, embeddable | - |
| <DocLink id="kibCorePluginApi" section="def-public.UiSettingsParams.metric" text="metric"/> | advancedSettings, discover | - |
| <DocLink id="kibCorePluginApi" section="def-public.CoreStart.savedObjects" text="savedObjects"/> | @kbn/core-plugins-browser-internal, @kbn/core-root-browser-internal, dataViews, home, data, savedObjects, embeddable, unifiedSearch, presentationUtil, visualizations, dashboard, lens, discover, cases, fileUpload, maps, ml, infra, fleet, canvas, dashboardEnhanced, graph, monitoring, synthetics, transform, watcher, dataVisualizer, cloudSecurityPosture, securitySolution | - |
| <DocLink id="kibCorePluginApi" section="def-server.UiSettingsParams.metric" text="metric"/> | advancedSettings, discover | - |
| <DocLink id="kibKbnCoreLifecycleBrowserPluginApi" section="def-common.CoreStart.savedObjects" text="savedObjects"/> | @kbn/core-plugins-browser-internal, @kbn/core-root-browser-internal, dataViews, home, data, savedObjects, embeddable, unifiedSearch, presentationUtil, visualizations, dashboard, lens, discover, cases, fileUpload, maps, ml, infra, fleet, canvas, dashboardEnhanced, graph, monitoring, synthetics, transform, watcher, dataVisualizer, cloudSecurityPosture, securitySolution | - | | <DocLink id="kibKbnCoreLifecycleBrowserPluginApi" section="def-common.CoreStart.savedObjects" text="savedObjects"/> | @kbn/core-plugins-browser-internal, @kbn/core-root-browser-internal, dataViews, home, data, savedObjects, embeddable, unifiedSearch, presentationUtil, visualizations, dashboard, lens, discover, cases, fileUpload, maps, ml, infra, fleet, canvas, dashboardEnhanced, graph, monitoring, synthetics, transform, watcher, dataVisualizer, cloudSecurityPosture, securitySolution | - |
| <DocLink id="kibKbnCoreUiSettingsCommonPluginApi" section="def-common.UiSettingsParams.metric" text="metric"/> | advancedSettings, discover | - | | <DocLink id="kibKbnCoreUiSettingsCommonPluginApi" section="def-common.UiSettingsParams.metric" text="metric"/> | advancedSettings, discover | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | infra, graph, stackAlerts, inputControlVis, securitySolution, savedObjects | - | | <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | infra, graph, stackAlerts, inputControlVis, securitySolution, savedObjects | - |
| <DocLink id="kibDataPluginApi" section="def-common.EqlSearchStrategyRequest.options" text="options"/> | securitySolution | - | | <DocLink id="kibDataPluginApi" section="def-common.EqlSearchStrategyRequest.options" text="options"/> | securitySolution | - |
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | encryptedSavedObjects, actions, data, ml, logstash, securitySolution, cloudChat | - | | <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | encryptedSavedObjects, actions, data, ml, logstash, securitySolution, cloudChat | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsClientContract" text="SavedObjectsClientContract"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser, @kbn/core-saved-objects-browser-internal, dataViews, home, savedObjects, savedSearch, visualizations, dashboard, lens, ml, canvas, graph, securitySolution, synthetics, watcher, visTypeTimeseries, @kbn/core-saved-objects-browser-mocks | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract" text="SavedObjectsClientContract"/> | @kbn/core-saved-objects-browser, @kbn/core-saved-objects-browser-internal, @kbn/core, dataViews, home, savedObjects, savedSearch, visualizations, dashboard, lens, ml, canvas, graph, securitySolution, synthetics, watcher, visTypeTimeseries, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsClientContract.find" text="find"/> | @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, presentationUtil, savedSearch, visualizations, dashboard, lens, savedObjectsFinder, cases, maps, ml, infra, cloudSecurityPosture, dashboardEnhanced, graph, securitySolution, synthetics, @kbn/core-saved-objects-browser-internal | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.find" text="find"/> | @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, presentationUtil, savedSearch, visualizations, dashboard, lens, savedObjectsFinder, cases, maps, ml, infra, cloudSecurityPosture, dashboardEnhanced, graph, securitySolution, synthetics, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibCorePluginApi" section="def-public.SimpleSavedObject" text="SimpleSavedObject"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, dataViews, savedObjects, embeddable, presentationUtil, visualizations, dashboard, lens, savedObjectsFinder, aiops, ml, cases, maps, dataVisualizer, infra, fleet, cloudSecurityPosture, dashboardEnhanced, graph, synthetics, securitySolution, @kbn/core-saved-objects-browser-mocks | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SimpleSavedObject" text="SimpleSavedObject"/> | @kbn/core-saved-objects-browser-internal, @kbn/core, dataViews, savedObjects, embeddable, presentationUtil, visualizations, dashboard, lens, savedObjectsFinder, aiops, ml, cases, maps, dataVisualizer, infra, fleet, cloudSecurityPosture, dashboardEnhanced, graph, synthetics, securitySolution, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_TRUSTED_APPS_LIST_ID" text="ENDPOINT_TRUSTED_APPS_LIST_ID"/> | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - | | <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_TRUSTED_APPS_LIST_ID" text="ENDPOINT_TRUSTED_APPS_LIST_ID"/> | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - |
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_TRUSTED_APPS_LIST_NAME" text="ENDPOINT_TRUSTED_APPS_LIST_NAME"/> | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - | | <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_TRUSTED_APPS_LIST_NAME" text="ENDPOINT_TRUSTED_APPS_LIST_NAME"/> | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - |
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_TRUSTED_APPS_LIST_DESCRIPTION" text="ENDPOINT_TRUSTED_APPS_LIST_DESCRIPTION"/> | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - | | <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_TRUSTED_APPS_LIST_DESCRIPTION" text="ENDPOINT_TRUSTED_APPS_LIST_DESCRIPTION"/> | lists, securitySolution, @kbn/securitysolution-io-ts-list-types | - |
@ -59,42 +51,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_ID" text="ENDPOINT_BLOCKLISTS_LIST_ID"/> | securitySolution | - | | <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_ID" text="ENDPOINT_BLOCKLISTS_LIST_ID"/> | securitySolution | - |
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_NAME" text="ENDPOINT_BLOCKLISTS_LIST_NAME"/> | securitySolution | - | | <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_NAME" text="ENDPOINT_BLOCKLISTS_LIST_NAME"/> | securitySolution | - |
| <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION" text="ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION"/> | securitySolution | - | | <DocLink id="kibKbnSecuritysolutionListConstantsPluginApi" section="def-common.ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION" text="ENDPOINT_BLOCKLISTS_LIST_DESCRIPTION"/> | securitySolution | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract" text="SavedObjectsClientContract"/> | @kbn/core-saved-objects-browser, @kbn/core-saved-objects-browser-internal, core, dataViews, home, savedObjects, savedSearch, visualizations, dashboard, lens, ml, canvas, graph, securitySolution, synthetics, watcher, visTypeTimeseries, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.find" text="find"/> | @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, presentationUtil, savedSearch, visualizations, dashboard, lens, savedObjectsFinder, cases, maps, ml, infra, cloudSecurityPosture, dashboardEnhanced, graph, securitySolution, synthetics, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SimpleSavedObject" text="SimpleSavedObject"/> | @kbn/core-saved-objects-browser-internal, core, dataViews, savedObjects, embeddable, presentationUtil, visualizations, dashboard, lens, savedObjectsFinder, aiops, ml, cases, maps, dataVisualizer, infra, fleet, cloudSecurityPosture, dashboardEnhanced, graph, synthetics, securitySolution, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | dashboard, dataVisualizer, stackAlerts, expressionPartitionVis | - | | <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | dashboard, dataVisualizer, stackAlerts, expressionPartitionVis | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsClientContract.get" text="get"/> | @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, visualizations, dashboard, ml, infra, cloudSecurityPosture, dashboardEnhanced, monitoring, synthetics, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.get" text="get"/> | @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, visualizations, dashboard, ml, infra, cloudSecurityPosture, dashboardEnhanced, monitoring, synthetics, @kbn/core-saved-objects-browser-internal | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.get" text="get"/> | @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, visualizations, dashboard, ml, infra, cloudSecurityPosture, dashboardEnhanced, monitoring, synthetics, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttribute" text="SavedObjectAttribute"/> | @kbn/core-saved-objects-common, advancedSettings, triggersActionsUi, visualizations | - | | <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-api-server, @kbn/core, savedObjects, savedObjectsManagement, visualizations, savedObjectsTagging, lens, fleet, graph, dashboard, savedObjectsTaggingOss, kibanaUtils, expressions, dataViews, data, embeddable, controls, uiActionsEnhanced, maps, canvas, cases, dashboardEnhanced, globalSearchProviders, infra | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributes" text="SavedObjectAttributes"/> | @kbn/core-saved-objects-common, savedObjects, embeddable, visualizations, dashboard, fleet, infra, canvas, graph, ml | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectAttributeSingle" text="SavedObjectAttributeSingle"/> | @kbn/core-saved-objects-common | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectReference" text="SavedObjectReference"/> | @kbn/core-saved-objects-common, @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-api-server, savedObjects, savedObjectsManagement, visualizations, savedObjectsTagging, lens, fleet, graph, dashboard, savedObjectsTaggingOss, kibanaUtils, expressions, dataViews, data, embeddable, controls, uiActionsEnhanced, maps, canvas, cases, dashboardEnhanced, globalSearchProviders, infra | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsCreateOptions" text="SavedObjectsCreateOptions"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, dataViews, savedObjects, visualizations, infra | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsDeleteOptions" text="SavedObjectsDeleteOptions"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsBatchResponse" text="SavedObjectsBatchResponse"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, infra | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsFindOptions" text="SavedObjectsFindOptions"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, visualizations, cloudSecurityPosture | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsUpdateOptions" text="SavedObjectsUpdateOptions"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, dataViews | - |
| <DocLink id="kibCorePluginApi" section="def-public.ResolvedSimpleSavedObject" text="ResolvedSimpleSavedObject"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, spaces, savedSearch, visualizations, dashboard, lens, cases, maps, fleet, canvas, graph | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsBulkUpdateObject" text="SavedObjectsBulkUpdateObject"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsFindResponse" text="SavedObjectsFindResponse"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal, osquery | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsBulkCreateOptions" text="SavedObjectsBulkCreateOptions"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsBulkUpdateOptions" text="SavedObjectsBulkUpdateOptions"/> | @kbn/core-saved-objects-api-browser | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsBulkResolveResponse" text="SavedObjectsBulkResolveResponse"/> | @kbn/core-saved-objects-api-browser | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsBulkCreateObject" text="SavedObjectsBulkCreateObject"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectReference" text="SavedObjectReference"/> | @kbn/core-saved-objects-api-browser, @kbn/core-saved-objects-api-server, core, savedObjects, savedObjectsManagement, visualizations, savedObjectsTagging, lens, fleet, graph, dashboard, savedObjectsTaggingOss, kibanaUtils, expressions, dataViews, data, embeddable, controls, uiActionsEnhanced, maps, canvas, cases, dashboardEnhanced, globalSearchProviders, infra | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsStart" text="SavedObjectsStart"/> | @kbn/core-saved-objects-browser, @kbn/core-lifecycle-browser, @kbn/core-saved-objects-browser-internal, savedObjects, savedSearch, visualizations, dashboard, lens, savedObjectsFinder, observability, canvas, transform, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsClientContract.create" text="create"/> | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, savedSearch, visualizations, dashboard, lens, maps, infra, graph, synthetics | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsClientContract.bulkCreate" text="bulkCreate"/> | @kbn/core-saved-objects-browser-mocks, home, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsClientContract.delete" text="delete"/> | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, visualizations, dashboard, maps, infra, graph | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsClientContract.bulkDelete" text="bulkDelete"/> | @kbn/core-saved-objects-browser-mocks, synthetics, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsClientContract.bulkGet" text="bulkGet"/> | @kbn/core-saved-objects-browser-mocks, dashboard, savedObjects, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsClientContract.resolve" text="resolve"/> | @kbn/core-saved-objects-browser-mocks, dataViews, savedSearch, visualizations, dashboard, lens, maps, graph, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsClientContract.bulkResolve" text="bulkResolve"/> | @kbn/core-saved-objects-browser-mocks, fleet, synthetics, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsClientContract.update" text="update"/> | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, dataViews, savedSearch, maps, infra, savedObjects | - |
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsClientContract.bulkUpdate" text="bulkUpdate"/> | @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibCorePluginApi" section="def-public.SimpleSavedObject.save" text="save"/> | @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibCorePluginApi" section="def-public.SimpleSavedObject.delete" text="delete"/> | @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsStart" text="SavedObjectsStart"/> | @kbn/core-saved-objects-browser, @kbn/core-lifecycle-browser, @kbn/core-saved-objects-browser-internal, savedObjects, savedSearch, visualizations, dashboard, lens, savedObjectsFinder, observability, canvas, transform, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.create" text="create"/> | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, savedSearch, visualizations, dashboard, lens, maps, infra, graph, synthetics | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.create" text="create"/> | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, savedSearch, visualizations, dashboard, lens, maps, infra, graph, synthetics | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.bulkCreate" text="bulkCreate"/> | @kbn/core-saved-objects-browser-mocks, home, @kbn/core-saved-objects-browser-internal | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.bulkCreate" text="bulkCreate"/> | @kbn/core-saved-objects-browser-mocks, home, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.delete" text="delete"/> | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, visualizations, dashboard, maps, infra, graph | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.delete" text="delete"/> | @kbn/core-saved-objects-browser-internal, @kbn/core-saved-objects-browser-mocks, dataViews, savedObjects, visualizations, dashboard, maps, infra, graph | - |
@ -106,24 +65,24 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.bulkUpdate" text="bulkUpdate"/> | @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-browser-internal | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsClientContract.bulkUpdate" text="bulkUpdate"/> | @kbn/core-saved-objects-browser-mocks, @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SimpleSavedObject.save" text="save"/> | @kbn/core-saved-objects-browser-internal | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SimpleSavedObject.save" text="save"/> | @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SimpleSavedObject.delete" text="delete"/> | @kbn/core-saved-objects-browser-internal | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SimpleSavedObject.delete" text="delete"/> | @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsCreateOptions" text="SavedObjectsCreateOptions"/> | @kbn/core-saved-objects-browser-internal, core, dataViews, savedObjects, visualizations, infra | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsCreateOptions" text="SavedObjectsCreateOptions"/> | @kbn/core-saved-objects-browser-internal, @kbn/core, dataViews, savedObjects, visualizations, infra | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsDeleteOptions" text="SavedObjectsDeleteOptions"/> | @kbn/core-saved-objects-browser-internal, core | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsDeleteOptions" text="SavedObjectsDeleteOptions"/> | @kbn/core-saved-objects-browser-internal, @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBatchResponse" text="SavedObjectsBatchResponse"/> | @kbn/core-saved-objects-browser-internal, core, infra | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBatchResponse" text="SavedObjectsBatchResponse"/> | @kbn/core-saved-objects-browser-internal, @kbn/core, infra | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsFindOptions" text="SavedObjectsFindOptions"/> | @kbn/core-saved-objects-browser-internal, core, visualizations, cloudSecurityPosture | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsFindOptions" text="SavedObjectsFindOptions"/> | @kbn/core-saved-objects-browser-internal, @kbn/core, visualizations, cloudSecurityPosture | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsUpdateOptions" text="SavedObjectsUpdateOptions"/> | @kbn/core-saved-objects-browser-internal, core, dataViews | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsUpdateOptions" text="SavedObjectsUpdateOptions"/> | @kbn/core-saved-objects-browser-internal, @kbn/core, dataViews | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.ResolvedSimpleSavedObject" text="ResolvedSimpleSavedObject"/> | @kbn/core-saved-objects-browser-internal, core, spaces, savedSearch, visualizations, dashboard, lens, cases, maps, fleet, canvas, graph | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.ResolvedSimpleSavedObject" text="ResolvedSimpleSavedObject"/> | @kbn/core-saved-objects-browser-internal, @kbn/core, spaces, savedSearch, visualizations, dashboard, lens, cases, maps, fleet, canvas, graph | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkUpdateObject" text="SavedObjectsBulkUpdateObject"/> | @kbn/core-saved-objects-browser-internal, core | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkUpdateObject" text="SavedObjectsBulkUpdateObject"/> | @kbn/core-saved-objects-browser-internal, @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsFindResponse" text="SavedObjectsFindResponse"/> | @kbn/core-saved-objects-browser-internal, core, osquery | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsFindResponse" text="SavedObjectsFindResponse"/> | @kbn/core-saved-objects-browser-internal, @kbn/core, osquery | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkCreateOptions" text="SavedObjectsBulkCreateOptions"/> | @kbn/core-saved-objects-browser-internal, core | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkCreateOptions" text="SavedObjectsBulkCreateOptions"/> | @kbn/core-saved-objects-browser-internal, @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkCreateObject" text="SavedObjectsBulkCreateObject"/> | @kbn/core-saved-objects-browser-internal, core | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkCreateObject" text="SavedObjectsBulkCreateObject"/> | @kbn/core-saved-objects-browser-internal, @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkDeleteResponse" text="SavedObjectsBulkDeleteResponse"/> | @kbn/core-saved-objects-browser-internal | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkDeleteResponse" text="SavedObjectsBulkDeleteResponse"/> | @kbn/core-saved-objects-browser-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsBrowserPluginApi" section="def-common.SavedObjectsStart" text="SavedObjectsStart"/> | @kbn/core-lifecycle-browser, @kbn/core-saved-objects-browser-internal, core, savedObjects, savedSearch, visualizations, dashboard, lens, savedObjectsFinder, observability, canvas, transform, @kbn/core-saved-objects-browser-mocks | - | | <DocLink id="kibKbnCoreSavedObjectsBrowserPluginApi" section="def-common.SavedObjectsStart" text="SavedObjectsStart"/> | @kbn/core-lifecycle-browser, @kbn/core-saved-objects-browser-internal, @kbn/core, savedObjects, savedSearch, visualizations, dashboard, lens, savedObjectsFinder, observability, canvas, transform, @kbn/core-saved-objects-browser-mocks | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkUpdateOptions" text="SavedObjectsBulkUpdateOptions"/> | core | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkUpdateOptions" text="SavedObjectsBulkUpdateOptions"/> | @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkResolveResponse" text="SavedObjectsBulkResolveResponse"/> | core | - | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkResolveResponse" text="SavedObjectsBulkResolveResponse"/> | @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsBrowserMocksPluginApi" section="def-common.savedObjectsServiceMock" text="savedObjectsServiceMock"/> | @kbn/core-lifecycle-browser-mocks, core, ml, dashboard, dataViews, savedSearch, @kbn/core-plugins-browser-internal | - | | <DocLink id="kibKbnCoreSavedObjectsBrowserMocksPluginApi" section="def-common.savedObjectsServiceMock" text="savedObjectsServiceMock"/> | @kbn/core-lifecycle-browser-mocks, @kbn/core, ml, dashboard, dataViews, savedSearch, @kbn/core-plugins-browser-internal | - |
| <DocLink id="kibKbnCoreSavedObjectsBrowserMocksPluginApi" section="def-common.simpleSavedObjectMock" text="simpleSavedObjectMock"/> | core, lens, savedObjects, visualizations | - | | <DocLink id="kibKbnCoreSavedObjectsBrowserMocksPluginApi" section="def-common.simpleSavedObjectMock" text="simpleSavedObjectMock"/> | @kbn/core, lens, savedObjects, visualizations | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributeSingle" text="SavedObjectAttributeSingle"/> | core | - | | <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttributeSingle" text="SavedObjectAttributeSingle"/> | @kbn/core | - |
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttribute" text="SavedObjectAttribute"/> | core, advancedSettings, triggersActionsUi, visualizations | - | | <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectAttribute" text="SavedObjectAttribute"/> | @kbn/core, advancedSettings, triggersActionsUi, visualizations | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaPageTemplate" text="KibanaPageTemplate"/> | home, canvas, osquery | - | | <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaPageTemplate" text="KibanaPageTemplate"/> | home, canvas, osquery | - |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.RedirectAppLinks" text="RedirectAppLinks"/> | home, data, esUiShared, spaces, savedObjectsManagement, fleet, observability, ml, apm, indexLifecycleManagement, synthetics, upgradeAssistant, ux, kibanaOverview | - | | <DocLink id="kibKibanaReactPluginApi" section="def-public.RedirectAppLinks" text="RedirectAppLinks"/> | home, data, esUiShared, spaces, savedObjectsManagement, fleet, observability, ml, apm, indexLifecycleManagement, synthetics, upgradeAssistant, ux, kibanaOverview | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.flattenHit" text="flattenHit"/> | dataViews, maps | - | | <DocLink id="kibDataPluginApi" section="def-common.DataView.flattenHit" text="flattenHit"/> | dataViews, maps | - |
@ -147,8 +106,6 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibExpressionsPluginApi" section="def-common.ExpressionsServiceSetup.getTypes" text="getTypes"/> | canvas | - | | <DocLink id="kibExpressionsPluginApi" section="def-common.ExpressionsServiceSetup.getTypes" text="getTypes"/> | canvas | - |
| <DocLink id="kibExpressionsPluginApi" section="def-server.ExpressionFunctionDefinition.context" text="context"/> | canvas | - | | <DocLink id="kibExpressionsPluginApi" section="def-server.ExpressionFunctionDefinition.context" text="context"/> | canvas | - |
| <DocLink id="kibKbnCoreSavedObjectsBrowserInternalPluginApi" section="def-common.SavedObjectsService" text="SavedObjectsService"/> | @kbn/core-root-browser-internal, @kbn/core-saved-objects-browser-mocks | - | | <DocLink id="kibKbnCoreSavedObjectsBrowserInternalPluginApi" section="def-common.SavedObjectsService" text="SavedObjectsService"/> | @kbn/core-root-browser-internal, @kbn/core-saved-objects-browser-mocks | - |
| <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="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | spaces, savedObjectsManagement | - | | <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | spaces, savedObjectsManagement | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, dataViewManagement | - | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.getNonScriptedFields" text="getNonScriptedFields"/> | visTypeTimeseries, graph, dataViewManagement | - |
| <DocLink id="kibDataViewsPluginApi" section="def-server.getFieldByName" text="getFieldByName"/> | unifiedSearch | - | | <DocLink id="kibDataViewsPluginApi" section="def-server.getFieldByName" text="getFieldByName"/> | unifiedSearch | - |
@ -156,30 +113,27 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.flattenHit" text="flattenHit"/> | maps | - | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.flattenHit" text="flattenHit"/> | maps | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.removeScriptedField" text="removeScriptedField"/> | dataViewManagement | - | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.removeScriptedField" text="removeScriptedField"/> | dataViewManagement | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.getScriptedFields" text="getScriptedFields"/> | dataViewManagement | - | | <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.getScriptedFields" text="getScriptedFields"/> | dataViewManagement | - |
| <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="kibSecurityPluginApi" section="def-public.SecurityPluginStart.uiApi" text="uiApi"/> | enterpriseSearch | - | | <DocLink id="kibSecurityPluginApi" section="def-public.SecurityPluginStart.uiApi" text="uiApi"/> | enterpriseSearch | - |
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion" text="convertToMultiNamespaceTypeVersion"/> | encryptedSavedObjects | - |
| <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion" text="convertToMultiNamespaceTypeVersion"/> | encryptedSavedObjects | - | | <DocLink id="kibKbnCoreSavedObjectsServerPluginApi" section="def-common.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion" text="convertToMultiNamespaceTypeVersion"/> | encryptedSavedObjects | - |
| <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | @kbn/core-elasticsearch-server-internal, @kbn/core-plugins-server-internal, console | - |
| <DocLink id="kibKbnCoreElasticsearchServerPluginApi" section="def-common.ElasticsearchServiceSetup.legacy" text="legacy"/> | @kbn/core-elasticsearch-server-internal, @kbn/core-plugins-server-internal, console | - | | <DocLink id="kibKbnCoreElasticsearchServerPluginApi" section="def-common.ElasticsearchServiceSetup.legacy" text="legacy"/> | @kbn/core-elasticsearch-server-internal, @kbn/core-plugins-server-internal, console | - |
| <DocLink id="kibCorePluginApi" section="def-server.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> | @kbn/core-plugins-server-internal | - |
| <DocLink id="kibKbnCorePluginsServerPluginApi" section="def-common.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> | @kbn/core-plugins-server-internal | - | | <DocLink id="kibKbnCorePluginsServerPluginApi" section="def-common.PluginManifest.extraPublicDirs" text="extraPublicDirs"/> | @kbn/core-plugins-server-internal | - |
| <DocLink id="kibKbnImportResolverPluginApi" section="def-common.ImportResolver.isBazelPackage" text="isBazelPackage"/> | @kbn/repo-source-classifier, @kbn/eslint-plugin-imports, @kbn/find-used-node-modules | - |
| <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getKibanaFeatures" text="getKibanaFeatures"/> | spaces, security, alerting | 8.8.0 | | <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getKibanaFeatures" text="getKibanaFeatures"/> | spaces, security, alerting | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, securitySolution, snapshotRestore, transform, upgradeAssistant | 8.8.0 | | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, securitySolution, snapshotRestore, transform, upgradeAssistant | 8.8.0 |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | embeddable, presentationUtil, dashboard, discover, graph | 8.8.0 | | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | embeddable, presentationUtil, dashboard, discover, graph | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | apm, security, securitySolution | 8.8.0 | | <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | apm, security, securitySolution | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | apm, security, securitySolution | 8.8.0 | | <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | apm, security, securitySolution | 8.8.0 |
| <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks, management, fleet, security, kibanaOverview, core | 8.8.0 | | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks, management, fleet, security, kibanaOverview, @kbn/core | 8.8.0 |
| <DocLink id="kibKbnCorePluginsServerPluginApi" section="def-common.AsyncPlugin" text="AsyncPlugin"/> | @kbn/core-plugins-server-internal, core | 8.8.0 | | <DocLink id="kibKbnCorePluginsServerPluginApi" section="def-common.AsyncPlugin" text="AsyncPlugin"/> | @kbn/core-plugins-server-internal, @kbn/core | 8.8.0 |
| <DocLink id="kibFeaturesPluginApi" section="def-public.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 | | <DocLink id="kibFeaturesPluginApi" section="def-public.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 |
| <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 | | <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 |
| <DocLink id="kibFeaturesPluginApi" section="def-server.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 | | <DocLink id="kibFeaturesPluginApi" section="def-server.FeatureKibanaPrivileges.disabled" text="disabled"/> | security, fleet | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | @kbn/core-application-browser-internal, @kbn/core-application-browser-mocks, management, fleet, security, kibanaOverview | 8.8.0 |
| <DocLink id="kibHomePluginApi" section="def-public.HomePublicPluginSetup.environment" text="environment"/> | apm | 8.8.0 | | <DocLink id="kibHomePluginApi" section="def-public.HomePublicPluginSetup.environment" text="environment"/> | apm | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | security, licenseManagement, ml, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | 8.8.0 | | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | security, licenseManagement, ml, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | 8.8.0 |
| <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getElasticsearchFeatures" text="getElasticsearchFeatures"/> | security | 8.8.0 | | <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getElasticsearchFeatures" text="getElasticsearchFeatures"/> | security | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.refresh" text="refresh"/> | mapsEms | 8.8.0 | | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.refresh" text="refresh"/> | mapsEms | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-server.AsyncPlugin" text="AsyncPlugin"/> | @kbn/core-plugins-server, @kbn/core-plugins-server-internal | 8.8.0 |
| <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureElasticsearchPrivileges.requiredRoles" text="requiredRoles"/> | security | 8.8.0 | <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureElasticsearchPrivileges.requiredRoles" text="requiredRoles"/> | security | 8.8.0
This is relied on by the reporting feature, and should be removed once reporting This is relied on by the reporting feature, and should be removed once reporting
@ -217,8 +171,6 @@ Safe to remove.
| <DocLink id="kibExpressionsPluginApi" section="def-server.ExpressionFunctionParameter.strict" text="strict"/> | expressions | | <DocLink id="kibExpressionsPluginApi" section="def-server.ExpressionFunctionParameter.strict" text="strict"/> | expressions |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.ExitFullScreenButton" text="ExitFullScreenButton"/> | kibanaReact | | <DocLink id="kibKibanaReactPluginApi" section="def-public.ExitFullScreenButton" text="ExitFullScreenButton"/> | kibanaReact |
| <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaPageTemplateProps" text="KibanaPageTemplateProps"/> | kibanaReact | | <DocLink id="kibKibanaReactPluginApi" section="def-public.KibanaPageTemplateProps" text="KibanaPageTemplateProps"/> | kibanaReact |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectsStart.SavedObjectClass" text="SavedObjectClass"/> | savedObjects |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectsStart.settings" text="settings"/> | savedObjects |
| <DocLink id="kibLicensingPluginApi" section="def-public.ILicense.mode" text="mode"/> | licensing | | <DocLink id="kibLicensingPluginApi" section="def-public.ILicense.mode" text="mode"/> | licensing |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.refresh" text="refresh"/> | licensing | | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.refresh" text="refresh"/> | licensing |
| <DocLink id="kibLicensingPluginApi" section="def-server.ILicense.mode" text="mode"/> | licensing | | <DocLink id="kibLicensingPluginApi" section="def-server.ILicense.mode" text="mode"/> | licensing |
@ -226,7 +178,9 @@ Safe to remove.
| <DocLink id="kibReportingPluginApi" section="def-common.BaseParams" text="BaseParams"/> | reporting | | <DocLink id="kibReportingPluginApi" section="def-common.BaseParams" text="BaseParams"/> | reporting |
| <DocLink id="kibReportingPluginApi" section="def-common.BasePayload" text="BasePayload"/> | reporting | | <DocLink id="kibReportingPluginApi" section="def-common.BasePayload" text="BasePayload"/> | reporting |
| <DocLink id="kibReportingPluginApi" section="def-common.JobAppParamsPDF" text="JobAppParamsPDF"/> | reporting | | <DocLink id="kibReportingPluginApi" section="def-common.JobAppParamsPDF" text="JobAppParamsPDF"/> | reporting |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectsStart.SavedObjectClass" text="SavedObjectClass"/> | savedObjects |
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectsStart.settings" text="settings"/> | savedObjects |
| <DocLink id="kibTaskManagerPluginApi" section="def-server.ConcreteTaskInstance.interval" text="interval"/> | taskManager | | <DocLink id="kibTaskManagerPluginApi" section="def-server.ConcreteTaskInstance.interval" text="interval"/> | taskManager |
| <DocLink id="kibKbnStorybookPluginApi" section="def-common.StorybookConfig.config" text="config"/> | @kbn/storybook |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkDeleteOptions" text="SavedObjectsBulkDeleteOptions"/> | @kbn/core-saved-objects-api-browser | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkDeleteOptions" text="SavedObjectsBulkDeleteOptions"/> | @kbn/core-saved-objects-api-browser |
| <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkDeleteResponseItem" text="SavedObjectsBulkDeleteResponseItem"/> | @kbn/core-saved-objects-api-browser | | <DocLink id="kibKbnCoreSavedObjectsApiBrowserPluginApi" section="def-common.SavedObjectsBulkDeleteResponseItem" text="SavedObjectsBulkDeleteResponseItem"/> | @kbn/core-saved-objects-api-browser |
| <DocLink id="kibKbnStorybookPluginApi" section="def-common.StorybookConfig.config" text="config"/> | @kbn/storybook |

File diff suppressed because it is too large Load diff

View file

@ -7,12 +7,12 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
title: Deprecated APIs due to be removed, by team title: Deprecated APIs due to be removed, by team
description: Lists the teams that are referencing deprecated APIs with a remove by date. description: Lists the teams that are referencing deprecated APIs with a remove by date.
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana'] tags: ['contributor', 'dev', 'apidocs', 'kibana']
--- ---
## APM UI ## @elastic/apm-ui
| Plugin | Deprecated API | Reference location(s) | Remove By | | Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------| | --------|-------|-----------|-----------|
@ -23,36 +23,44 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
## App Services ## @elastic/appex-sharedux
| Plugin | Deprecated API | Reference location(s) | Remove By | | Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------| | --------|-------|-----------|-----------|
| embeddable | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | [attribute_service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal), [attribute_service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | savedObjectsTaggingOss | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject) | 8.8.0 |
| kibanaOverview | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath) | 8.8.0 |
## Data Discovery ## @elastic/fleet
| Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------|
| discover | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | [on_save_search.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [on_save_search.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 |
| graph | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 |
## Fleet
| Plugin | Deprecated API | Reference location(s) | Remove By | | Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------| | --------|-------|-----------|-----------|
| fleet | <DocLink id="kibFeaturesPluginApi" section="def-public.FeatureKibanaPrivileges.disabled" text="disabled"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | fleet | <DocLink id="kibFeaturesPluginApi" section="def-public.FeatureKibanaPrivileges.disabled" text="disabled"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 |
| fleet | <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureKibanaPrivileges.disabled" text="disabled"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | fleet | <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureKibanaPrivileges.disabled" text="disabled"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 |
| fleet | <DocLink id="kibFeaturesPluginApi" section="def-server.FeatureKibanaPrivileges.disabled" text="disabled"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 | | fleet | <DocLink id="kibFeaturesPluginApi" section="def-server.FeatureKibanaPrivileges.disabled" text="disabled"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/server/plugin.ts#:~:text=disabled) | 8.8.0 |
| fleet | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 |
| fleet | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 | | fleet | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/fleet/public/applications/integrations/index.tsx#:~:text=appBasePath) | 8.8.0 |
## GIS ## @elastic/kibana-core
| Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------|
| @kbn/core | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [mocks.ts](https://github.com/elastic/kibana/tree/main/src/core/public/mocks.ts#:~:text=appBasePath), [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=appBasePath), [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=appBasePath) | 8.8.0 |
| @kbn/core | <DocLink id="kibKbnCorePluginsServerPluginApi" section="def-common.AsyncPlugin" text="AsyncPlugin"/> | [index.ts](https://github.com/elastic/kibana/tree/main/src/core/server/index.ts#:~:text=AsyncPlugin), [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin), [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin) | 8.8.0 |
## @elastic/kibana-data-discovery
| Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------|
| discover | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | [on_save_search.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [on_save_search.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 |
## @elastic/kibana-gis
| Plugin | Deprecated API | Reference location(s) | Remove By | | Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------| | --------|-------|-----------|-----------|
@ -61,50 +69,19 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
## Kibana Core ## @elastic/kibana-presentation
| Plugin | Deprecated API | Reference location(s) | Remove By | | Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------| | --------|-------|-----------|-----------|
| core | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [mocks.ts](https://github.com/elastic/kibana/tree/main/src/core/public/mocks.ts#:~:text=appBasePath), [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath), [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=appBasePath), [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=appBasePath) | 8.8.0 | | dashboard | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/api/overlays/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/api/overlays/save_modal.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal), [attribute_service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal), [attribute_service.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 |
| core | <DocLink id="kibKbnCorePluginsServerPluginApi" section="def-common.AsyncPlugin" text="AsyncPlugin"/> | [index.ts](https://github.com/elastic/kibana/tree/main/src/core/server/index.ts#:~:text=AsyncPlugin), [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin), [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin) | 8.8.0 |
| savedObjectsTaggingOss | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [types.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/decorator/types.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject), [api.ts](https://github.com/elastic/kibana/tree/main/src/plugins/saved_objects_tagging_oss/public/api.ts#:~:text=SavedObject) | 8.8.0 |
| kibanaOverview | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/kibana_overview/public/application.tsx#:~:text=appBasePath), [app_container.tsx](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-internal/src/ui/app_container.tsx#:~:text=appBasePath), [application_service.mock.ts](https://github.com/elastic/kibana/tree/main/packages/core/application/core-application-browser-mocks/src/application_service.mock.ts#:~:text=appBasePath) | 8.8.0 |
| @kbn/core-plugins-server-internal | <DocLink id="kibCorePluginApi" section="def-server.AsyncPlugin" text="AsyncPlugin"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin), [plugin.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server-internal/src/plugin.ts#:~:text=AsyncPlugin), [types.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server/src/types.ts#:~:text=AsyncPlugin), [index.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server/src/index.ts#:~:text=AsyncPlugin), [index.ts](https://github.com/elastic/kibana/tree/main/packages/core/plugins/core-plugins-server/index.ts#:~:text=AsyncPlugin) | 8.8.0 |
## Kibana Presentation
| Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------|
| dashboard | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/api/overlays/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_container/embeddable/api/overlays/save_modal.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 |
| dashboard | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_actions/clone_panel_action.tsx#:~:text=SavedObject) | 8.8.0 | | dashboard | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/dashboard/public/dashboard_actions/clone_panel_action.tsx#:~:text=SavedObject) | 8.8.0 |
## Logstash ## @elastic/kibana-security
| Plugin | Deprecated API | Reference location(s) | Remove By | | Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------| | --------|-------|-----------|-----------|
| logstash | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/logstash/public/plugin.ts#:~:text=license%24) | 8.8.0 |
## Machine Learning UI
| Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------|
| ml | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 |
| ml | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/transform/server/services/license.ts#:~:text=license%24) | 8.8.0 |
## Platform Security
| Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------|
| spaces | <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getKibanaFeatures" text="getKibanaFeatures"/> | [on_post_auth_interceptor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/lib/request_interceptors/on_post_auth_interceptor.ts#:~:text=getKibanaFeatures), [spaces_usage_collector.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts#:~:text=getKibanaFeatures), [on_post_auth_interceptor.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/lib/request_interceptors/on_post_auth_interceptor.test.ts#:~:text=getKibanaFeatures), [app_authorization.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.ts#:~:text=getKibanaFeatures), [privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.ts#:~:text=getKibanaFeatures), [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getKibanaFeatures), [app_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures)+ 18 more | 8.8.0 |
| spaces | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [spaces_usage_collector.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [spaces_usage_collector.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.test.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/plugin.ts#:~:text=license%24) | 8.8.0 |
| security | <DocLink id="kibFeaturesPluginApi" section="def-public.FeatureKibanaPrivileges.disabled" text="disabled"/> | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | | security | <DocLink id="kibFeaturesPluginApi" section="def-public.FeatureKibanaPrivileges.disabled" text="disabled"/> | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 |
| security | <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureElasticsearchPrivileges.requiredRoles" text="requiredRoles"/> | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | 8.8.0 | security | <DocLink id="kibFeaturesPluginApi" section="def-common.FeatureElasticsearchPrivileges.requiredRoles" text="requiredRoles"/> | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | 8.8.0
@ -116,16 +93,53 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
This is relied on by the reporting feature, and should be removed once reporting This is relied on by the reporting feature, and should be removed once reporting
migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 | migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 |
| security | <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getKibanaFeatures" text="getKibanaFeatures"/> | [app_authorization.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.ts#:~:text=getKibanaFeatures), [privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.ts#:~:text=getKibanaFeatures), [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getKibanaFeatures), [app_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures)+ 18 more | 8.8.0 |
| security | <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getElasticsearchFeatures" text="getElasticsearchFeatures"/> | [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getElasticsearchFeatures) | 8.8.0 | | security | <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getElasticsearchFeatures" text="getElasticsearchFeatures"/> | [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getElasticsearchFeatures) | 8.8.0 |
| security | <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | | security | <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 |
| security | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/plugin.tsx#:~:text=license%24) | 8.8.0 | | security | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/plugin.tsx#:~:text=license%24) | 8.8.0 |
| security | <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 | | security | <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 |
| security | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 | | security | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/plugin.ts#:~:text=license%24), [spaces_usage_collector.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [spaces_usage_collector.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.test.ts#:~:text=license%24) | 8.8.0 |
| security | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 | | security | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 |
## Response Ops ## @elastic/kibana-visualizations
| Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------|
| graph | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 |
| graph | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | [save_modal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 |
## @elastic/logstash
| Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------|
| logstash | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/logstash/public/plugin.ts#:~:text=license%24) | 8.8.0 |
## @elastic/ml-ui
| Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------|
| ml | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/public/plugin.ts#:~:text=license%24) | 8.8.0 |
| ml | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/ml/server/plugin.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/transform/server/services/license.ts#:~:text=license%24) | 8.8.0 |
## @elastic/platform-deployment-management
| Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------|
| upgradeAssistant | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [reindex_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.ts#:~:text=license%24), [reindex_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts#:~:text=license%24), [reindex_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/index_lifecycle_management/server/services/license.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/painless_lab/server/services/license.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/searchprofiler/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/remote_clusters/server/plugin.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/rollup/server/services/license.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/snapshot_restore/server/services/license.ts#:~:text=license%24) | 8.8.0 |
| licenseManagement | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/license_management/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cross_cluster_replication/public/plugin.ts#:~:text=license%24), [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/painless_lab/public/plugin.tsx#:~:text=license%24), [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/painless_lab/public/plugin.tsx#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/searchprofiler/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/searchprofiler/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24) | 8.8.0 |
| management | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 |
## @elastic/response-ops
| Plugin | Deprecated API | Reference location(s) | Remove By | | Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------| | --------|-------|-----------|-----------|
@ -134,28 +148,10 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
## Security solution ## @elastic/security-solution
| Plugin | Deprecated API | Reference location(s) | Remove By | | Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------| | --------|-------|-----------|-----------|
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode)+ 7 more | 8.8.0 | | securitySolution | <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode)+ 7 more | 8.8.0 |
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode)+ 7 more | 8.8.0 | | securitySolution | <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [create_default_policy.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/fleet_integration/handlers/create_default_policy.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode)+ 7 more | 8.8.0 |
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/signals/executors/query.ts#:~:text=license%24) | 8.8.0 | | securitySolution | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security_solution/server/lib/detection_engine/signals/executors/query.ts#:~:text=license%24) | 8.8.0 |
## Stack Management
| Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------|
| upgradeAssistant | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [reindex_service.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.ts#:~:text=license%24), [reindex_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts#:~:text=license%24), [reindex_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/upgrade_assistant/server/lib/reindexing/reindex_service.test.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/index_lifecycle_management/server/services/license.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/painless_lab/server/services/license.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/searchprofiler/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/remote_clusters/server/plugin.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/rollup/server/services/license.ts#:~:text=license%24), [license.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/snapshot_restore/server/services/license.ts#:~:text=license%24) | 8.8.0 |
| licenseManagement | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/license_management/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/cross_cluster_replication/public/plugin.ts#:~:text=license%24), [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/painless_lab/public/plugin.tsx#:~:text=license%24), [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/painless_lab/public/plugin.tsx#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/searchprofiler/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/searchprofiler/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/watcher/public/plugin.ts#:~:text=license%24) | 8.8.0 |
## Vis Editors
| Plugin | Deprecated API | Reference location(s) | Remove By |
| --------|-------|-----------|-----------|
| management | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 |
| management | <DocLink id="kibKbnCoreApplicationBrowserPluginApi" section="def-common.AppMountParameters.appBasePath" text="appBasePath"/> | [application.tsx](https://github.com/elastic/kibana/tree/main/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 |

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/devTools
title: "devTools" title: "devTools"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the devTools plugin description: API docs for the devTools plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
--- ---
import devToolsObj from './dev_tools.devdocs.json'; import devToolsObj from './dev_tools.devdocs.json';
Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) for questions regarding this plugin. Contact [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -396,7 +396,19 @@
"section": "def-common.SearchSource", "section": "def-common.SearchSource",
"text": "SearchSource" "text": "SearchSource"
}, },
"; history: ", "; fetch: (options?: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; history: ",
"SearchRequest", "SearchRequest",
"[]; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: <K extends keyof ", "[]; setOverwriteDataViewType: (overwriteType: string | false | undefined) => void; setField: <K extends keyof ",
{ {
@ -564,19 +576,7 @@
"SearchResponse", "SearchResponse",
"<T, Record<string, ", "<T, Record<string, ",
"AggregationsAggregate", "AggregationsAggregate",
">>>>; fetch: (options?: ", ">>>>; onRequestStart: (handler: (searchSource: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSourceSearchOptions",
"text": "SearchSourceSearchOptions"
},
") => Promise<",
"SearchResponse",
"<unknown, Record<string, ",
"AggregationsAggregate",
">>>; onRequestStart: (handler: (searchSource: ",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/discover
title: "discover" title: "discover"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the discover plugin description: API docs for the discover plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
--- ---
import discoverObj from './discover.devdocs.json'; import discoverObj from './discover.devdocs.json';
This plugin contains the Discover application and the saved search embeddable. This plugin contains the Discover application and the saved search embeddable.
Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin. Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -760,7 +760,7 @@
"label": "uiActions", "label": "uiActions",
"description": [], "description": [],
"signature": [ "signature": [
"{ readonly clear: () => void; readonly addTriggerAction: (triggerId: string, action: ", "{ readonly addTriggerAction: (triggerId: string, action: ",
{ {
"pluginId": "uiActions", "pluginId": "uiActions",
"scope": "public", "scope": "public",
@ -818,7 +818,7 @@
"section": "def-public.Action", "section": "def-public.Action",
"text": "Action" "text": "Action"
}, },
"<object>[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; readonly fork: () => ", "<object>[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; readonly clear: () => void; readonly fork: () => ",
{ {
"pluginId": "uiActions", "pluginId": "uiActions",
"scope": "public", "scope": "public",

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/discoverEnhanced
title: "discoverEnhanced" title: "discoverEnhanced"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the discoverEnhanced plugin description: API docs for the discoverEnhanced plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
--- ---
import discoverEnhancedObj from './discover_enhanced.devdocs.json'; import discoverEnhancedObj from './discover_enhanced.devdocs.json';
Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin. Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/ecsDataQualityDashboard
title: "ecsDataQualityDashboard" title: "ecsDataQualityDashboard"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the ecsDataQualityDashboard plugin description: API docs for the ecsDataQualityDashboard plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
--- ---
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json'; import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';
APIs used to assess the quality of data in Elasticsearch indexes APIs used to assess the quality of data in Elasticsearch indexes
Contact [Threat Hunting Investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) for questions regarding this plugin. Contact [@elastic/security-threat-hunting-investigations](https://github.com/orgs/elastic/teams/security-threat-hunting-investigations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -7910,7 +7910,7 @@
"label": "status", "label": "status",
"description": [], "description": [],
"signature": [ "signature": [
"\"loading\" | \"error\" | \"loaded\" | \"rendered\"" "\"error\" | \"loading\" | \"loaded\" | \"rendered\""
], ],
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
"deprecated": false, "deprecated": false,
@ -8030,7 +8030,7 @@
"label": "uiActions", "label": "uiActions",
"description": [], "description": [],
"signature": [ "signature": [
"{ readonly clear: () => void; readonly addTriggerAction: (triggerId: string, action: ", "{ readonly addTriggerAction: (triggerId: string, action: ",
{ {
"pluginId": "uiActions", "pluginId": "uiActions",
"scope": "public", "scope": "public",
@ -8088,7 +8088,7 @@
"section": "def-public.Action", "section": "def-public.Action",
"text": "Action" "text": "Action"
}, },
"<object>[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; readonly fork: () => ", "<object>[]>; readonly executeTriggerActions: (triggerId: string, context: object) => Promise<void>; readonly clear: () => void; readonly fork: () => ",
{ {
"pluginId": "uiActions", "pluginId": "uiActions",
"scope": "public", "scope": "public",
@ -10259,7 +10259,7 @@
"section": "def-public.EmbeddableFactory", "section": "def-public.EmbeddableFactory",
"text": "EmbeddableFactory" "text": "EmbeddableFactory"
}, },
"<I, O, E, T>, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial<Pick<", "<I, O, E, T>, \"create\" | \"type\" | \"isEditable\" | \"getDisplayName\"> & Partial<Pick<",
{ {
"pluginId": "embeddable", "pluginId": "embeddable",
"scope": "public", "scope": "public",
@ -10399,7 +10399,7 @@
"label": "EmbeddablePhase", "label": "EmbeddablePhase",
"description": [], "description": [],
"signature": [ "signature": [
"\"loading\" | \"error\" | \"loaded\" | \"rendered\"" "\"error\" | \"loading\" | \"loaded\" | \"rendered\""
], ],
"path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx", "path": "src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/embeddable
title: "embeddable" title: "embeddable"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddable plugin description: API docs for the embeddable plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
--- ---
import embeddableObj from './embeddable.devdocs.json'; import embeddableObj from './embeddable.devdocs.json';
Adds embeddables service to Kibana Adds embeddables service to Kibana
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin. Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/embeddableEnhanced
title: "embeddableEnhanced" title: "embeddableEnhanced"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddableEnhanced plugin description: API docs for the embeddableEnhanced plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
--- ---
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json'; import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';
Extends embeddable plugin with more functionality Extends embeddable plugin with more functionality
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin. Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects
title: "encryptedSavedObjects" title: "encryptedSavedObjects"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the encryptedSavedObjects plugin description: API docs for the encryptedSavedObjects plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
--- ---
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json'; import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';
This plugin provides encryption and decryption utilities for saved objects containing sensitive information. This plugin provides encryption and decryption utilities for saved objects containing sensitive information.
Contact [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) for questions regarding this plugin. Contact [@elastic/kibana-security](https://github.com/orgs/elastic/teams/kibana-security) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/enterpriseSearch
title: "enterpriseSearch" title: "enterpriseSearch"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the enterpriseSearch plugin description: API docs for the enterpriseSearch plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
--- ---
import enterpriseSearchObj from './enterprise_search.devdocs.json'; import enterpriseSearchObj from './enterprise_search.devdocs.json';
Adds dashboards for discovering and managing Enterprise Search products. Adds dashboards for discovering and managing Enterprise Search products.
Contact [Enterprise Search](https://github.com/orgs/elastic/teams/enterprise-search-frontend) for questions regarding this plugin. Contact [@elastic/enterprise-search-frontend](https://github.com/orgs/elastic/teams/enterprise-search-frontend) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -1314,7 +1314,7 @@
"label": "method", "label": "method",
"description": [], "description": [],
"signature": [ "signature": [
"\"get\" | \"post\" | \"put\" | \"delete\" | \"patch\" | \"head\"" "\"get\" | \"delete\" | \"head\" | \"post\" | \"put\" | \"patch\""
], ],
"path": "src/plugins/es_ui_shared/public/request/send_request.ts", "path": "src/plugins/es_ui_shared/public/request/send_request.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/esUiShared
title: "esUiShared" title: "esUiShared"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the esUiShared plugin description: API docs for the esUiShared plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
--- ---
import esUiSharedObj from './es_ui_shared.devdocs.json'; import esUiSharedObj from './es_ui_shared.devdocs.json';
Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) for questions regarding this plugin. Contact [@elastic/platform-deployment-management](https://github.com/orgs/elastic/teams/platform-deployment-management) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -638,7 +638,7 @@
"label": "AvailableAnnotationIcon", "label": "AvailableAnnotationIcon",
"description": [], "description": [],
"signature": [ "signature": [
"\"circle\" | \"asterisk\" | \"alert\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"triangle\"" "\"alert\" | \"circle\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"triangle\""
], ],
"path": "src/plugins/event_annotation/common/types.ts", "path": "src/plugins/event_annotation/common/types.ts",
"deprecated": false, "deprecated": false,
@ -727,15 +727,15 @@
"label": "EventAnnotationOutput", "label": "EventAnnotationOutput",
"description": [], "description": [],
"signature": [ "signature": [
"ManualEventAnnotationOutput",
" | ",
{ {
"pluginId": "eventAnnotation", "pluginId": "eventAnnotation",
"scope": "common", "scope": "common",
"docId": "kibEventAnnotationPluginApi", "docId": "kibEventAnnotationPluginApi",
"section": "def-common.QueryPointEventAnnotationOutput", "section": "def-common.QueryPointEventAnnotationOutput",
"text": "QueryPointEventAnnotationOutput" "text": "QueryPointEventAnnotationOutput"
} },
" | ",
"ManualEventAnnotationOutput"
], ],
"path": "src/plugins/event_annotation/common/types.ts", "path": "src/plugins/event_annotation/common/types.ts",
"deprecated": false, "deprecated": false,
@ -1416,7 +1416,7 @@
"label": "options", "label": "options",
"description": [], "description": [],
"signature": [ "signature": [
"(\"circle\" | \"asterisk\" | \"alert\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"triangle\")[]" "(\"alert\" | \"circle\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"triangle\")[]"
], ],
"path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts",
"deprecated": false, "deprecated": false,
@ -2583,7 +2583,7 @@
"label": "options", "label": "options",
"description": [], "description": [],
"signature": [ "signature": [
"(\"circle\" | \"asterisk\" | \"alert\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"triangle\")[]" "(\"alert\" | \"circle\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"triangle\")[]"
], ],
"path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts", "path": "src/plugins/event_annotation/common/query_point_event_annotation/index.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/eventAnnotation
title: "eventAnnotation" title: "eventAnnotation"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the eventAnnotation plugin description: API docs for the eventAnnotation plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
--- ---
import eventAnnotationObj from './event_annotation.devdocs.json'; import eventAnnotationObj from './event_annotation.devdocs.json';
The Event Annotation service contains expressions for event annotations The Event Annotation service contains expressions for event annotations
Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -1514,7 +1514,7 @@
"label": "data", "label": "data",
"description": [], "description": [],
"signature": [ "signature": [
"(Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: 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; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: string | undefined; action?: Readonly<{ name?: string | undefined; id?: string | undefined; execution?: Readonly<{ uuid?: string | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: 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; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; reason?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; kind?: string | undefined; hash?: string | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]" "(Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; description?: string | undefined; category?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ uuid?: string | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ 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; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status?: string | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: string | 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; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; code?: string | undefined; url?: string | undefined; created?: string | undefined; severity?: string | number | undefined; duration?: string | number | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]"
], ],
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"deprecated": false, "deprecated": false,
@ -1534,7 +1534,7 @@
"label": "IEvent", "label": "IEvent",
"description": [], "description": [],
"signature": [ "signature": [
"DeepPartial<DeepWriteable<Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: 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; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: string | undefined; action?: Readonly<{ name?: string | undefined; id?: string | undefined; execution?: Readonly<{ uuid?: string | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: 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; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; reason?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; kind?: string | undefined; hash?: string | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; } & {}>>> | undefined" "DeepPartial<DeepWriteable<Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; description?: string | undefined; category?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ uuid?: string | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ 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; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status?: string | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: string | 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; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; code?: string | undefined; url?: string | undefined; created?: string | undefined; severity?: string | number | undefined; duration?: string | number | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"
], ],
"path": "x-pack/plugins/event_log/generated/schemas.ts", "path": "x-pack/plugins/event_log/generated/schemas.ts",
"deprecated": false, "deprecated": false,
@ -1549,7 +1549,7 @@
"label": "IValidatedEvent", "label": "IValidatedEvent",
"description": [], "description": [],
"signature": [ "signature": [
"Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: 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; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: string | undefined; action?: Readonly<{ name?: string | undefined; id?: string | undefined; execution?: Readonly<{ uuid?: string | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ status?: string | undefined; outcome?: 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; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; reason?: string | undefined; created?: string | undefined; outcome?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; kind?: string | undefined; hash?: string | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; } & {}> | undefined" "Readonly<{ log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; message?: string | undefined; tags?: string[] | undefined; rule?: Readonly<{ id?: string | undefined; name?: string | undefined; description?: string | undefined; category?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; kibana?: Readonly<{ action?: Readonly<{ id?: string | undefined; name?: string | undefined; execution?: Readonly<{ uuid?: string | undefined; } & {}> | undefined; } & {}> | undefined; alerting?: Readonly<{ outcome?: string | undefined; summary?: Readonly<{ recovered?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; new?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; ongoing?: Readonly<{ count?: string | number | undefined; } & {}> | undefined; } & {}> | undefined; status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ 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; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; total_enrichment_duration_ms?: string | number | undefined; } & {}> | undefined; status?: string | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; flapping?: boolean | undefined; } & {}> | undefined; version?: string | 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; rel?: string | undefined; namespace?: string | undefined; type_id?: string | undefined; space_agnostic?: boolean | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; event?: Readonly<{ type?: string[] | undefined; reason?: string | undefined; action?: string | undefined; id?: string | undefined; start?: string | undefined; end?: string | undefined; category?: string[] | undefined; outcome?: string | undefined; code?: string | undefined; url?: string | undefined; created?: string | undefined; severity?: string | number | undefined; duration?: string | number | undefined; dataset?: string | undefined; hash?: string | undefined; ingested?: string | undefined; kind?: string | undefined; module?: string | undefined; original?: string | undefined; provider?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; } & {}> | undefined"
], ],
"path": "x-pack/plugins/event_log/generated/schemas.ts", "path": "x-pack/plugins/event_log/generated/schemas.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/eventLog
title: "eventLog" title: "eventLog"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the eventLog plugin description: API docs for the eventLog plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
--- ---
import eventLogObj from './event_log.devdocs.json'; import eventLogObj from './event_log.devdocs.json';
Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for questions regarding this plugin. Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressionError
title: "expressionError" title: "expressionError"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionError plugin description: API docs for the expressionError plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
--- ---
import expressionErrorObj from './expression_error.devdocs.json'; import expressionErrorObj from './expression_error.devdocs.json';
Adds 'error' renderer to expressions Adds 'error' renderer to expressions
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin. Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -702,7 +702,7 @@
"label": "ticksPosition", "label": "ticksPosition",
"description": [], "description": [],
"signature": [ "signature": [
"\"auto\" | \"hidden\" | \"bands\"" "\"hidden\" | \"auto\" | \"bands\""
], ],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -716,7 +716,7 @@
"label": "labelMajorMode", "label": "labelMajorMode",
"description": [], "description": [],
"signature": [ "signature": [
"\"none\" | \"auto\" | \"custom\"" "\"none\" | \"custom\" | \"auto\""
], ],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -831,7 +831,7 @@
"label": "shape", "label": "shape",
"description": [], "description": [],
"signature": [ "signature": [
"\"horizontalBullet\" | \"verticalBullet\" | \"arc\" | \"circle\"" "\"arc\" | \"circle\" | \"horizontalBullet\" | \"verticalBullet\""
], ],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -1112,7 +1112,7 @@
"label": "GaugeLabelMajorMode", "label": "GaugeLabelMajorMode",
"description": [], "description": [],
"signature": [ "signature": [
"\"none\" | \"auto\" | \"custom\"" "\"none\" | \"custom\" | \"auto\""
], ],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -1175,7 +1175,7 @@
"label": "GaugeShape", "label": "GaugeShape",
"description": [], "description": [],
"signature": [ "signature": [
"\"horizontalBullet\" | \"verticalBullet\" | \"arc\" | \"circle\"" "\"arc\" | \"circle\" | \"horizontalBullet\" | \"verticalBullet\""
], ],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -1190,7 +1190,7 @@
"label": "GaugeTicksPosition", "label": "GaugeTicksPosition",
"description": [], "description": [],
"signature": [ "signature": [
"\"auto\" | \"hidden\" | \"bands\"" "\"hidden\" | \"auto\" | \"bands\""
], ],
"path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_gauge/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressionGauge
title: "expressionGauge" title: "expressionGauge"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionGauge plugin description: API docs for the expressionGauge plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
--- ---
import expressionGaugeObj from './expression_gauge.devdocs.json'; import expressionGaugeObj from './expression_gauge.devdocs.json';
Expression Gauge plugin adds a `gauge` renderer and function to the expression plugin. The renderer will display the `gauge` chart. Expression Gauge plugin adds a `gauge` renderer and function to the expression plugin. The renderer will display the `gauge` chart.
Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -1657,7 +1657,7 @@
"label": "options", "label": "options",
"description": [], "description": [],
"signature": [ "signature": [
"(\"top\" | \"bottom\" | \"left\" | \"right\")[]" "(\"right\" | \"left\" | \"top\" | \"bottom\")[]"
], ],
"path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressionHeatmap
title: "expressionHeatmap" title: "expressionHeatmap"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionHeatmap plugin description: API docs for the expressionHeatmap plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
--- ---
import expressionHeatmapObj from './expression_heatmap.devdocs.json'; import expressionHeatmapObj from './expression_heatmap.devdocs.json';
Expression Heatmap plugin adds a `heatmap` renderer and function to the expression plugin. The renderer will display the `heatmap` chart. Expression Heatmap plugin adds a `heatmap` renderer and function to the expression plugin. The renderer will display the `heatmap` chart.
Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -431,7 +431,7 @@
"label": "OriginString", "label": "OriginString",
"description": [], "description": [],
"signature": [ "signature": [
"\"top\" | \"bottom\" | \"left\" | \"right\"" "\"right\" | \"left\" | \"top\" | \"bottom\""
], ],
"path": "src/plugins/expression_image/common/types/expression_renderers.ts", "path": "src/plugins/expression_image/common/types/expression_renderers.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressionImage
title: "expressionImage" title: "expressionImage"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionImage plugin description: API docs for the expressionImage plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
--- ---
import expressionImageObj from './expression_image.devdocs.json'; import expressionImageObj from './expression_image.devdocs.json';
Adds 'image' function and renderer to expressions Adds 'image' function and renderer to expressions
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin. Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis
title: "expressionLegacyMetricVis" title: "expressionLegacyMetricVis"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionLegacyMetricVis plugin description: API docs for the expressionLegacyMetricVis plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
--- ---
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json'; import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';
Adds a `metric` renderer and function to the expression plugin. The renderer will display the `legacy metric` chart. Adds a `metric` renderer and function to the expression plugin. The renderer will display the `legacy metric` chart.
Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

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

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressionMetric
title: "expressionMetric" title: "expressionMetric"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetric plugin description: API docs for the expressionMetric plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
--- ---
import expressionMetricObj from './expression_metric.devdocs.json'; import expressionMetricObj from './expression_metric.devdocs.json';
Adds 'metric' function and renderer to expressions Adds 'metric' function and renderer to expressions
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin. Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressionMetricVis
title: "expressionMetricVis" title: "expressionMetricVis"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetricVis plugin description: API docs for the expressionMetricVis plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
--- ---
import expressionMetricVisObj from './expression_metric_vis.devdocs.json'; import expressionMetricVisObj from './expression_metric_vis.devdocs.json';
Adds a `metric` renderer and function to the expression plugin. The renderer will display the `metric` chart. Adds a `metric` renderer and function to the expression plugin. The renderer will display the `metric` chart.
Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressionPartitionVis
title: "expressionPartitionVis" title: "expressionPartitionVis"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionPartitionVis plugin description: API docs for the expressionPartitionVis plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
--- ---
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json'; import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';
Expression Partition Visualization plugin adds a `partitionVis` renderer and `pieVis`, `mosaicVis`, `treemapVis`, `waffleVis` functions to the expression plugin. The renderer will display the `pie`, `waffle`, `treemap` and `mosaic` charts. Expression Partition Visualization plugin adds a `partitionVis` renderer and `pieVis`, `mosaicVis`, `treemapVis`, `waffleVis` functions to the expression plugin. The renderer will display the `pie`, `waffle`, `treemap` and `mosaic` charts.
Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -192,7 +192,7 @@
"label": "repeatImageFunction", "label": "repeatImageFunction",
"description": [], "description": [],
"signature": [ "signature": [
"() => { name: \"repeatImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: any; args: { emptyImage: { types: (\"null\" | \"string\")[]; help: any; default: null; }; image: { types: (\"null\" | \"string\")[]; help: any; default: null; }; max: { types: (\"number\" | \"null\")[]; help: any; default: number; }; size: { types: \"number\"[]; default: number; help: any; }; }; 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: any; args: { emptyImage: { types: (\"string\" | \"null\")[]; help: any; default: null; }; image: { types: (\"string\" | \"null\")[]; help: any; default: null; }; max: { types: (\"number\" | \"null\")[]; help: any; default: number; }; size: { types: \"number\"[]; default: number; help: any; }; }; 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", "path": "src/plugins/expression_repeat_image/common/expression_functions/repeat_image_function.ts",
"deprecated": false, "deprecated": false,
@ -500,7 +500,7 @@
"label": "OriginString", "label": "OriginString",
"description": [], "description": [],
"signature": [ "signature": [
"\"top\" | \"bottom\" | \"left\" | \"right\"" "\"right\" | \"left\" | \"top\" | \"bottom\""
], ],
"path": "src/plugins/expression_repeat_image/common/types/expression_renderers.ts", "path": "src/plugins/expression_repeat_image/common/types/expression_renderers.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressionRepeatImage
title: "expressionRepeatImage" title: "expressionRepeatImage"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRepeatImage plugin description: API docs for the expressionRepeatImage plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
--- ---
import expressionRepeatImageObj from './expression_repeat_image.devdocs.json'; import expressionRepeatImageObj from './expression_repeat_image.devdocs.json';
Adds 'repeatImage' function and renderer to expressions Adds 'repeatImage' function and renderer to expressions
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin. Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

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

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressionRevealImage
title: "expressionRevealImage" title: "expressionRevealImage"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRevealImage plugin description: API docs for the expressionRevealImage plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
--- ---
import expressionRevealImageObj from './expression_reveal_image.devdocs.json'; import expressionRevealImageObj from './expression_reveal_image.devdocs.json';
Adds 'revealImage' function and renderer to expressions Adds 'revealImage' function and renderer to expressions
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin. Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -635,7 +635,7 @@
"label": "strokeLinecap", "label": "strokeLinecap",
"description": [], "description": [],
"signature": [ "signature": [
"\"butt\" | \"round\" | \"square\" | \"inherit\" | undefined" "\"inherit\" | \"square\" | \"butt\" | \"round\" | undefined"
], ],
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx", "path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"deprecated": false, "deprecated": false,
@ -677,7 +677,7 @@
"label": "strokeLinejoin", "label": "strokeLinejoin",
"description": [], "description": [],
"signature": [ "signature": [
"\"round\" | \"inherit\" | \"miter\" | \"bevel\" | undefined" "\"inherit\" | \"round\" | \"miter\" | \"bevel\" | undefined"
], ],
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx", "path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
"deprecated": false, "deprecated": false,
@ -1599,7 +1599,7 @@
"label": "OriginString", "label": "OriginString",
"description": [], "description": [],
"signature": [ "signature": [
"\"top\" | \"bottom\" | \"left\" | \"right\"" "\"right\" | \"left\" | \"top\" | \"bottom\""
], ],
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts", "path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"deprecated": false, "deprecated": false,
@ -2633,7 +2633,7 @@
"label": "OriginString", "label": "OriginString",
"description": [], "description": [],
"signature": [ "signature": [
"\"top\" | \"bottom\" | \"left\" | \"right\"" "\"right\" | \"left\" | \"top\" | \"bottom\""
], ],
"path": "src/plugins/expression_shape/common/types/expression_renderers.ts", "path": "src/plugins/expression_shape/common/types/expression_renderers.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressionShape
title: "expressionShape" title: "expressionShape"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionShape plugin description: API docs for the expressionShape plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
--- ---
import expressionShapeObj from './expression_shape.devdocs.json'; import expressionShapeObj from './expression_shape.devdocs.json';
Adds 'shape' function and renderer to expressions Adds 'shape' function and renderer to expressions
Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin. Contact [@elastic/kibana-presentation](https://github.com/orgs/elastic/teams/kibana-presentation) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressionTagcloud
title: "expressionTagcloud" title: "expressionTagcloud"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionTagcloud plugin description: API docs for the expressionTagcloud plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
--- ---
import expressionTagcloudObj from './expression_tagcloud.devdocs.json'; import expressionTagcloudObj from './expression_tagcloud.devdocs.json';
Expression Tagcloud plugin adds a `tagcloud` renderer and function to the expression plugin. The renderer will display the `Wordcloud` chart. Expression Tagcloud plugin adds a `tagcloud` renderer and function to the expression plugin. The renderer will display the `Wordcloud` chart.
Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -402,7 +402,7 @@
"label": "mode", "label": "mode",
"description": [], "description": [],
"signature": [ "signature": [
"\"custom\" | \"full\" | \"dataBounds\"" "\"full\" | \"custom\" | \"dataBounds\""
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -561,7 +561,7 @@
"label": "seriesType", "label": "seriesType",
"description": [], "description": [],
"signature": [ "signature": [
"\"bar\" | \"line\" | \"area\"" "\"area\" | \"line\" | \"bar\""
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -725,7 +725,7 @@
"label": "xScaleType", "label": "xScaleType",
"description": [], "description": [],
"signature": [ "signature": [
"\"linear\" | \"time\" | \"ordinal\"" "\"time\" | \"linear\" | \"ordinal\""
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -875,7 +875,7 @@
"\nPosition of the legend relative to the chart" "\nPosition of the legend relative to the chart"
], ],
"signature": [ "signature": [
"\"top\" | \"bottom\" | \"left\" | \"right\"" "\"right\" | \"left\" | \"top\" | \"bottom\""
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -923,7 +923,7 @@
"\nHorizontal Alignment of the legend when it is set inside chart" "\nHorizontal Alignment of the legend when it is set inside chart"
], ],
"signature": [ "signature": [
"\"left\" | \"right\" | undefined" "\"right\" | \"left\" | undefined"
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -2022,7 +2022,7 @@
"label": "AvailableReferenceLineIcon", "label": "AvailableReferenceLineIcon",
"description": [], "description": [],
"signature": [ "signature": [
"\"circle\" | \"asterisk\" | \"alert\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"triangle\" | \"empty\"" "\"alert\" | \"circle\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"empty\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"starFilled\" | \"tag\" | \"triangle\""
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -2059,7 +2059,7 @@
"label": "AxisExtentMode", "label": "AxisExtentMode",
"description": [], "description": [],
"signature": [ "signature": [
"\"custom\" | \"full\" | \"dataBounds\"" "\"full\" | \"custom\" | \"dataBounds\""
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -2644,7 +2644,7 @@
"label": "FillStyle", "label": "FillStyle",
"description": [], "description": [],
"signature": [ "signature": [
"\"above\" | \"below\" | \"none\"" "\"none\" | \"above\" | \"below\""
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -2659,7 +2659,7 @@
"label": "FittingFunction", "label": "FittingFunction",
"description": [], "description": [],
"signature": [ "signature": [
"\"None\" | \"Zero\" | \"Nearest\" | \"Linear\" | \"Carry\" | \"Lookahead\" | \"Average\"" "\"None\" | \"Average\" | \"Zero\" | \"Nearest\" | \"Linear\" | \"Carry\" | \"Lookahead\""
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -2674,7 +2674,7 @@
"label": "IconPosition", "label": "IconPosition",
"description": [], "description": [],
"signature": [ "signature": [
"\"above\" | \"below\" | \"auto\" | \"left\" | \"right\"" "\"right\" | \"left\" | \"above\" | \"below\" | \"auto\""
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -2753,7 +2753,7 @@
"label": "LayerType", "label": "LayerType",
"description": [], "description": [],
"signature": [ "signature": [
"\"data\" | \"referenceLine\" | \"annotations\"" "\"data\" | \"annotations\" | \"referenceLine\""
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -3112,7 +3112,7 @@
"label": "SeriesType", "label": "SeriesType",
"description": [], "description": [],
"signature": [ "signature": [
"\"bar\" | \"line\" | \"area\"" "\"area\" | \"line\" | \"bar\""
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -3226,7 +3226,7 @@
"label": "XScaleType", "label": "XScaleType",
"description": [], "description": [],
"signature": [ "signature": [
"\"linear\" | \"time\" | \"ordinal\"" "\"time\" | \"linear\" | \"ordinal\""
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,
@ -3402,7 +3402,7 @@
"label": "YScaleType", "label": "YScaleType",
"description": [], "description": [],
"signature": [ "signature": [
"\"linear\" | \"log\" | \"time\" | \"sqrt\"" "\"log\" | \"time\" | \"sqrt\" | \"linear\""
], ],
"path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressionXY
title: "expressionXY" title: "expressionXY"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionXY plugin description: API docs for the expressionXY plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
--- ---
import expressionXYObj from './expression_x_y.devdocs.json'; import expressionXYObj from './expression_x_y.devdocs.json';
Expression XY plugin adds a `xy` renderer and function to the expression plugin. The renderer will display the `xy` chart. Expression XY plugin adds a `xy` renderer and function to the expression plugin. The renderer will display the `xy` chart.
Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -7499,7 +7499,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." "\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": [ "signature": [
"\"error\" | \"not-started\" | \"pending\" | \"result\"" "\"error\" | \"pending\" | \"not-started\" | \"result\""
], ],
"path": "src/plugins/expressions/common/execution/container.ts", "path": "src/plugins/expressions/common/execution/container.ts",
"deprecated": false, "deprecated": false,
@ -11911,7 +11911,7 @@
"\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES"
], ],
"signature": [ "signature": [
"\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"null\" | \"ip\" | \"nested\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"histogram\"" "\"string\" | \"number\" | \"boolean\" | \"object\" | \"nested\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"date\" | \"murmur3\" | \"histogram\" | \"unknown\" | \"_source\" | \"attachment\" | \"conflict\" | \"null\""
], ],
"path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts",
"deprecated": false, "deprecated": false,
@ -12556,7 +12556,7 @@
"\nAllowed column names in a PointSeries" "\nAllowed column names in a PointSeries"
], ],
"signature": [ "signature": [
"\"color\" | \"size\" | \"text\" | \"y\" | \"x\"" "\"text\" | \"color\" | \"x\" | \"y\" | \"size\""
], ],
"path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts",
"deprecated": false, "deprecated": false,
@ -12818,7 +12818,7 @@
"\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date" "\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date"
], ],
"signature": [ "signature": [
"\"date\" | \"filter\"" "\"filter\" | \"date\""
], ],
"path": "src/plugins/expressions/common/types/common.ts", "path": "src/plugins/expressions/common/types/common.ts",
"deprecated": false, "deprecated": false,
@ -18892,7 +18892,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." "\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": [ "signature": [
"\"error\" | \"not-started\" | \"pending\" | \"result\"" "\"error\" | \"pending\" | \"not-started\" | \"result\""
], ],
"path": "src/plugins/expressions/common/execution/container.ts", "path": "src/plugins/expressions/common/execution/container.ts",
"deprecated": false, "deprecated": false,
@ -21805,7 +21805,7 @@
"\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES"
], ],
"signature": [ "signature": [
"\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"null\" | \"ip\" | \"nested\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"histogram\"" "\"string\" | \"number\" | \"boolean\" | \"object\" | \"nested\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"date\" | \"murmur3\" | \"histogram\" | \"unknown\" | \"_source\" | \"attachment\" | \"conflict\" | \"null\""
], ],
"path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts",
"deprecated": false, "deprecated": false,
@ -22374,7 +22374,7 @@
"\nAllowed column names in a PointSeries" "\nAllowed column names in a PointSeries"
], ],
"signature": [ "signature": [
"\"color\" | \"size\" | \"text\" | \"y\" | \"x\"" "\"text\" | \"color\" | \"x\" | \"y\" | \"size\""
], ],
"path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts",
"deprecated": false, "deprecated": false,
@ -22605,7 +22605,7 @@
"\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date" "\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date"
], ],
"signature": [ "signature": [
"\"date\" | \"filter\"" "\"filter\" | \"date\""
], ],
"path": "src/plugins/expressions/common/types/common.ts", "path": "src/plugins/expressions/common/types/common.ts",
"deprecated": false, "deprecated": false,
@ -30216,7 +30216,7 @@
"label": "type", "label": "type",
"description": [], "description": [],
"signature": [ "signature": [
"\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"null\" | \"ip\" | \"nested\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"histogram\"" "\"string\" | \"number\" | \"boolean\" | \"object\" | \"nested\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"date\" | \"murmur3\" | \"histogram\" | \"unknown\" | \"_source\" | \"attachment\" | \"conflict\" | \"null\""
], ],
"path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts",
"deprecated": false, "deprecated": false,
@ -31189,7 +31189,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." "\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": [ "signature": [
"\"error\" | \"not-started\" | \"pending\" | \"result\"" "\"error\" | \"pending\" | \"not-started\" | \"result\""
], ],
"path": "src/plugins/expressions/common/execution/container.ts", "path": "src/plugins/expressions/common/execution/container.ts",
"deprecated": false, "deprecated": false,
@ -36498,7 +36498,7 @@
"\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES" "\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES"
], ],
"signature": [ "signature": [
"\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"null\" | \"ip\" | \"nested\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"histogram\"" "\"string\" | \"number\" | \"boolean\" | \"object\" | \"nested\" | \"geo_point\" | \"geo_shape\" | \"ip\" | \"date\" | \"murmur3\" | \"histogram\" | \"unknown\" | \"_source\" | \"attachment\" | \"conflict\" | \"null\""
], ],
"path": "src/plugins/expressions/common/expression_types/specs/datatable.ts", "path": "src/plugins/expressions/common/expression_types/specs/datatable.ts",
"deprecated": false, "deprecated": false,
@ -37696,7 +37696,7 @@
"label": "MathArguments", "label": "MathArguments",
"description": [], "description": [],
"signature": [ "signature": [
"{ expression: string; onError?: \"null\" | \"zero\" | \"false\" | \"throw\" | undefined; }" "{ expression: string; onError?: \"false\" | \"null\" | \"zero\" | \"throw\" | undefined; }"
], ],
"path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "path": "src/plugins/expressions/common/expression_functions/specs/math.ts",
"deprecated": false, "deprecated": false,
@ -37790,7 +37790,7 @@
"\nAllowed column names in a PointSeries" "\nAllowed column names in a PointSeries"
], ],
"signature": [ "signature": [
"\"color\" | \"size\" | \"text\" | \"y\" | \"x\"" "\"text\" | \"color\" | \"x\" | \"y\" | \"size\""
], ],
"path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts",
"deprecated": false, "deprecated": false,
@ -37922,7 +37922,7 @@
"\nMode of the expression render environment.\nThis value can be set from a consumer embedding an expression renderer and is accessible\nfrom within the active render function as part of the handlers.\nThe following modes are supported:\n* view (default): The chart is rendered in a container with the main purpose of viewing the chart (e.g. in a container like dashboard or canvas)\n* preview: The chart is rendered in very restricted space (below 100px width and height) and should only show a rough outline\n* edit: The chart is rendered within an editor and configuration elements within the chart should be displayed" "\nMode of the expression render environment.\nThis value can be set from a consumer embedding an expression renderer and is accessible\nfrom within the active render function as part of the handlers.\nThe following modes are supported:\n* view (default): The chart is rendered in a container with the main purpose of viewing the chart (e.g. in a container like dashboard or canvas)\n* preview: The chart is rendered in very restricted space (below 100px width and height) and should only show a rough outline\n* edit: The chart is rendered within an editor and configuration elements within the chart should be displayed"
], ],
"signature": [ "signature": [
"\"edit\" | \"preview\" | \"view\"" "\"view\" | \"edit\" | \"preview\""
], ],
"path": "src/plugins/expressions/common/expression_renderers/types.ts", "path": "src/plugins/expressions/common/expression_renderers/types.ts",
"deprecated": false, "deprecated": false,
@ -38157,7 +38157,7 @@
"\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date" "\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date"
], ],
"signature": [ "signature": [
"\"date\" | \"filter\"" "\"filter\" | \"date\""
], ],
"path": "src/plugins/expressions/common/types/common.ts", "path": "src/plugins/expressions/common/types/common.ts",
"deprecated": false, "deprecated": false,
@ -41577,7 +41577,7 @@
"label": "types", "label": "types",
"description": [], "description": [],
"signature": [ "signature": [
"(\"null\" | \"string\")[]" "(\"string\" | \"null\")[]"
], ],
"path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts",
"deprecated": false, "deprecated": false,
@ -41715,7 +41715,7 @@
"label": "types", "label": "types",
"description": [], "description": [],
"signature": [ "signature": [
"(\"number\" | \"null\" | \"boolean\" | \"string\")[]" "(\"string\" | \"boolean\" | \"number\" | \"null\")[]"
], ],
"path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts",
"deprecated": false, "deprecated": false,
@ -41798,7 +41798,7 @@
"label": "types", "label": "types",
"description": [], "description": [],
"signature": [ "signature": [
"(\"null\" | \"string\")[]" "(\"string\" | \"null\")[]"
], ],
"path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts", "path": "src/plugins/expressions/common/expression_functions/specs/map_column.ts",
"deprecated": false, "deprecated": false,
@ -42122,7 +42122,7 @@
"label": "options", "label": "options",
"description": [], "description": [],
"signature": [ "signature": [
"(\"null\" | \"zero\" | \"false\" | \"throw\")[]" "(\"false\" | \"null\" | \"zero\" | \"throw\")[]"
], ],
"path": "src/plugins/expressions/common/expression_functions/specs/math.ts", "path": "src/plugins/expressions/common/expression_functions/specs/math.ts",
"deprecated": false, "deprecated": false,
@ -42528,7 +42528,7 @@
"label": "types", "label": "types",
"description": [], "description": [],
"signature": [ "signature": [
"(\"null\" | \"string\")[]" "(\"string\" | \"null\")[]"
], ],
"path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts", "path": "src/plugins/expressions/common/expression_functions/specs/math_column.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/expressions
title: "expressions" title: "expressions"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the expressions plugin description: API docs for the expressions plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
--- ---
import expressionsObj from './expressions.devdocs.json'; import expressionsObj from './expressions.devdocs.json';
Adds expression runtime to Kibana Adds expression runtime to Kibana
Contact [Visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin. Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/kibana-visualizations) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -64,7 +64,7 @@
"section": "def-common.SubFeaturePrivilegeGroupType", "section": "def-common.SubFeaturePrivilegeGroupType",
"text": "SubFeaturePrivilegeGroupType" "text": "SubFeaturePrivilegeGroupType"
}, },
"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; disabled?: boolean | undefined; ui: readonly string[]; app?: readonly string[] | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>"
], ],
"path": "x-pack/plugins/features/common/kibana_feature.ts", "path": "x-pack/plugins/features/common/kibana_feature.ts",
"deprecated": false, "deprecated": false,
@ -1317,7 +1317,7 @@
"section": "def-common.SubFeaturePrivilegeGroupType", "section": "def-common.SubFeaturePrivilegeGroupType",
"text": "SubFeaturePrivilegeGroupType" "text": "SubFeaturePrivilegeGroupType"
}, },
"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; disabled?: boolean | undefined; ui: readonly string[]; app?: readonly string[] | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>"
], ],
"path": "x-pack/plugins/features/common/kibana_feature.ts", "path": "x-pack/plugins/features/common/kibana_feature.ts",
"deprecated": false, "deprecated": false,
@ -3082,7 +3082,7 @@
"section": "def-common.SubFeaturePrivilegeGroupType", "section": "def-common.SubFeaturePrivilegeGroupType",
"text": "SubFeaturePrivilegeGroupType" "text": "SubFeaturePrivilegeGroupType"
}, },
"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; disabled?: boolean | undefined; ui: readonly string[]; app?: readonly string[] | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>"
], ],
"path": "x-pack/plugins/features/common/kibana_feature.ts", "path": "x-pack/plugins/features/common/kibana_feature.ts",
"deprecated": false, "deprecated": false,
@ -3346,7 +3346,7 @@
"section": "def-common.SubFeaturePrivilegeGroupType", "section": "def-common.SubFeaturePrivilegeGroupType",
"text": "SubFeaturePrivilegeGroupType" "text": "SubFeaturePrivilegeGroupType"
}, },
"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }>" "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; disabled?: boolean | undefined; ui: readonly string[]; app?: readonly string[] | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }>"
], ],
"path": "x-pack/plugins/features/common/sub_feature.ts", "path": "x-pack/plugins/features/common/sub_feature.ts",
"deprecated": false, "deprecated": false,
@ -3383,7 +3383,7 @@
"section": "def-common.SubFeaturePrivilegeGroupType", "section": "def-common.SubFeaturePrivilegeGroupType",
"text": "SubFeaturePrivilegeGroupType" "text": "SubFeaturePrivilegeGroupType"
}, },
"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]" "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; disabled?: boolean | undefined; ui: readonly string[]; app?: readonly string[] | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]"
], ],
"path": "x-pack/plugins/features/common/sub_feature.ts", "path": "x-pack/plugins/features/common/sub_feature.ts",
"deprecated": false, "deprecated": false,
@ -3427,7 +3427,7 @@
"section": "def-common.SubFeaturePrivilegeGroupType", "section": "def-common.SubFeaturePrivilegeGroupType",
"text": "SubFeaturePrivilegeGroupType" "text": "SubFeaturePrivilegeGroupType"
}, },
"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }" "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; disabled?: boolean | undefined; ui: readonly string[]; app?: readonly string[] | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; description?: string | undefined; }"
], ],
"path": "x-pack/plugins/features/common/sub_feature.ts", "path": "x-pack/plugins/features/common/sub_feature.ts",
"deprecated": false, "deprecated": false,

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/features
title: "features" title: "features"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the features plugin description: API docs for the features plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
--- ---
import featuresObj from './features.devdocs.json'; import featuresObj from './features.devdocs.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin. Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -384,7 +384,7 @@
"section": "def-common.FieldFormatsRegistry", "section": "def-common.FieldFormatsRegistry",
"text": "FieldFormatsRegistry" "text": "FieldFormatsRegistry"
}, },
", \"init\" | \"register\"> & { deserialize: ", ", \"register\" | \"init\"> & { deserialize: ",
{ {
"pluginId": "fieldFormats", "pluginId": "fieldFormats",
"scope": "common", "scope": "common",
@ -6172,7 +6172,15 @@
"label": "IFieldFormatsRegistry", "label": "IFieldFormatsRegistry",
"description": [], "description": [],
"signature": [ "signature": [
"{ init: (getConfig: ", "{ has: (id: string) => boolean; register: (fieldFormats: ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FieldFormatInstanceType",
"text": "FieldFormatInstanceType"
},
"[]) => void; init: (getConfig: ",
{ {
"pluginId": "fieldFormats", "pluginId": "fieldFormats",
"scope": "common", "scope": "common",
@ -6204,7 +6212,7 @@
"section": "def-common.FieldFormatInstanceType", "section": "def-common.FieldFormatInstanceType",
"text": "FieldFormatInstanceType" "text": "FieldFormatInstanceType"
}, },
"[]) => void; has: (id: string) => boolean; deserialize: ", "[]) => void; deserialize: ",
{ {
"pluginId": "fieldFormats", "pluginId": "fieldFormats",
"scope": "common", "scope": "common",
@ -6212,15 +6220,7 @@
"section": "def-common.FormatFactory", "section": "def-common.FormatFactory",
"text": "FormatFactory" "text": "FormatFactory"
}, },
"; register: (fieldFormats: ", "; getDefaultConfig: (fieldType: ",
{
"pluginId": "fieldFormats",
"scope": "common",
"docId": "kibFieldFormatsPluginApi",
"section": "def-common.FieldFormatInstanceType",
"text": "FieldFormatInstanceType"
},
"[]) => void; getDefaultConfig: (fieldType: ",
{ {
"pluginId": "@kbn/field-types", "pluginId": "@kbn/field-types",
"scope": "common", "scope": "common",

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/fieldFormats
title: "fieldFormats" title: "fieldFormats"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the fieldFormats plugin description: API docs for the fieldFormats plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
--- ---
import fieldFormatsObj from './field_formats.devdocs.json'; import fieldFormatsObj from './field_formats.devdocs.json';
Index pattern fields and ambiguous values formatters Index pattern fields and ambiguous values formatters
Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin. Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/fileUpload
title: "fileUpload" title: "fileUpload"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the fileUpload plugin description: API docs for the fileUpload plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
--- ---
import fileUploadObj from './file_upload.devdocs.json'; import fileUploadObj from './file_upload.devdocs.json';
The file upload plugin contains components and services for uploading a file, analyzing its data, and then importing the data into an Elasticsearch index. Supported file types include CSV, TSV, newline-delimited JSON and GeoJSON. The file upload plugin contains components and services for uploading a file, analyzing its data, and then importing the data into an Elasticsearch index. Supported file types include CSV, TSV, newline-delimited JSON and GeoJSON.
Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for questions regarding this plugin. Contact [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -782,7 +782,59 @@
"\nAn elasticsearch client that will be used to interact with the cluster" "\nAn elasticsearch client that will be used to interact with the cluster"
], ],
"signature": [ "signature": [
"{ name: string | symbol; get: { <TDocument = unknown>(this: That, params: ", "{ create: { <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"WriteResponseBase",
">; <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"WriteResponseBase",
", unknown>>; <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"WriteResponseBase",
">; }; update: { <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"UpdateResponse",
"<TDocumentR>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"UpdateResponse",
"<TDocumentR>, unknown>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"UpdateResponse",
"<TDocumentR>>; }; get: { <TDocument = unknown>(this: That, params: ",
"GetRequest", "GetRequest",
" | ", " | ",
"GetRequest", "GetRequest",
@ -834,9 +886,7 @@
"TransportRequestOptions", "TransportRequestOptions",
" | undefined): Promise<", " | undefined): Promise<",
"WriteResponseBase", "WriteResponseBase",
">; }; cluster: ", ">; }; helpers: ",
"default",
"; eql: ",
"default", "default",
"; search: { <TDocument = unknown, TAggregations = Record<string, ", "; search: { <TDocument = unknown, TAggregations = Record<string, ",
"AggregationsAggregate", "AggregationsAggregate",
@ -870,98 +920,88 @@
"TransportRequestOptions", "TransportRequestOptions",
" | undefined): Promise<", " | undefined): Promise<",
"SearchResponse", "SearchResponse",
"<TDocument, TAggregations>>; }; create: { <TDocument = unknown>(this: That, params: ", "<TDocument, TAggregations>>; }; name: string | symbol; monitoring: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"WriteResponseBase",
">; <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"WriteResponseBase",
", unknown>>; <TDocument = unknown>(this: That, params: ",
"CreateRequest",
"<TDocument> | ",
"CreateRequest",
"<TDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"WriteResponseBase",
">; }; monitoring: ",
"default", "default",
"; security: ", "; count: { (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"CountResponse",
">; (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"CountResponse",
", unknown>>; (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"CountResponse",
">; }; exists: { (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<boolean>; (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<boolean, unknown>>; (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<boolean>; }; security: ",
"default", "default",
"; index: { <TDocument = unknown>(this: That, params: ", "; ping: { (this: That, params?: ",
"IndexRequest", "PingRequest",
"<TDocument> | ", " | ",
"IndexRequest", "PingRequest",
"<TDocument>, options?: ", " | undefined, options?: ",
"TransportRequestOptionsWithOutMeta", "TransportRequestOptionsWithOutMeta",
" | undefined): Promise<", " | undefined): Promise<boolean>; (this: That, params?: ",
"WriteResponseBase", "PingRequest",
">; <TDocument = unknown>(this: That, params: ", " | ",
"IndexRequest", "PingRequest",
"<TDocument> | ", " | undefined, options?: ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithMeta", "TransportRequestOptionsWithMeta",
" | undefined): Promise<", " | undefined): Promise<",
"TransportResult", "TransportResult",
"<", "<boolean, unknown>>; (this: That, params?: ",
"WriteResponseBase", "PingRequest",
", unknown>>; <TDocument = unknown>(this: That, params: ", " | ",
"IndexRequest", "PingRequest",
"<TDocument> | ", " | undefined, options?: ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptions", "TransportRequestOptions",
" | undefined): Promise<", " | undefined): Promise<boolean>; }; nodes: ",
"WriteResponseBase", "default",
">; }; update: { <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ", "; indices: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"UpdateResponse",
"<TDocumentR>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"UpdateResponse",
"<TDocumentR>, unknown>>; <TDocument = unknown, TPartialDocument = unknown, TDocumentR = unknown>(this: That, params: ",
"UpdateRequest",
"<TDocument, TPartialDocument> | ",
"UpdateRequest",
"<TDocument, TPartialDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"UpdateResponse",
"<TDocumentR>>; }; asyncSearch: ",
"default", "default",
"; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ", "; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
"default", "default",
"; helpers: ",
"default",
"; child: (opts: ", "; child: (opts: ",
"ClientOptions", "ClientOptions",
") => ", ") => ",
"default", "default",
"; asyncSearch: ",
"default",
"; autoscaling: ", "; autoscaling: ",
"default", "default",
"; bulk: { <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ", "; bulk: { <TDocument = unknown, TPartialDocument = unknown>(this: That, params: ",
@ -1046,33 +1086,9 @@
"TransportRequestOptions", "TransportRequestOptions",
" | undefined): Promise<", " | undefined): Promise<",
"ClosePointInTimeResponse", "ClosePointInTimeResponse",
">; }; count: { (this: That, params?: ", ">; }; cluster: ",
"CountRequest", "default",
" | ", "; danglingIndices: ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"CountResponse",
">; (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"CountResponse",
", unknown>>; (this: That, params?: ",
"CountRequest",
" | ",
"CountRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"CountResponse",
">; }; danglingIndices: ",
"default", "default",
"; deleteByQuery: { (this: That, params: ", "; deleteByQuery: { (this: That, params: ",
"DeleteByQueryRequest", "DeleteByQueryRequest",
@ -1154,27 +1170,9 @@
"AcknowledgedResponseBase", "AcknowledgedResponseBase",
">; }; enrich: ", ">; }; enrich: ",
"default", "default",
"; exists: { (this: That, params: ", "; eql: ",
"ExistsRequest", "default",
" | ", "; existsSource: { (this: That, params: ",
"ExistsRequest",
", options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<boolean>; (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<boolean, unknown>>; (this: That, params: ",
"ExistsRequest",
" | ",
"ExistsRequest",
", options?: ",
"TransportRequestOptions",
" | undefined): Promise<boolean>; }; existsSource: { (this: That, params: ",
"ExistsSourceRequest", "ExistsSourceRequest",
" | ", " | ",
"ExistsSourceRequest", "ExistsSourceRequest",
@ -1352,9 +1350,33 @@
"default", "default",
"; ilm: ", "; ilm: ",
"default", "default",
"; indices: ", "; index: { <TDocument = unknown>(this: That, params: ",
"default", "IndexRequest",
"; info: { (this: That, params?: ", "<TDocument> | ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<",
"WriteResponseBase",
">; <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<",
"WriteResponseBase",
", unknown>>; <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
"<TDocument>, options?: ",
"TransportRequestOptions",
" | undefined): Promise<",
"WriteResponseBase",
">; }; info: { (this: That, params?: ",
"InfoRequest", "InfoRequest",
" | ", " | ",
"InfoRequest", "InfoRequest",
@ -1532,9 +1554,7 @@
"TransportRequestOptions", "TransportRequestOptions",
" | undefined): Promise<", " | undefined): Promise<",
"MtermvectorsResponse", "MtermvectorsResponse",
">; }; nodes: ", ">; }; openPointInTime: { (this: That, params: ",
"default",
"; openPointInTime: { (this: That, params: ",
"OpenPointInTimeRequest", "OpenPointInTimeRequest",
" | ", " | ",
"OpenPointInTimeRequest", "OpenPointInTimeRequest",
@ -1560,27 +1580,7 @@
"TransportRequestOptions", "TransportRequestOptions",
" | undefined): Promise<", " | undefined): Promise<",
"OpenPointInTimeResponse", "OpenPointInTimeResponse",
">; }; ping: { (this: That, params?: ", ">; }; putScript: { (this: That, params: ",
"PingRequest",
" | ",
"PingRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithOutMeta",
" | undefined): Promise<boolean>; (this: That, params?: ",
"PingRequest",
" | ",
"PingRequest",
" | undefined, options?: ",
"TransportRequestOptionsWithMeta",
" | undefined): Promise<",
"TransportResult",
"<boolean, unknown>>; (this: That, params?: ",
"PingRequest",
" | ",
"PingRequest",
" | undefined, options?: ",
"TransportRequestOptions",
" | undefined): Promise<boolean>; }; putScript: { (this: That, params: ",
"PutScriptRequest", "PutScriptRequest",
" | ", " | ",
"PutScriptRequest", "PutScriptRequest",

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/files
title: "files" title: "files"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the files plugin description: API docs for the files plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
--- ---
import filesObj from './files.devdocs.json'; import filesObj from './files.devdocs.json';
File upload, download, sharing, and serving over HTTP implementation in Kibana. File upload, download, sharing, and serving over HTTP implementation in Kibana.
Contact [@elastic/kibana-app-services](https://github.com/orgs/elastic/teams/team:AppServicesUx) for questions regarding this plugin. Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/filesManagement
title: "filesManagement" title: "filesManagement"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the filesManagement plugin description: API docs for the filesManagement plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
--- ---
import filesManagementObj from './files_management.devdocs.json'; import filesManagementObj from './files_management.devdocs.json';
Simple UI for managing files in Kibana Simple UI for managing files in Kibana
Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/@elastic/appex-sharedux) for questions regarding this plugin. Contact [@elastic/appex-sharedux](https://github.com/orgs/elastic/teams/appex-sharedux) for questions regarding this plugin.
**Code health stats** **Code health stats**

File diff suppressed because it is too large Load diff

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/fleet
title: "fleet" title: "fleet"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the fleet plugin description: API docs for the fleet plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
--- ---
import fleetObj from './fleet.devdocs.json'; import fleetObj from './fleet.devdocs.json';
Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regarding this plugin. Contact [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/globalSearch
title: "globalSearch" title: "globalSearch"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the globalSearch plugin description: API docs for the globalSearch plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
--- ---
import globalSearchObj from './global_search.devdocs.json'; import globalSearchObj from './global_search.devdocs.json';
Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin. Contact [@elastic/kibana-core](https://github.com/orgs/elastic/teams/kibana-core) for questions regarding this plugin.
**Code health stats** **Code health stats**

View file

@ -1191,7 +1191,7 @@
"label": "GuidesConfig", "label": "GuidesConfig",
"description": [], "description": [],
"signature": [ "signature": [
"{ kubernetes: ", "{ siem: ",
{ {
"pluginId": "@kbn/guided-onboarding", "pluginId": "@kbn/guided-onboarding",
"scope": "common", "scope": "common",
@ -1199,7 +1199,7 @@
"section": "def-common.GuideConfig", "section": "def-common.GuideConfig",
"text": "GuideConfig" "text": "GuideConfig"
}, },
"; siem: ", "; kubernetes: ",
{ {
"pluginId": "@kbn/guided-onboarding", "pluginId": "@kbn/guided-onboarding",
"scope": "common", "scope": "common",

View file

@ -8,14 +8,14 @@ slug: /kibana-dev-docs/api/guidedOnboarding
title: "guidedOnboarding" title: "guidedOnboarding"
image: https://source.unsplash.com/400x175/?github image: https://source.unsplash.com/400x175/?github
description: API docs for the guidedOnboarding plugin description: API docs for the guidedOnboarding plugin
date: 2023-02-08 date: 2023-02-09
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding'] tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
--- ---
import guidedOnboardingObj from './guided_onboarding.devdocs.json'; import guidedOnboardingObj from './guided_onboarding.devdocs.json';
Guided onboarding framework Guided onboarding framework
Contact [Journey Onboarding](https://github.com/orgs/elastic/teams/platform-onboarding) for questions regarding this plugin. Contact [@elastic/platform-onboarding](https://github.com/orgs/elastic/teams/platform-onboarding) for questions regarding this plugin.
**Code health stats** **Code health stats**

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