diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json index b5fd8147b8a2e..3e37dacfedfa4 100644 --- a/api_docs/actions.devdocs.json +++ b/api_docs/actions.devdocs.json @@ -206,7 +206,552 @@ } }, "server": { - "classes": [], + "classes": [ + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector", + "type": "Class", + "tags": [], + "label": "CaseConnector", + "description": [], + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.CaseConnector", + "text": "CaseConnector" + }, + " extends ", + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.SubActionConnector", + "text": "SubActionConnector" + }, + " implements ", + "CaseConnectorInterface" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ServiceParams", + "text": "ServiceParams" + }, + "" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.addComment", + "type": "Function", + "tags": [], + "label": "addComment", + "description": [], + "signature": [ + "({ incidentId, comment, }: { incidentId: string; comment: string; }) => Promise" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.addComment.$1", + "type": "Object", + "tags": [], + "label": "{\n incidentId,\n comment,\n }", + "description": [], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.addComment.$1.incidentId", + "type": "string", + "tags": [], + "label": "incidentId", + "description": [], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.addComment.$1.comment", + "type": "string", + "tags": [], + "label": "comment", + "description": [], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.createIncident", + "type": "Function", + "tags": [], + "label": "createIncident", + "description": [], + "signature": [ + "(incident: Record) => Promise<", + "ExternalServiceIncidentResponse", + ">" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.createIncident.$1", + "type": "Object", + "tags": [], + "label": "incident", + "description": [], + "signature": [ + "Record" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.updateIncident", + "type": "Function", + "tags": [], + "label": "updateIncident", + "description": [], + "signature": [ + "({ incidentId, incident, }: { incidentId: string; incident: Record; }) => Promise<", + "ExternalServiceIncidentResponse", + ">" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.updateIncident.$1", + "type": "Object", + "tags": [], + "label": "{\n incidentId,\n incident,\n }", + "description": [], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.updateIncident.$1.incidentId", + "type": "string", + "tags": [], + "label": "incidentId", + "description": [], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.updateIncident.$1.incident", + "type": "Object", + "tags": [], + "label": "incident", + "description": [], + "signature": [ + "{ [x: string]: unknown; }" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.getIncident", + "type": "Function", + "tags": [], + "label": "getIncident", + "description": [], + "signature": [ + "({ id }: { id: string; }) => Promise<", + "ExternalServiceIncidentResponse", + ">" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.getIncident.$1", + "type": "Object", + "tags": [], + "label": "{ id }", + "description": [], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.getIncident.$1.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.pushToService", + "type": "Function", + "tags": [], + "label": "pushToService", + "description": [], + "signature": [ + "(params: ", + "PushToServiceParams", + ") => Promise<", + "PushToServiceResponse", + ">" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.CaseConnector.pushToService.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "PushToServiceParams" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/case.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector", + "type": "Class", + "tags": [], + "label": "SubActionConnector", + "description": [], + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.SubActionConnector", + "text": "SubActionConnector" + }, + "" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.logger", + "type": "Object", + "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.connector", + "type": "Object", + "tags": [], + "label": "connector", + "description": [], + "signature": [ + "{ id: string; type: string; }" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.config", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Config" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.secrets", + "type": "Uncategorized", + "tags": [], + "label": "secrets", + "description": [], + "signature": [ + "Secrets" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ServiceParams", + "text": "ServiceParams" + }, + "" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.registerSubAction", + "type": "Function", + "tags": [], + "label": "registerSubAction", + "description": [], + "signature": [ + "(subAction: ", + "SubAction", + ") => void" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.registerSubAction.$1", + "type": "Object", + "tags": [], + "label": "subAction", + "description": [], + "signature": [ + "SubAction" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.removeNullOrUndefinedFields", + "type": "Function", + "tags": [], + "label": "removeNullOrUndefinedFields", + "description": [], + "signature": [ + "(data: unknown) => unknown" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.removeNullOrUndefinedFields.$1", + "type": "Unknown", + "tags": [], + "label": "data", + "description": [], + "signature": [ + "unknown" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.getSubActions", + "type": "Function", + "tags": [], + "label": "getSubActions", + "description": [], + "signature": [ + "() => Map" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.getResponseErrorMessage", + "type": "Function", + "tags": [], + "label": "getResponseErrorMessage", + "description": [], + "signature": [ + "(error: ", + "AxiosError", + ") => string" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.getResponseErrorMessage.$1", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "AxiosError", + "" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.request", + "type": "Function", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "({ url, data, method, responseSchema, headers, ...config }: { url: string; responseSchema: ", + "Type", + "; method?: ", + "Method", + " | undefined; } & ", + "AxiosRequestConfig", + ") => Promise<", + "AxiosResponse", + ">" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.SubActionConnector.request.$1", + "type": "CompoundType", + "tags": [], + "label": "{\n url,\n data,\n method = 'get',\n responseSchema,\n headers,\n ...config\n }", + "description": [], + "signature": [ + "{ url: string; responseSchema: ", + "Type", + "; method?: ", + "Method", + " | undefined; } & ", + "AxiosRequestConfig", + "" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/sub_action_connector.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], "functions": [ { "parentPluginId": "actions", @@ -891,6 +1436,109 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "actions", + "id": "def-server.ServiceParams", + "type": "Interface", + "tags": [], + "label": "ServiceParams", + "description": [], + "signature": [ + { + "pluginId": "actions", + "scope": "server", + "docId": "kibActionsPluginApi", + "section": "def-server.ServiceParams", + "text": "ServiceParams" + }, + "" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.ServiceParams.connector", + "type": "Object", + "tags": [], + "label": "connector", + "description": [ + "\nThe type is the connector type id. For example \".servicenow\"\nThe id is the connector's SavedObject UUID." + ], + "signature": [ + "{ id: string; type: string; }" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-server.ServiceParams.config", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Config" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-server.ServiceParams.configurationUtilities", + "type": "Object", + "tags": [], + "label": "configurationUtilities", + "description": [], + "signature": [ + "ActionsConfigurationUtilities" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-server.ServiceParams.logger", + "type": "Object", + "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-server.ServiceParams.secrets", + "type": "Uncategorized", + "tags": [], + "label": "secrets", + "description": [], + "signature": [ + "Secrets" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-server.ServiceParams.services", + "type": "Object", + "tags": [], + "label": "services", + "description": [], + "signature": [ + "Services" + ], + "path": "x-pack/plugins/actions/server/sub_action_framework/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false } ], "enums": [], @@ -945,7 +1593,7 @@ "label": "ActionParamsType", "description": [], "signature": [ - "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly group?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"warning\" | \"info\" | \"critical\" | undefined; readonly component?: string | undefined; readonly class?: string | undefined; }" + "{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly group?: string | undefined; readonly component?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"warning\" | \"info\" | \"critical\" | undefined; readonly class?: string | undefined; }" ], "path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts", "deprecated": false, @@ -1133,7 +1781,9 @@ }, "<", "ActionTypeConfig", - ">[]>; enqueueExecution: (options: ", + ">[]>; getOAuthAccessToken: ({ type, options }: Readonly<{} & { type: \"client\" | \"jwt\"; options: Readonly<{} & { tokenUrl: string; config: Readonly<{} & { clientId: string; jwtKeyId: string; userIdentifierValue: string; }>; secrets: Readonly<{ privateKeyPassword?: string | undefined; } & { clientSecret: string; privateKey: string; }>; }> | Readonly<{} & { scope: string; tokenUrl: string; config: Readonly<{} & { clientId: string; tenantId: string; }>; secrets: Readonly<{} & { clientSecret: string; }>; }>; }>, configurationUtilities: ", + "ActionsConfigurationUtilities", + ") => Promise<{ accessToken: string | null; }>; enqueueExecution: (options: ", "ExecuteOptions", ") => Promise; ephemeralEnqueuedExecution: (options: ", "ExecuteOptions", @@ -1382,6 +2032,47 @@ ], "returnComment": [] }, + { + "parentPluginId": "actions", + "id": "def-server.PluginSetupContract.registerSubActionConnectorType", + "type": "Function", + "tags": [], + "label": "registerSubActionConnectorType", + "description": [], + "signature": [ + "(connector: ", + "SubActionConnectorType", + ") => void" + ], + "path": "x-pack/plugins/actions/server/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.PluginSetupContract.registerSubActionConnectorType.$1", + "type": "Object", + "tags": [], + "label": "connector", + "description": [], + "signature": [ + "SubActionConnectorType", + "" + ], + "path": "x-pack/plugins/actions/server/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "actions", "id": "def-server.PluginSetupContract.isPreconfiguredConnector", @@ -1411,6 +2102,40 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-server.PluginSetupContract.getSubActionConnectorClass", + "type": "Function", + "tags": [], + "label": "getSubActionConnectorClass", + "description": [], + "signature": [ + "() => ", + "IServiceAbstract", + "" + ], + "path": "x-pack/plugins/actions/server/plugin.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "actions", + "id": "def-server.PluginSetupContract.getCaseConnectorClass", + "type": "Function", + "tags": [], + "label": "getCaseConnectorClass", + "description": [], + "signature": [ + "() => ", + "IServiceAbstract", + "" + ], + "path": "x-pack/plugins/actions/server/plugin.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "lifecycle": "setup", diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index 267f24e44374c..0d88e756cdf8d 100644 --- a/api_docs/actions.mdx +++ b/api_docs/actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/actions title: "actions" image: https://source.unsplash.com/400x175/?github summary: API docs for the actions plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 195 | 0 | 191 | 11 | +| 240 | 0 | 235 | 19 | ## Client @@ -39,6 +39,9 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q ### Functions +### Classes + + ### Interfaces diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index 4403e9604c11a..6942f75a5adcc 100644 --- a/api_docs/advanced_settings.mdx +++ b/api_docs/advanced_settings.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/advancedSettings title: "advancedSettings" image: https://source.unsplash.com/400x175/?github summary: API docs for the advancedSettings plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/aiops.devdocs.json b/api_docs/aiops.devdocs.json new file mode 100644 index 0000000000000..b04e28a5eac34 --- /dev/null +++ b/api_docs/aiops.devdocs.json @@ -0,0 +1,212 @@ +{ + "id": "aiops", + "client": { + "classes": [], + "functions": [ + { + "parentPluginId": "aiops", + "id": "def-public.ExplainLogRateSpikes", + "type": "Function", + "tags": [], + "label": "ExplainLogRateSpikes", + "description": [ + "\nLazy-wrapped ExplainLogRateSpikes React component" + ], + "signature": [ + "(props: React.PropsWithChildren<", + { + "pluginId": "aiops", + "scope": "public", + "docId": "kibAiopsPluginApi", + "section": "def-public.ExplainLogRateSpikesProps", + "text": "ExplainLogRateSpikesProps" + }, + ">) => JSX.Element" + ], + "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "aiops", + "id": "def-public.ExplainLogRateSpikes.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [ + "- properties specifying the data on which to run the analysis." + ], + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "aiops", + "scope": "public", + "docId": "kibAiopsPluginApi", + "section": "def-public.ExplainLogRateSpikesProps", + "text": "ExplainLogRateSpikesProps" + }, + ">" + ], + "path": "x-pack/plugins/aiops/public/shared_lazy_components.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "aiops", + "id": "def-public.ExplainLogRateSpikesProps", + "type": "Interface", + "tags": [], + "label": "ExplainLogRateSpikesProps", + "description": [ + "\nExplainLogRateSpikes props require a data view." + ], + "path": "x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "aiops", + "id": "def-public.ExplainLogRateSpikesProps.dataView", + "type": "Object", + "tags": [], + "label": "dataView", + "description": [ + "The data view to analyze." + ], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + } + ], + "path": "x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [], + "start": { + "parentPluginId": "aiops", + "id": "def-public.AiopsPluginStart", + "type": "Type", + "tags": [], + "label": "AiopsPluginStart", + "description": [ + "\naiops plugin public start contract" + ], + "signature": [ + "void" + ], + "path": "x-pack/plugins/aiops/public/types.ts", + "deprecated": false, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [], + "setup": { + "parentPluginId": "aiops", + "id": "def-server.AiopsPluginSetup", + "type": "Interface", + "tags": [], + "label": "AiopsPluginSetup", + "description": [ + "\naiops plugin server setup contract" + ], + "path": "x-pack/plugins/aiops/server/types.ts", + "deprecated": false, + "children": [], + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "aiops", + "id": "def-server.AiopsPluginStart", + "type": "Interface", + "tags": [], + "label": "AiopsPluginStart", + "description": [ + "\naiops plugin server start contract" + ], + "path": "x-pack/plugins/aiops/server/types.ts", + "deprecated": false, + "children": [], + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "aiops", + "id": "def-common.AIOPS_ENABLED", + "type": "boolean", + "tags": [], + "label": "AIOPS_ENABLED", + "description": [ + "\nThis is an internal hard coded feature flag so we can easily turn on/off the\n\"Explain log rate spikes UI\" during development until the first release." + ], + "signature": [ + "false" + ], + "path": "x-pack/plugins/aiops/common/index.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "aiops", + "id": "def-common.PLUGIN_ID", + "type": "string", + "tags": [], + "label": "PLUGIN_ID", + "description": [ + "\nPLUGIN_ID is used as a unique identifier for the aiops plugin" + ], + "signature": [ + "\"aiops\"" + ], + "path": "x-pack/plugins/aiops/common/index.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "aiops", + "id": "def-common.PLUGIN_NAME", + "type": "string", + "tags": [], + "label": "PLUGIN_NAME", + "description": [ + "\nPLUGIN_NAME is used as the display name for the aiops plugin" + ], + "signature": [ + "\"AIOps\"" + ], + "path": "x-pack/plugins/aiops/common/index.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx new file mode 100644 index 0000000000000..22dc2801aa158 --- /dev/null +++ b/api_docs/aiops.mdx @@ -0,0 +1,46 @@ +--- +id: kibAiopsPluginApi +slug: /kibana-dev-docs/api/aiops +title: "aiops" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the aiops plugin +date: 2022-05-24 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import aiopsObj from './aiops.devdocs.json'; + +AIOps plugin maintained by ML team. + +Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 11 | 0 | 0 | 0 | + +## Client + +### Start + + +### Functions + + +### Interfaces + + +## Server + +### Setup + + +### Start + + +## Common + +### Consts, variables and types + + diff --git a/api_docs/alerting.devdocs.json b/api_docs/alerting.devdocs.json index a7c437fda9dbf..2bf0174c2e6d5 100644 --- a/api_docs/alerting.devdocs.json +++ b/api_docs/alerting.devdocs.json @@ -75,7 +75,7 @@ "section": "def-common.MappedParams", "text": "MappedParams" }, - " | undefined; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: ", + " | undefined; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; muteAll: boolean; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: ", { "pluginId": "alerting", "scope": "common", @@ -83,7 +83,15 @@ "section": "def-common.RuleExecutionStatus", "text": "RuleExecutionStatus" }, - "; snoozeEndTime?: Date | null | undefined; }" + "; snoozeSchedule?: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleSnooze", + "text": "RuleSnooze" + }, + " | undefined; isSnoozedUntil?: Date | null | undefined; }" ], "path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts", "deprecated": false @@ -1041,6 +1049,182 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditError", + "type": "Interface", + "tags": [], + "label": "BulkEditError", + "description": [], + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditError.message", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditError.rule", + "type": "Object", + "tags": [], + "label": "rule", + "description": [], + "signature": [ + "{ id: string; name: string; }" + ], + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditOptionsFilter", + "type": "Interface", + "tags": [], + "label": "BulkEditOptionsFilter", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkEditOptionsFilter", + "text": "BulkEditOptionsFilter" + }, + "" + ], + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditOptionsFilter.filter", + "type": "CompoundType", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "string | ", + "KueryNode", + " | undefined" + ], + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditOptionsFilter.operations", + "type": "Array", + "tags": [], + "label": "operations", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkEditOperation", + "text": "BulkEditOperation" + }, + "[]" + ], + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditOptionsFilter.paramsModifier", + "type": "Function", + "tags": [], + "label": "paramsModifier", + "description": [], + "signature": [ + "RuleParamsModifier | undefined" + ], + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditOptionsIds", + "type": "Interface", + "tags": [], + "label": "BulkEditOptionsIds", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkEditOptionsIds", + "text": "BulkEditOptionsIds" + }, + "" + ], + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditOptionsIds.ids", + "type": "Array", + "tags": [], + "label": "ids", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditOptionsIds.operations", + "type": "Array", + "tags": [], + "label": "operations", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkEditOperation", + "text": "BulkEditOperation" + }, + "[]" + ], + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditOptionsIds.paramsModifier", + "type": "Function", + "tags": [], + "label": "paramsModifier", + "description": [], + "signature": [ + "RuleParamsModifier | undefined" + ], + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "alerting", "id": "def-server.FindResult", @@ -1658,15 +1842,13 @@ "label": "searchSourceClient", "description": [], "signature": [ - "Promise<", { "pluginId": "data", "scope": "common", "docId": "kibDataSearchPluginApi", "section": "def-common.ISearchStartSearchSource", "text": "ISearchStartSearchSource" - }, - ">" + } ], "path": "x-pack/plugins/alerting/server/types.ts", "deprecated": false @@ -2546,7 +2728,7 @@ "label": "AlertingRulesConfig", "description": [], "signature": [ - "{ readonly minimumScheduleInterval: Readonly<{} & { value: string; enforce: boolean; }>; }" + "Pick[] | undefined; } & { actions: Readonly<{ connectorTypeOverrides?: Readonly<{ max?: number | undefined; } & { id: string; }>[] | undefined; } & { max: number; }>; }>; minimumScheduleInterval: Readonly<{} & { value: string; enforce: boolean; }>; }>, \"minimumScheduleInterval\"> & { isUsingSecurity: boolean; }" ], "path": "x-pack/plugins/alerting/server/config.ts", "deprecated": false, @@ -2580,6 +2762,49 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditOperation", + "type": "Type", + "tags": [], + "label": "BulkEditOperation", + "description": [], + "signature": [ + "{ operation: \"delete\" | \"set\" | \"add\"; field: \"tags\"; value: string[]; } | { operation: \"set\" | \"add\"; field: \"actions\"; value: NormalizedAlertAction[]; }" + ], + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "alerting", + "id": "def-server.BulkEditOptions", + "type": "Type", + "tags": [], + "label": "BulkEditOptions", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkEditOptionsFilter", + "text": "BulkEditOptionsFilter" + }, + " | ", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkEditOptionsIds", + "text": "BulkEditOptionsIds" + }, + "" + ], + "path": "x-pack/plugins/alerting/server/rules_client/rules_client.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "alerting", "id": "def-server.DEFAULT_MAX_EPHEMERAL_ACTIONS_PER_ALERT", @@ -2780,7 +3005,39 @@ "section": "def-common.IExecutionLogWithErrorsResult", "text": "IExecutionLogWithErrorsResult" }, - ">; updateApiKey: ({ id }: { id: string; }) => Promise; snooze: ({ id, snoozeEndTime, }: { id: string; snoozeEndTime: string | -1; }) => Promise; unsnooze: ({ id }: { id: string; }) => Promise; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ", + ">; bulkEdit: (options: ", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkEditOptions", + "text": "BulkEditOptions" + }, + ") => Promise<{ rules: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.SanitizedRule", + "text": "SanitizedRule" + }, + "[]; errors: ", + { + "pluginId": "alerting", + "scope": "server", + "docId": "kibAlertingPluginApi", + "section": "def-server.BulkEditError", + "text": "BulkEditError" + }, + "[]; total: number; }>; updateApiKey: ({ id }: { id: string; }) => Promise; snooze: ({ id, snoozeEndTime, }: { id: string; snoozeEndTime: string | -1; }) => Promise; unsnooze: ({ id }: { id: string; }) => Promise; updateSnoozedUntilTime: ({ id }: { id: string; }) => Promise; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", ") => Promise; unmuteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", @@ -3833,6 +4090,16 @@ "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false }, + { + "parentPluginId": "alerting", + "id": "def-common.IExecutionLog.version", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "path": "x-pack/plugins/alerting/common/execution_log_types.ts", + "deprecated": false + }, { "parentPluginId": "alerting", "id": "def-common.IExecutionLog.num_active_alerts", @@ -4062,6 +4329,219 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord", + "type": "Interface", + "tags": [], + "label": "RRuleRecord", + "description": [], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.dtstart", + "type": "string", + "tags": [], + "label": "dtstart", + "description": [], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.tzid", + "type": "string", + "tags": [], + "label": "tzid", + "description": [], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.freq", + "type": "CompoundType", + "tags": [], + "label": "freq", + "description": [], + "signature": [ + "0 | 2 | 1 | 4 | 3 | 5 | 6 | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.until", + "type": "string", + "tags": [], + "label": "until", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.count", + "type": "number", + "tags": [], + "label": "count", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.interval", + "type": "number", + "tags": [], + "label": "interval", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.wkst", + "type": "CompoundType", + "tags": [], + "label": "wkst", + "description": [], + "signature": [ + "WeekdayStr", + " | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.byweekday", + "type": "Array", + "tags": [], + "label": "byweekday", + "description": [], + "signature": [ + "(string | number)[] | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.bymonth", + "type": "Array", + "tags": [], + "label": "bymonth", + "description": [], + "signature": [ + "number[] | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.bysetpos", + "type": "Array", + "tags": [], + "label": "bysetpos", + "description": [], + "signature": [ + "number[] | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.bymonthday", + "type": "number", + "tags": [], + "label": "bymonthday", + "description": [], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.byyearday", + "type": "Array", + "tags": [], + "label": "byyearday", + "description": [], + "signature": [ + "number[]" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.byweekno", + "type": "Array", + "tags": [], + "label": "byweekno", + "description": [], + "signature": [ + "number[]" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.byhour", + "type": "Array", + "tags": [], + "label": "byhour", + "description": [], + "signature": [ + "number[]" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.byminute", + "type": "Array", + "tags": [], + "label": "byminute", + "description": [], + "signature": [ + "number[]" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RRuleRecord.bysecond", + "type": "Array", + "tags": [], + "label": "bysecond", + "description": [], + "signature": [ + "number[]" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "alerting", "id": "def-common.Rule", @@ -4323,24 +4803,24 @@ }, { "parentPluginId": "alerting", - "id": "def-common.Rule.notifyWhen", - "type": "CompoundType", + "id": "def-common.Rule.muteAll", + "type": "boolean", "tags": [], - "label": "notifyWhen", + "label": "muteAll", "description": [], - "signature": [ - "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null" - ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false }, { "parentPluginId": "alerting", - "id": "def-common.Rule.muteAll", - "type": "boolean", + "id": "def-common.Rule.notifyWhen", + "type": "CompoundType", "tags": [], - "label": "muteAll", + "label": "notifyWhen", "description": [], + "signature": [ + "\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null" + ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false }, @@ -4398,10 +4878,30 @@ }, { "parentPluginId": "alerting", - "id": "def-common.Rule.snoozeEndTime", + "id": "def-common.Rule.snoozeSchedule", + "type": "Array", + "tags": [], + "label": "snoozeSchedule", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleSnooze", + "text": "RuleSnooze" + }, + " | undefined" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.Rule.isSnoozedUntil", "type": "CompoundType", "tags": [], - "label": "snoozeEndTime", + "label": "isSnoozedUntil", "description": [], "signature": [ "Date | null | undefined" @@ -4529,6 +5029,19 @@ ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false + }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleAggregations.ruleTags", + "type": "Array", + "tags": [], + "label": "ruleTags", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/alerting/common/rule.ts", + "deprecated": false } ], "initialIsOpen": false @@ -5155,7 +5668,7 @@ "label": "ExecutionLogSortFields", "description": [], "signature": [ - "\"timestamp\" | \"execution_duration\" | \"total_search_duration\" | \"es_search_duration\" | \"schedule_delay\" | \"num_triggered_actions\" | \"num_generated_actions\"" + "\"timestamp\" | \"execution_duration\" | \"total_search_duration\" | \"es_search_duration\" | \"schedule_delay\" | \"num_triggered_actions\" | \"num_generated_actions\" | \"num_active_alerts\" | \"num_recovered_alerts\" | \"num_new_alerts\"" ], "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, @@ -5422,6 +5935,36 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "alerting", + "id": "def-common.RuleSnooze", + "type": "Type", + "tags": [], + "label": "RuleSnooze", + "description": [], + "signature": [ + "{ duration: number; rRule: Partial<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RRuleRecord", + "text": "RRuleRecord" + }, + "> & Pick<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RRuleRecord", + "text": "RRuleRecord" + }, + ", \"dtstart\" | \"tzid\">; id?: string | undefined; }[]" + ], + "path": "x-pack/plugins/alerting/common/rule_snooze_type.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "alerting", "id": "def-common.RuleStatusValues", @@ -5532,7 +6075,7 @@ "section": "def-common.MappedParams", "text": "MappedParams" }, - " | undefined; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: ", + " | undefined; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; muteAll: boolean; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: ", { "pluginId": "alerting", "scope": "common", @@ -5540,7 +6083,15 @@ "section": "def-common.RuleExecutionStatus", "text": "RuleExecutionStatus" }, - "; snoozeEndTime?: Date | null | undefined; }" + "; snoozeSchedule?: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleSnooze", + "text": "RuleSnooze" + }, + " | undefined; isSnoozedUntil?: Date | null | undefined; }" ], "path": "x-pack/plugins/alerting/common/rule.ts", "deprecated": false, @@ -5614,7 +6165,7 @@ "label": "executionLogSortableColumns", "description": [], "signature": [ - "readonly [\"timestamp\", \"execution_duration\", \"total_search_duration\", \"es_search_duration\", \"schedule_delay\", \"num_triggered_actions\", \"num_generated_actions\"]" + "readonly [\"timestamp\", \"execution_duration\", \"total_search_duration\", \"es_search_duration\", \"schedule_delay\", \"num_triggered_actions\", \"num_generated_actions\", \"num_active_alerts\", \"num_recovered_alerts\", \"num_new_alerts\"]" ], "path": "x-pack/plugins/alerting/common/execution_log_types.ts", "deprecated": false, diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index cc9c60a87987e..99be27030552f 100644 --- a/api_docs/alerting.mdx +++ b/api_docs/alerting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/alerting title: "alerting" image: https://source.unsplash.com/400x175/?github summary: API docs for the alerting plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 325 | 0 | 316 | 19 | +| 359 | 0 | 350 | 19 | ## Client diff --git a/api_docs/apm.devdocs.json b/api_docs/apm.devdocs.json index 302f8c93bdea9..daff1b24dec99 100644 --- a/api_docs/apm.devdocs.json +++ b/api_docs/apm.devdocs.json @@ -560,6 +560,22 @@ "section": "def-server.RuleRegistryPluginStartContract", "text": "RuleRegistryPluginStartContract" }, + ">; }; infra: { setup: ", + { + "pluginId": "infra", + "scope": "server", + "docId": "kibInfraPluginApi", + "section": "def-server.InfraPluginSetup", + "text": "InfraPluginSetup" + }, + "; start: () => Promise<", + { + "pluginId": "infra", + "scope": "server", + "docId": "kibInfraPluginApi", + "section": "def-server.InfraPluginStart", + "text": "InfraPluginStart" + }, ">; }; actions?: { setup: ", { "pluginId": "actions", @@ -762,7 +778,7 @@ "label": "APIEndpoint", "description": [], "signature": [ - "\"POST /internal/apm/data_view/static\" | \"GET /internal/apm/data_view/dynamic\" | \"GET /internal/apm/environments\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}\" | \"GET /internal/apm/services/{serviceName}/errors/distribution\" | \"POST /internal/apm/latency/overall_distribution\" | \"GET /internal/apm/services/{serviceName}/metrics/charts\" | \"GET /internal/apm/observability_overview\" | \"GET /internal/apm/observability_overview/has_data\" | \"GET /internal/apm/ux/client-metrics\" | \"GET /internal/apm/ux/page-load-distribution\" | \"GET /internal/apm/ux/page-load-distribution/breakdown\" | \"GET /internal/apm/ux/page-view-trends\" | \"GET /internal/apm/ux/services\" | \"GET /internal/apm/ux/visitor-breakdown\" | \"GET /internal/apm/ux/web-core-vitals\" | \"GET /internal/apm/ux/long-task-metrics\" | \"GET /internal/apm/ux/url-search\" | \"GET /internal/apm/ux/js-errors\" | \"GET /api/apm/observability_overview/has_rum_data\" | \"GET /internal/apm/service-map\" | \"GET /internal/apm/service-map/service/{serviceName}\" | \"GET /internal/apm/service-map/backend\" | \"GET /internal/apm/services/{serviceName}/serviceNodes\" | \"GET /internal/apm/services\" | \"GET /internal/apm/services/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/metadata/details\" | \"GET /internal/apm/services/{serviceName}/metadata/icons\" | \"GET /internal/apm/services/{serviceName}/agent\" | \"GET /internal/apm/services/{serviceName}/transaction_types\" | \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\" | \"GET /api/apm/services/{serviceName}/annotation/search\" | \"POST /api/apm/services/{serviceName}/annotation\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\" | \"GET /internal/apm/services/{serviceName}/throughput\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/dependencies\" | \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\" | \"GET /internal/apm/services/{serviceName}/profiling/timeline\" | \"GET /internal/apm/services/{serviceName}/profiling/statistics\" | \"GET /internal/apm/services/{serviceName}/infrastructure\" | \"GET /internal/apm/services/{serviceName}/anomaly_charts\" | \"GET /internal/apm/sorted_and_filtered_services\" | \"GET /internal/apm/service-groups\" | \"GET /internal/apm/service-group\" | \"POST /internal/apm/service-group\" | \"DELETE /internal/apm/service-group\" | \"GET /internal/apm/service-group/services\" | \"GET /internal/apm/suggestions\" | \"GET /internal/apm/traces/{traceId}\" | \"GET /internal/apm/traces\" | \"GET /internal/apm/traces/{traceId}/root_transaction\" | \"GET /internal/apm/transactions/{transactionId}\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\" | \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\" | \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_rate\" | \"GET /internal/apm/alerts/chart_preview/transaction_duration\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_count\" | \"GET /api/apm/settings/agent-configuration\" | \"GET /api/apm/settings/agent-configuration/view\" | \"DELETE /api/apm/settings/agent-configuration\" | \"PUT /api/apm/settings/agent-configuration\" | \"POST /api/apm/settings/agent-configuration/search\" | \"GET /api/apm/settings/agent-configuration/environments\" | \"GET /api/apm/settings/agent-configuration/agent_name\" | \"GET /internal/apm/settings/anomaly-detection/jobs\" | \"POST /internal/apm/settings/anomaly-detection/jobs\" | \"GET /internal/apm/settings/anomaly-detection/environments\" | \"POST /internal/apm/settings/anomaly-detection/update_to_v3\" | \"GET /internal/apm/settings/apm-index-settings\" | \"GET /internal/apm/settings/apm-indices\" | \"POST /internal/apm/settings/apm-indices/save\" | \"GET /internal/apm/settings/custom_links/transaction\" | \"GET /internal/apm/settings/custom_links\" | \"POST /internal/apm/settings/custom_links\" | \"PUT /internal/apm/settings/custom_links/{id}\" | \"DELETE /internal/apm/settings/custom_links/{id}\" | \"GET /api/apm/sourcemaps\" | \"POST /api/apm/sourcemaps\" | \"DELETE /api/apm/sourcemaps/{id}\" | \"GET /internal/apm/fleet/has_apm_policies\" | \"GET /internal/apm/fleet/agents\" | \"POST /api/apm/fleet/apm_server_schema\" | \"GET /internal/apm/fleet/apm_server_schema/unsupported\" | \"GET /internal/apm/fleet/migration_check\" | \"POST /internal/apm/fleet/cloud_apm_package_policy\" | \"GET /internal/apm/backends/top_backends\" | \"GET /internal/apm/backends/upstream_services\" | \"GET /internal/apm/backends/metadata\" | \"GET /internal/apm/backends/charts/latency\" | \"GET /internal/apm/backends/charts/throughput\" | \"GET /internal/apm/backends/charts/error_rate\" | \"POST /internal/apm/correlations/p_values\" | \"GET /internal/apm/correlations/field_candidates\" | \"POST /internal/apm/correlations/field_stats\" | \"GET /internal/apm/correlations/field_value_stats\" | \"POST /internal/apm/correlations/field_value_pairs\" | \"POST /internal/apm/correlations/significant_correlations\" | \"GET /internal/apm/fallback_to_transactions\" | \"GET /internal/apm/has_data\" | \"GET /internal/apm/event_metadata/{processorEvent}/{id}\" | \"GET /internal/apm/agent_keys\" | \"GET /internal/apm/agent_keys/privileges\" | \"POST /internal/apm/api_key/invalidate\" | \"POST /api/apm/agent_keys\"" + "\"POST /internal/apm/data_view/static\" | \"GET /internal/apm/data_view/dynamic\" | \"GET /internal/apm/environments\" | \"GET /internal/apm/services/{serviceName}/errors/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/errors/{groupId}\" | \"GET /internal/apm/services/{serviceName}/errors/distribution\" | \"POST /internal/apm/latency/overall_distribution\" | \"GET /internal/apm/services/{serviceName}/metrics/charts\" | \"GET /internal/apm/observability_overview\" | \"GET /internal/apm/observability_overview/has_data\" | \"GET /internal/apm/ux/client-metrics\" | \"GET /internal/apm/ux/page-load-distribution\" | \"GET /internal/apm/ux/page-load-distribution/breakdown\" | \"GET /internal/apm/ux/page-view-trends\" | \"GET /internal/apm/ux/visitor-breakdown\" | \"GET /internal/apm/ux/web-core-vitals\" | \"GET /internal/apm/ux/long-task-metrics\" | \"GET /internal/apm/ux/url-search\" | \"GET /internal/apm/ux/js-errors\" | \"GET /api/apm/observability_overview/has_rum_data\" | \"GET /internal/apm/service-map\" | \"GET /internal/apm/service-map/service/{serviceName}\" | \"GET /internal/apm/service-map/backend\" | \"GET /internal/apm/services/{serviceName}/serviceNodes\" | \"GET /internal/apm/services\" | \"GET /internal/apm/services/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/metadata/details\" | \"GET /internal/apm/services/{serviceName}/metadata/icons\" | \"GET /internal/apm/services/{serviceName}/agent\" | \"GET /internal/apm/services/{serviceName}/transaction_types\" | \"GET /internal/apm/services/{serviceName}/node/{serviceNodeName}/metadata\" | \"GET /api/apm/services/{serviceName}/annotation/search\" | \"POST /api/apm/services/{serviceName}/annotation\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/details/{serviceNodeName}\" | \"GET /internal/apm/services/{serviceName}/throughput\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/main_statistics\" | \"GET /internal/apm/services/{serviceName}/service_overview_instances/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/dependencies\" | \"GET /internal/apm/services/{serviceName}/dependencies/breakdown\" | \"GET /internal/apm/services/{serviceName}/profiling/timeline\" | \"GET /internal/apm/services/{serviceName}/profiling/statistics\" | \"GET /internal/apm/services/{serviceName}/infrastructure_attributes_for_logs\" | \"GET /internal/apm/services/{serviceName}/anomaly_charts\" | \"GET /internal/apm/sorted_and_filtered_services\" | \"GET /internal/apm/service-groups\" | \"GET /internal/apm/service-group\" | \"POST /internal/apm/service-group\" | \"DELETE /internal/apm/service-group\" | \"GET /internal/apm/service-group/services\" | \"GET /internal/apm/suggestions\" | \"GET /internal/apm/traces/{traceId}\" | \"GET /internal/apm/traces\" | \"GET /internal/apm/traces/{traceId}/root_transaction\" | \"GET /internal/apm/transactions/{transactionId}\" | \"GET /internal/apm/traces/find\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/main_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/groups/detailed_statistics\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/latency\" | \"GET /internal/apm/services/{serviceName}/transactions/traces/samples\" | \"GET /internal/apm/services/{serviceName}/transaction/charts/breakdown\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/error_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate\" | \"GET /internal/apm/services/{serviceName}/transactions/charts/coldstart_rate_by_transaction_name\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_rate\" | \"GET /internal/apm/alerts/chart_preview/transaction_duration\" | \"GET /internal/apm/alerts/chart_preview/transaction_error_count\" | \"GET /api/apm/settings/agent-configuration\" | \"GET /api/apm/settings/agent-configuration/view\" | \"DELETE /api/apm/settings/agent-configuration\" | \"PUT /api/apm/settings/agent-configuration\" | \"POST /api/apm/settings/agent-configuration/search\" | \"GET /api/apm/settings/agent-configuration/environments\" | \"GET /api/apm/settings/agent-configuration/agent_name\" | \"GET /internal/apm/settings/anomaly-detection/jobs\" | \"POST /internal/apm/settings/anomaly-detection/jobs\" | \"GET /internal/apm/settings/anomaly-detection/environments\" | \"POST /internal/apm/settings/anomaly-detection/update_to_v3\" | \"GET /internal/apm/settings/apm-index-settings\" | \"GET /internal/apm/settings/apm-indices\" | \"POST /internal/apm/settings/apm-indices/save\" | \"GET /internal/apm/settings/custom_links/transaction\" | \"GET /internal/apm/settings/custom_links\" | \"POST /internal/apm/settings/custom_links\" | \"PUT /internal/apm/settings/custom_links/{id}\" | \"DELETE /internal/apm/settings/custom_links/{id}\" | \"GET /api/apm/sourcemaps\" | \"POST /api/apm/sourcemaps\" | \"DELETE /api/apm/sourcemaps/{id}\" | \"GET /internal/apm/fleet/has_apm_policies\" | \"GET /internal/apm/fleet/agents\" | \"POST /api/apm/fleet/apm_server_schema\" | \"GET /internal/apm/fleet/apm_server_schema/unsupported\" | \"GET /internal/apm/fleet/migration_check\" | \"POST /internal/apm/fleet/cloud_apm_package_policy\" | \"GET /internal/apm/backends/top_backends\" | \"GET /internal/apm/backends/upstream_services\" | \"GET /internal/apm/backends/metadata\" | \"GET /internal/apm/backends/charts/latency\" | \"GET /internal/apm/backends/charts/throughput\" | \"GET /internal/apm/backends/charts/error_rate\" | \"POST /internal/apm/correlations/p_values\" | \"GET /internal/apm/correlations/field_candidates\" | \"POST /internal/apm/correlations/field_stats\" | \"GET /internal/apm/correlations/field_value_stats\" | \"POST /internal/apm/correlations/field_value_pairs\" | \"POST /internal/apm/correlations/significant_correlations\" | \"GET /internal/apm/fallback_to_transactions\" | \"GET /internal/apm/has_data\" | \"GET /internal/apm/event_metadata/{processorEvent}/{id}\" | \"GET /internal/apm/agent_keys\" | \"GET /internal/apm/agent_keys/privileges\" | \"POST /internal/apm/api_key/invalidate\" | \"POST /api/apm/agent_keys\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\" | \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/children\" | \"GET /internal/apm/services/{serviceName}/infrastructure_attributes\" | \"GET /internal/apm/debug-telemetry\"" ], "path": "x-pack/plugins/apm/server/routes/apm_routes/get_global_apm_server_route_repository.ts", "deprecated": false, @@ -820,7 +836,155 @@ "label": "APMServerRouteRepository", "description": [], "signature": [ - "{ \"POST /api/apm/agent_keys\": ", + "{ \"GET /internal/apm/debug-telemetry\": ", + "ServerRoute", + "<\"GET /internal/apm/debug-telemetry\", undefined, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", unknown, ", + "APMRouteCreateOptions", + ">; \"GET /internal/apm/services/{serviceName}/infrastructure_attributes\": ", + "ServerRoute", + "<\"GET /internal/apm/services/{serviceName}/infrastructure_attributes\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ serviceName: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "TypeC", + "<{ environment: ", + "UnionC", + "<[", + "LiteralC", + "<\"ENVIRONMENT_NOT_DEFINED\">, ", + "LiteralC", + "<\"ENVIRONMENT_ALL\">, ", + "BrandC", + "<", + "StringC", + ", ", + "NonEmptyStringBrand", + ">]>; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { containerIds: string[]; hostNames: string[]; podNames: string[]; }, ", + "APMRouteCreateOptions", + ">; \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/children\": ", + "ServerRoute", + "<\"GET /internal/apm/traces/{traceId}/span_links/{spanId}/children\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ traceId: ", + "StringC", + "; spanId: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { spanLinksDetails: ", + "SpanLinkDetails", + "[]; }, ", + "APMRouteCreateOptions", + ">; \"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\": ", + "ServerRoute", + "<\"GET /internal/apm/traces/{traceId}/span_links/{spanId}/parents\", ", + "TypeC", + "<{ path: ", + "TypeC", + "<{ traceId: ", + "StringC", + "; spanId: ", + "StringC", + "; }>; query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ kuery: ", + "StringC", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "TypeC", + "<{ processorEvent: ", + "UnionC", + "<[", + "LiteralC", + "<", + "ProcessorEvent", + ".transaction>, ", + "LiteralC", + "<", + "ProcessorEvent", + ".error>, ", + "LiteralC", + "<", + "ProcessorEvent", + ".metric>, ", + "LiteralC", + "<", + "ProcessorEvent", + ".span>, ", + "LiteralC", + "<", + "ProcessorEvent", + ".profile>]>; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { spanLinksDetails: ", + "SpanLinkDetails", + "[]; }, ", + "APMRouteCreateOptions", + ">; \"POST /api/apm/agent_keys\": ", "ServerRoute", "<\"POST /api/apm/agent_keys\", ", "TypeC", @@ -2940,6 +3104,56 @@ }, ", { transactionGroups: { transactionType: string; name: string; latency: number | null; throughput: number; errorRate: number; impact: number; }[]; isAggregationAccurate: boolean; bucketSize: number; }, ", "APMRouteCreateOptions", + ">; \"GET /internal/apm/traces/find\": ", + "ServerRoute", + "<\"GET /internal/apm/traces/find\", ", + "TypeC", + "<{ query: ", + "IntersectionC", + "<[", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "TypeC", + "<{ environment: ", + "UnionC", + "<[", + "LiteralC", + "<\"ENVIRONMENT_NOT_DEFINED\">, ", + "LiteralC", + "<\"ENVIRONMENT_ALL\">, ", + "BrandC", + "<", + "StringC", + ", ", + "NonEmptyStringBrand", + ">]>; }>, ", + "TypeC", + "<{ query: ", + "StringC", + "; type: ", + "UnionC", + "<[", + "LiteralC", + "<", + "TraceSearchType", + ".kql>, ", + "LiteralC", + "<", + "TraceSearchType", + ".eql>]>; }>]>; }>, ", + { + "pluginId": "apm", + "scope": "server", + "docId": "kibApmPluginApi", + "section": "def-server.APMRouteHandlerResources", + "text": "APMRouteHandlerResources" + }, + ", { samples: { traceId: string; transactionId: string; }[]; }, ", + "APMRouteCreateOptions", ">; \"GET /internal/apm/transactions/{transactionId}\": ", "ServerRoute", "<\"GET /internal/apm/transactions/{transactionId}\", ", @@ -3056,19 +3270,31 @@ "Span", ")[]; errorDocs: ", "APMError", - "[]; }, ", + "[]; linkedChildrenOfSpanCountBySpanId: Record; }, ", "APMRouteCreateOptions", ">; \"GET /internal/apm/suggestions\": ", "ServerRoute", "<\"GET /internal/apm/suggestions\", ", - "PartialC", + "TypeC", "<{ query: ", + "IntersectionC", + "<[", "TypeC", - "<{ field: ", + "<{ fieldName: ", "StringC", - "; string: ", + "; fieldValue: ", "StringC", - "; }>; }>, ", + "; }>, ", + "TypeC", + "<{ start: ", + "Type", + "; end: ", + "Type", + "; }>, ", + "PartialC", + "<{ serviceName: ", + "StringC", + "; }>]>; }>, ", { "pluginId": "apm", "scope": "server", @@ -3280,9 +3506,9 @@ "ServiceAnomalyTimeseries", "[]; }, ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/services/{serviceName}/infrastructure\": ", + ">; \"GET /internal/apm/services/{serviceName}/infrastructure_attributes_for_logs\": ", "ServerRoute", - "<\"GET /internal/apm/services/{serviceName}/infrastructure\", ", + "<\"GET /internal/apm/services/{serviceName}/infrastructure_attributes_for_logs\", ", "TypeC", "<{ path: ", "TypeC", @@ -4526,32 +4752,6 @@ }, ", { os: { count: number; name: string; }[]; browsers: { count: number; name: string; }[]; }, ", "APMRouteCreateOptions", - ">; \"GET /internal/apm/ux/services\": ", - "ServerRoute", - "<\"GET /internal/apm/ux/services\", ", - "TypeC", - "<{ query: ", - "IntersectionC", - "<[", - "TypeC", - "<{ uiFilters: ", - "StringC", - "; }>, ", - "TypeC", - "<{ start: ", - "Type", - "; end: ", - "Type", - "; }>]>; }>, ", - { - "pluginId": "apm", - "scope": "server", - "docId": "kibApmPluginApi", - "section": "def-server.APMRouteHandlerResources", - "text": "APMRouteHandlerResources" - }, - ", { rumServices: string[]; }, ", - "APMRouteCreateOptions", ">; \"GET /internal/apm/ux/page-view-trends\": ", "ServerRoute", "<\"GET /internal/apm/ux/page-view-trends\", ", diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index 9dd3c0c89fdf4..33036bb8bee67 100644 --- a/api_docs/apm.mdx +++ b/api_docs/apm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/apm title: "apm" image: https://source.unsplash.com/400x175/?github summary: API docs for the apm plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [APM UI](https://github.com/orgs/elastic/teams/apm-ui) for questions reg | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 40 | 0 | 40 | 50 | +| 40 | 0 | 40 | 52 | ## Client diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index e22924610e9ae..ab3323315c052 100644 --- a/api_docs/banners.mdx +++ b/api_docs/banners.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/banners title: "banners" image: https://source.unsplash.com/400x175/?github summary: API docs for the banners plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index 2b2f9e84817e5..697fcd47eefea 100644 --- a/api_docs/bfetch.mdx +++ b/api_docs/bfetch.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/bfetch title: "bfetch" image: https://source.unsplash.com/400x175/?github summary: API docs for the bfetch plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx index cc1fdd45c597c..d2990dfb31fd0 100644 --- a/api_docs/canvas.mdx +++ b/api_docs/canvas.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/canvas title: "canvas" image: https://source.unsplash.com/400x175/?github summary: API docs for the canvas plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cases.devdocs.json b/api_docs/cases.devdocs.json index a78b058751b23..6357b9efbc662 100644 --- a/api_docs/cases.devdocs.json +++ b/api_docs/cases.devdocs.json @@ -245,7 +245,7 @@ { "parentPluginId": "cases", "id": "def-public.generateCaseViewPath.$1", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "params", "description": [], @@ -630,51 +630,11 @@ "section": "def-common.CaseStatuses", "text": "CaseStatuses" }, - " | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; fields?: string | string[] | undefined; from?: string | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string | string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; to?: string | undefined; owner?: string | string[] | undefined; }) => Promise<({ description: string; status: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CaseStatuses", - "text": "CaseStatuses" - }, - "; tags: string[]; title: string; connector: { id: string; } & (({ type: ", - "ConnectorTypes", - ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } & { name: string; }) | ({ type: ", - "ConnectorTypes", - ".none; fields: null; } & { name: string; }) | ({ type: ", - "ConnectorTypes", - ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } & { name: string; }) | ({ type: ", - "ConnectorTypes", - ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; } & { name: string; }) | ({ type: ", - "ConnectorTypes", - ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; } & { name: string; }) | ({ type: ", - "ConnectorTypes", - ".swimlane; fields: { caseId: string | null; } | null; } & { name: string; })); settings: { syncAlerts: boolean; }; owner: string; } & { closed_at: string | null; closed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; external_service: ({ connector_id: string; } & { connector_name: string; external_id: string; external_title: string; external_url: string; pushed_at: string; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; }) | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; } & { id: string; totalComment: number; totalAlerts: number; version: string; } & { comments?: ((({ comment: string; type: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".user; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }) | ({ type: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }) | ({ type: ", - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.CommentType", - "text": "CommentType" - }, - ".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; })) & { id: string; version: string; })[] | undefined; })[]>; getAllCasesMetrics: (query: { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }) => Promise<{ count_open_cases: number; count_in_progress_cases: number; count_closed_cases: number; }>; }; }" + " | undefined; severity?: ", + "CaseSeverity", + " | undefined; reporters?: string | string[] | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; fields?: string | string[] | undefined; from?: string | undefined; page?: number | undefined; perPage?: number | undefined; search?: string | undefined; searchFields?: string | string[] | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<", + "Cases", + ">; getCasesStatus: (query: { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ countOpenCases: number; countInProgressCases: number; countClosedCases: number; }>; getCasesMetrics: (query: { features: string[]; } & { from?: string | undefined; to?: string | undefined; owner?: string | string[] | undefined; }, signal?: AbortSignal | undefined) => Promise<{ mttr?: number | undefined; }>; }; }" ], "path": "x-pack/plugins/cases/public/types.ts", "deprecated": false @@ -768,7 +728,23 @@ "label": "hooks", "description": [], "signature": [ - "{ getUseCasesAddToNewCaseFlyout: (props: AddToNewCaseFlyoutProps) => { open: () => void; close: () => void; }; getUseCasesAddToExistingCaseModal: (props: AddToExistingFlyoutProps) => { open: () => void; close: () => void; }; }" + "{ getUseCasesAddToNewCaseFlyout: (props?: AddToNewCaseFlyoutProps) => { open: ({ attachments }?: { attachments?: ", + { + "pluginId": "cases", + "scope": "public", + "docId": "kibCasesPluginApi", + "section": "def-public.CaseAttachments", + "text": "CaseAttachments" + }, + " | undefined; }) => void; close: () => void; }; getUseCasesAddToExistingCaseModal: (props?: AddToExistingFlyoutProps) => { open: ({ attachments }?: { attachments?: ", + { + "pluginId": "cases", + "scope": "public", + "docId": "kibCasesPluginApi", + "section": "def-public.CaseAttachments", + "text": "CaseAttachments" + }, + " | undefined; }) => void; close: () => void; }; }" ], "path": "x-pack/plugins/cases/public/types.ts", "deprecated": false @@ -783,7 +759,15 @@ "signature": [ "{ canUseCases: (owners?: ", "CasesOwners", - "[] | undefined) => { crud: boolean; read: boolean; }; getRuleIdFromEvent: (event: Event) => { id: string; name: string; }; }" + "[] | undefined) => { crud: boolean; read: boolean; }; getRuleIdFromEvent: (event: Event) => { id: string; name: string; }; groupAlertsByRule: (items: Event[], owner: string) => ", + { + "pluginId": "cases", + "scope": "public", + "docId": "kibCasesPluginApi", + "section": "def-public.CaseAttachments", + "text": "CaseAttachments" + }, + "; }" ], "path": "x-pack/plugins/cases/public/types.ts", "deprecated": false @@ -1106,103 +1090,6 @@ } ], "interfaces": [ - { - "parentPluginId": "cases", - "id": "def-common.Case", - "type": "Interface", - "tags": [], - "label": "Case", - "description": [], - "signature": [ - { - "pluginId": "cases", - "scope": "common", - "docId": "kibCasesPluginApi", - "section": "def-common.Case", - "text": "Case" - }, - " extends BasicCase" - ], - "path": "x-pack/plugins/cases/common/ui/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "cases", - "id": "def-common.Case.connector", - "type": "CompoundType", - "tags": [], - "label": "connector", - "description": [], - "signature": [ - "{ id: string; } & (({ type: ", - "ConnectorTypes", - ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; } & { name: string; }) | ({ type: ", - "ConnectorTypes", - ".none; fields: null; } & { name: string; }) | ({ type: ", - "ConnectorTypes", - ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; } & { name: string; }) | ({ type: ", - "ConnectorTypes", - ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; } & { name: string; }) | ({ type: ", - "ConnectorTypes", - ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; } & { name: string; }) | ({ type: ", - "ConnectorTypes", - ".swimlane; fields: { caseId: string | null; } | null; } & { name: string; }))" - ], - "path": "x-pack/plugins/cases/common/ui/types.ts", - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.Case.description", - "type": "string", - "tags": [], - "label": "description", - "description": [], - "path": "x-pack/plugins/cases/common/ui/types.ts", - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.Case.externalService", - "type": "CompoundType", - "tags": [], - "label": "externalService", - "description": [], - "signature": [ - "{ connectorId: string; connectorName: string; externalId: string; externalTitle: string; externalUrl: string; pushedAt: string; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; }; } | null" - ], - "path": "x-pack/plugins/cases/common/ui/types.ts", - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.Case.settings", - "type": "Object", - "tags": [], - "label": "settings", - "description": [], - "signature": [ - "{ syncAlerts: boolean; }" - ], - "path": "x-pack/plugins/cases/common/ui/types.ts", - "deprecated": false - }, - { - "parentPluginId": "cases", - "id": "def-common.Case.tags", - "type": "Array", - "tags": [], - "label": "tags", - "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/cases/common/ui/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "cases", "id": "def-common.Ecs", @@ -1294,6 +1181,68 @@ } ], "misc": [ + { + "parentPluginId": "cases", + "id": "def-common.Case", + "type": "Type", + "tags": [], + "label": "Case", + "description": [], + "signature": [ + "Omit<{ description: string; status: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CaseStatuses", + "text": "CaseStatuses" + }, + "; tags: string[]; title: string; connector: { id: string; type: ", + "ConnectorTypes", + ".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; name: string; } | { id: string; type: ", + "ConnectorTypes", + ".none; fields: null; name: string; } | { id: string; type: ", + "ConnectorTypes", + ".resilient; fields: { incidentTypes: string[] | null; severityCode: string | null; } | null; name: string; } | { id: string; type: ", + "ConnectorTypes", + ".serviceNowITSM; fields: { impact: string | null; severity: string | null; urgency: string | null; category: string | null; subcategory: string | null; } | null; name: string; } | { id: string; type: ", + "ConnectorTypes", + ".serviceNowSIR; fields: { category: string | null; destIp: boolean | null; malwareHash: boolean | null; malwareUrl: boolean | null; priority: string | null; sourceIp: boolean | null; subcategory: string | null; } | null; name: string; } | { id: string; type: ", + "ConnectorTypes", + ".swimlane; fields: { caseId: string | null; } | null; name: string; }; settings: { syncAlerts: boolean; }; owner: string; severity: ", + "CaseSeverity", + "; duration: number | null; closedAt: string | null; closedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; } | null; createdAt: string; createdBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; }; externalService: { connectorId: string; connectorName: string; externalId: string; externalTitle: string; externalUrl: string; pushedAt: string; pushedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; }; } | null; updatedAt: string | null; updatedBy: { email: string | null | undefined; fullName: string | null | undefined; username: string | null | undefined; } | null; id: string; totalComment: number; totalAlerts: number; version: string; comments?: ((({ comment: string; type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".user; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".alert; alertId: string | string[]; index: string | string[]; rule: { id: string | null; name: string | null; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; }) | ({ type: ", + { + "pluginId": "cases", + "scope": "common", + "docId": "kibCasesPluginApi", + "section": "def-common.CommentType", + "text": "CommentType" + }, + ".actions; comment: string; actions: { targets: { hostname: string; endpointId: string; }[]; type: string; }; owner: string; } & { created_at: string; created_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; }; owner: string; pushed_at: string | null; pushed_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; updated_at: string | null; updated_by: { email: string | null | undefined; full_name: string | null | undefined; username: string | null | undefined; } | null; })) & { id: string; version: string; })[] | undefined; }, \"comments\"> & { comments: ", + "Comment", + "[]; }" + ], + "path": "x-pack/plugins/cases/common/ui/types.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "cases", "id": "def-common.CASES_URL", @@ -1319,7 +1268,7 @@ "description": [], "signature": [ "{ alerts?: { sync?: boolean | undefined; enabled?: boolean | undefined; } | undefined; metrics?: ", - "CaseMetricsFeature", + "SingleCaseMetricsFeature", "[] | undefined; }" ], "path": "x-pack/plugins/cases/common/ui/types.ts", diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index 3b1c2a5e78c50..948048051b216 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cases title: "cases" image: https://source.unsplash.com/400x175/?github summary: API docs for the cases plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [ResponseOps](https://github.com/orgs/elastic/teams/response-ops) for qu | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 71 | 0 | 57 | 19 | +| 66 | 0 | 52 | 22 | ## Client diff --git a/api_docs/charts.devdocs.json b/api_docs/charts.devdocs.json index 584443f5b46dc..be63a2508fdb5 100644 --- a/api_docs/charts.devdocs.json +++ b/api_docs/charts.devdocs.json @@ -970,7 +970,7 @@ "label": "name", "description": [], "signature": [ - "\"filterBucket\"" + "\"filter\"" ], "path": "src/plugins/charts/public/static/utils/transform_click_event.ts", "deprecated": false diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index 0fe3642f18398..d89dbf0e17115 100644 --- a/api_docs/charts.mdx +++ b/api_docs/charts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/charts title: "charts" image: https://source.unsplash.com/400x175/?github summary: API docs for the charts plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/cloud.devdocs.json b/api_docs/cloud.devdocs.json index 946bfa90c7245..2434130292270 100644 --- a/api_docs/cloud.devdocs.json +++ b/api_docs/cloud.devdocs.json @@ -119,7 +119,7 @@ "label": "full_story", "description": [], "signature": [ - "{ enabled: boolean; org_id?: string | undefined; }" + "{ enabled: boolean; org_id?: string | undefined; eventTypesAllowlist?: string[] | undefined; }" ], "path": "x-pack/plugins/cloud/public/plugin.tsx", "deprecated": false @@ -372,6 +372,19 @@ "path": "x-pack/plugins/cloud/server/plugin.ts", "deprecated": false }, + { + "parentPluginId": "cloud", + "id": "def-server.CloudSetup.instanceSizeMb", + "type": "number", + "tags": [], + "label": "instanceSizeMb", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/cloud/server/plugin.ts", + "deprecated": false + }, { "parentPluginId": "cloud", "id": "def-server.CloudSetup.apm", diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index ccf2076033b67..b85c6af643fb9 100644 --- a/api_docs/cloud.mdx +++ b/api_docs/cloud.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloud title: "cloud" image: https://source.unsplash.com/400x175/?github summary: API docs for the cloud plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 28 | 0 | 23 | 0 | +| 29 | 0 | 24 | 0 | ## Client diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx index d487aab1a4754..370fd13f60765 100644 --- a/api_docs/cloud_security_posture.mdx +++ b/api_docs/cloud_security_posture.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture title: "cloudSecurityPosture" image: https://source.unsplash.com/400x175/?github summary: API docs for the cloudSecurityPosture plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/console.mdx b/api_docs/console.mdx index 4d91e53febaf7..18e4ad056b1c1 100644 --- a/api_docs/console.mdx +++ b/api_docs/console.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/console title: "console" image: https://source.unsplash.com/400x175/?github summary: API docs for the console plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/controls.devdocs.json b/api_docs/controls.devdocs.json index fe22caa955878..0901e5fd0cb85 100644 --- a/api_docs/controls.devdocs.json +++ b/api_docs/controls.devdocs.json @@ -1565,13 +1565,45 @@ }, { "parentPluginId": "controls", - "id": "def-public.OptionsListEmbeddableFactory.controlEditorComponent", + "id": "def-public.OptionsListEmbeddableFactory.isFieldCompatible", "type": "Function", "tags": [], - "label": "controlEditorComponent", + "label": "isFieldCompatible", "description": [], "signature": [ - "({ onChange, initialInput, setValidState, setDefaultTitle, getRelevantDataViewId, setLastUsedDataViewId, }: ", + "(dataControlField: ", + "DataControlField", + ") => void" + ], + "path": "src/plugins/controls/public/control_types/options_list/options_list_embeddable_factory.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "controls", + "id": "def-public.OptionsListEmbeddableFactory.isFieldCompatible.$1", + "type": "Object", + "tags": [], + "label": "dataControlField", + "description": [], + "signature": [ + "DataControlField" + ], + "path": "src/plugins/controls/public/control_types/options_list/options_list_embeddable_factory.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "controls", + "id": "def-public.OptionsListEmbeddableFactory.controlEditorOptionsComponent", + "type": "Function", + "tags": [], + "label": "controlEditorOptionsComponent", + "description": [], + "signature": [ + "({ initialInput, onChange, }: ", { "pluginId": "controls", "scope": "public", @@ -1595,7 +1627,7 @@ "children": [ { "parentPluginId": "controls", - "id": "def-public.OptionsListEmbeddableFactory.controlEditorComponent.$1", + "id": "def-public.OptionsListEmbeddableFactory.controlEditorOptionsComponent.$1", "type": "Object", "tags": [], "label": "__0", @@ -1618,7 +1650,7 @@ }, ">" ], - "path": "src/plugins/controls/public/control_types/options_list/options_list_editor.tsx", + "path": "src/plugins/controls/public/control_types/options_list/options_list_editor_options.tsx", "deprecated": false } ] @@ -2372,63 +2404,35 @@ }, { "parentPluginId": "controls", - "id": "def-public.RangeSliderEmbeddableFactory.controlEditorComponent", + "id": "def-public.RangeSliderEmbeddableFactory.isFieldCompatible", "type": "Function", "tags": [], - "label": "controlEditorComponent", + "label": "isFieldCompatible", "description": [], "signature": [ - "({ onChange, initialInput, setValidState, setDefaultTitle, getRelevantDataViewId, setLastUsedDataViewId, }: ", - { - "pluginId": "controls", - "scope": "public", - "docId": "kibControlsPluginApi", - "section": "def-public.ControlEditorProps", - "text": "ControlEditorProps" - }, - "<", - { - "pluginId": "controls", - "scope": "common", - "docId": "kibControlsPluginApi", - "section": "def-common.RangeSliderEmbeddableInput", - "text": "RangeSliderEmbeddableInput" - }, - ">) => JSX.Element" + "(dataControlField: ", + "DataControlField", + ") => void" ], "path": "src/plugins/controls/public/control_types/range_slider/range_slider_embeddable_factory.tsx", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "controls", - "id": "def-public.RangeSliderEmbeddableFactory.controlEditorComponent.$1", + "id": "def-public.RangeSliderEmbeddableFactory.isFieldCompatible.$1", "type": "Object", "tags": [], - "label": "__0", + "label": "dataControlField", "description": [], "signature": [ - { - "pluginId": "controls", - "scope": "public", - "docId": "kibControlsPluginApi", - "section": "def-public.ControlEditorProps", - "text": "ControlEditorProps" - }, - "<", - { - "pluginId": "controls", - "scope": "common", - "docId": "kibControlsPluginApi", - "section": "def-common.RangeSliderEmbeddableInput", - "text": "RangeSliderEmbeddableInput" - }, - ">" + "DataControlField" ], - "path": "src/plugins/controls/public/control_types/range_slider/range_slider_editor.tsx", - "deprecated": false + "path": "src/plugins/controls/public/control_types/range_slider/range_slider_embeddable_factory.tsx", + "deprecated": false, + "isRequired": true } - ] + ], + "returnComment": [] }, { "parentPluginId": "controls", @@ -2758,51 +2762,6 @@ "path": "src/plugins/controls/public/types.ts", "deprecated": false }, - { - "parentPluginId": "controls", - "id": "def-public.ControlEditorProps.getRelevantDataViewId", - "type": "Function", - "tags": [], - "label": "getRelevantDataViewId", - "description": [], - "signature": [ - "(() => string | undefined) | undefined" - ], - "path": "src/plugins/controls/public/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "controls", - "id": "def-public.ControlEditorProps.setLastUsedDataViewId", - "type": "Function", - "tags": [], - "label": "setLastUsedDataViewId", - "description": [], - "signature": [ - "((newId: string) => void) | undefined" - ], - "path": "src/plugins/controls/public/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "controls", - "id": "def-public.ControlEditorProps.setLastUsedDataViewId.$1", - "type": "string", - "tags": [], - "label": "newId", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/controls/public/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, { "parentPluginId": "controls", "id": "def-public.ControlEditorProps.onChange", @@ -2832,66 +2791,6 @@ } ], "returnComment": [] - }, - { - "parentPluginId": "controls", - "id": "def-public.ControlEditorProps.setValidState", - "type": "Function", - "tags": [], - "label": "setValidState", - "description": [], - "signature": [ - "(valid: boolean) => void" - ], - "path": "src/plugins/controls/public/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "controls", - "id": "def-public.ControlEditorProps.setValidState.$1", - "type": "boolean", - "tags": [], - "label": "valid", - "description": [], - "signature": [ - "boolean" - ], - "path": "src/plugins/controls/public/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "controls", - "id": "def-public.ControlEditorProps.setDefaultTitle", - "type": "Function", - "tags": [], - "label": "setDefaultTitle", - "description": [], - "signature": [ - "(defaultTitle: string) => void" - ], - "path": "src/plugins/controls/public/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "controls", - "id": "def-public.ControlEditorProps.setDefaultTitle.$1", - "type": "string", - "tags": [], - "label": "defaultTitle", - "description": [], - "signature": [ - "string" - ], - "path": "src/plugins/controls/public/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] } ], "initialIsOpen": false @@ -2958,6 +2857,19 @@ "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false }, + { + "parentPluginId": "controls", + "id": "def-public.ControlGroupInput.defaultControlGrow", + "type": "CompoundType", + "tags": [], + "label": "defaultControlGrow", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/controls/common/control_group/types.ts", + "deprecated": false + }, { "parentPluginId": "controls", "id": "def-public.ControlGroupInput.controlStyle", @@ -3017,10 +2929,10 @@ "children": [ { "parentPluginId": "controls", - "id": "def-public.IEditableControlFactory.controlEditorComponent", + "id": "def-public.IEditableControlFactory.controlEditorOptionsComponent", "type": "Function", "tags": [], - "label": "controlEditorComponent", + "label": "controlEditorOptionsComponent", "description": [], "signature": [ "((props: ", @@ -3038,7 +2950,7 @@ "children": [ { "parentPluginId": "controls", - "id": "def-public.IEditableControlFactory.controlEditorComponent.$1", + "id": "def-public.IEditableControlFactory.controlEditorOptionsComponent.$1", "type": "Object", "tags": [], "label": "props", @@ -3134,6 +3046,38 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "controls", + "id": "def-public.IEditableControlFactory.isFieldCompatible", + "type": "Function", + "tags": [], + "label": "isFieldCompatible", + "description": [], + "signature": [ + "((dataControlField: ", + "DataControlField", + ") => void) | undefined" + ], + "path": "src/plugins/controls/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "controls", + "id": "def-public.IEditableControlFactory.isFieldCompatible.$1", + "type": "Object", + "tags": [], + "label": "dataControlField", + "description": [], + "signature": [ + "DataControlField" + ], + "path": "src/plugins/controls/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -3172,6 +3116,19 @@ "path": "src/plugins/controls/common/control_types/options_list/types.ts", "deprecated": false }, + { + "parentPluginId": "controls", + "id": "def-public.OptionsListEmbeddableInput.runPastTimeout", + "type": "CompoundType", + "tags": [], + "label": "runPastTimeout", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/controls/common/control_types/options_list/types.ts", + "deprecated": false + }, { "parentPluginId": "controls", "id": "def-public.OptionsListEmbeddableInput.singleSelect", @@ -3507,7 +3464,7 @@ "label": "ControlWidth", "description": [], "signature": [ - "\"auto\" | \"small\" | \"medium\" | \"large\"" + "\"small\" | \"medium\" | \"large\"" ], "path": "src/plugins/controls/common/types.ts", "deprecated": false, @@ -3967,6 +3924,19 @@ "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false }, + { + "parentPluginId": "controls", + "id": "def-common.ControlGroupInput.defaultControlGrow", + "type": "CompoundType", + "tags": [], + "label": "defaultControlGrow", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/controls/common/control_group/types.ts", + "deprecated": false + }, { "parentPluginId": "controls", "id": "def-common.ControlGroupInput.controlStyle", @@ -4123,10 +4093,20 @@ "label": "width", "description": [], "signature": [ - "\"auto\" | \"small\" | \"medium\" | \"large\"" + "\"small\" | \"medium\" | \"large\"" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false + }, + { + "parentPluginId": "controls", + "id": "def-common.ControlPanelState.grow", + "type": "boolean", + "tags": [], + "label": "grow", + "description": [], + "path": "src/plugins/controls/common/control_group/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -4201,6 +4181,19 @@ "path": "src/plugins/controls/common/control_types/options_list/types.ts", "deprecated": false }, + { + "parentPluginId": "controls", + "id": "def-common.OptionsListEmbeddableInput.runPastTimeout", + "type": "CompoundType", + "tags": [], + "label": "runPastTimeout", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/controls/common/control_types/options_list/types.ts", + "deprecated": false + }, { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput.singleSelect", @@ -4292,7 +4285,7 @@ "label": "ControlWidth", "description": [], "signature": [ - "\"auto\" | \"small\" | \"medium\" | \"large\"" + "\"small\" | \"medium\" | \"large\"" ], "path": "src/plugins/controls/common/types.ts", "deprecated": false, @@ -4320,7 +4313,7 @@ "label": "DEFAULT_CONTROL_WIDTH", "description": [], "signature": [ - "\"auto\" | \"small\" | \"medium\" | \"large\"" + "\"small\" | \"medium\" | \"large\"" ], "path": "src/plugins/controls/common/control_group/control_group_constants.ts", "deprecated": false, diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index 870bc6876f2c6..8f83075baf584 100644 --- a/api_docs/controls.mdx +++ b/api_docs/controls.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/controls title: "controls" image: https://source.unsplash.com/400x175/?github summary: API docs for the controls plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-prese | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 203 | 0 | 197 | 6 | +| 205 | 0 | 199 | 7 | ## Client diff --git a/api_docs/core.devdocs.json b/api_docs/core.devdocs.json index ae6443972aefb..97dd65c8d16c3 100644 --- a/api_docs/core.devdocs.json +++ b/api_docs/core.devdocs.json @@ -727,7 +727,9 @@ "type": "Object", "tags": [], "label": "eventTypeOps", - "description": [], + "description": [ + "The definition of the event type {@link EventTypeOpts }." + ], "signature": [ "EventTypeOpts", "" @@ -937,6 +939,23 @@ ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.AnalyticsClient.shutdown", + "type": "Function", + "tags": [], + "label": "shutdown", + "description": [ + "\r\nStops the client." + ], + "signature": [ + "() => void" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -1196,7 +1215,23 @@ "{@link AnalyticsServiceSetup}" ], "signature": [ - "AnalyticsClient" + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" ], "path": "src/core/public/index.ts", "deprecated": false @@ -1344,12 +1379,7 @@ "path": "src/core/public/index.ts", "deprecated": true, "removeBy": "8.8.0", - "references": [ - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/plugin.ts" - } - ] + "references": [] }, { "parentPluginId": "core", @@ -1727,14 +1757,6 @@ { "plugin": "monitoring", "path": "x-pack/plugins/monitoring/public/legacy_shims.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/data_model/search_api.ts" - }, - { - "plugin": "visTypeVega", - "path": "src/plugins/vis_types/vega/public/plugin.ts" } ] } @@ -2147,6 +2169,51 @@ "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ + { + "parentPluginId": "core", + "id": "def-public.EventContext.cluster_uuid", + "type": "string", + "tags": [], + "label": "cluster_uuid", + "description": [ + "\r\nThe UUID of the cluster" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.EventContext.cluster_name", + "type": "string", + "tags": [], + "label": "cluster_name", + "description": [ + "\r\nThe name of the cluster." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.EventContext.license_id", + "type": "string", + "tags": [], + "label": "license_id", + "description": [ + "\r\nThe license ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, { "parentPluginId": "core", "id": "def-public.EventContext.userId", @@ -2243,7 +2310,9 @@ "type": "IndexSignature", "tags": [], "label": "[key: string]: unknown", - "description": [], + "description": [ + "\r\nAdditional keys are allowed." + ], "signature": [ "[key: string]: unknown" ], @@ -2808,7 +2877,9 @@ "type": "Object", "tags": [], "label": "newContext", - "description": [], + "description": [ + "The full new context to set {@link EventContext }" + ], "signature": [ "EventContext" ], @@ -2836,6 +2907,23 @@ ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.IShipper.shutdown", + "type": "Function", + "tags": [], + "label": "shutdown", + "description": [ + "\r\nShutdown the shipper." + ], + "signature": [ + "() => void" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -3234,25 +3322,25 @@ "{@link ToastsSetup}" ], "signature": [ - "{ get$: () => ", - "Observable", - "<", + "{ add: (toastOrTitle: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "section": "def-public.ToastInput", + "text": "ToastInput" }, - "[]>; add: (toastOrTitle: ", + ") => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "section": "def-public.Toast", + "text": "Toast" }, - ") => ", + "; get$: () => ", + "Observable", + "<", { "pluginId": "core", "scope": "public", @@ -3260,7 +3348,7 @@ "section": "def-public.Toast", "text": "Toast" }, - "; remove: (toastOrId: string | ", + "[]>; remove: (toastOrId: string | ", { "pluginId": "core", "scope": "public", @@ -3408,25 +3496,25 @@ "{@link ToastsStart}" ], "signature": [ - "{ get$: () => ", - "Observable", - "<", + "{ add: (toastOrTitle: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "section": "def-public.ToastInput", + "text": "ToastInput" }, - "[]>; add: (toastOrTitle: ", + ") => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "section": "def-public.Toast", + "text": "Toast" }, - ") => ", + "; get$: () => ", + "Observable", + "<", { "pluginId": "core", "scope": "public", @@ -3434,7 +3522,7 @@ "section": "def-public.Toast", "text": "Toast" }, - "; remove: (toastOrId: string | ", + "[]>; remove: (toastOrId: string | ", { "pluginId": "core", "scope": "public", @@ -6932,10 +7020,10 @@ }, { "parentPluginId": "core", - "id": "def-public.ShipperClassConstructor.Unnamed", - "type": "Any", + "id": "def-public.ShipperClassConstructor.new", + "type": "Function", "tags": [], - "label": "Unnamed", + "label": "new", "description": [ "\r\nThe constructor" ], @@ -6943,7 +7031,42 @@ "any" ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.ShipperClassConstructor.new.$1", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [ + "The shipper's custom config" + ], + "signature": [ + "Config" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.ShipperClassConstructor.new.$2", + "type": "Object", + "tags": [], + "label": "initContext", + "description": [ + "Common context {@link AnalyticsClientInitContext }" + ], + "signature": [ + "AnalyticsClientInitContext" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -7478,7 +7601,23 @@ "\nExposes the public APIs of the AnalyticsClient during the setup phase.\n{@link AnalyticsClient}" ], "signature": [ - "AnalyticsClient" + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" ], "path": "src/core/public/analytics/analytics_service.ts", "deprecated": false, @@ -7592,25 +7731,25 @@ "\nMethods for adding and removing global toast messages. See {@link ToastsApi}." ], "signature": [ - "{ get$: () => ", - "Observable", - "<", + "{ add: (toastOrTitle: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "section": "def-public.ToastInput", + "text": "ToastInput" }, - "[]>; add: (toastOrTitle: ", + ") => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "section": "def-public.Toast", + "text": "Toast" }, - ") => ", + "; get$: () => ", + "Observable", + "<", { "pluginId": "core", "scope": "public", @@ -7618,7 +7757,7 @@ "section": "def-public.Toast", "text": "Toast" }, - "; remove: (toastOrId: string | ", + "[]>; remove: (toastOrId: string | ", { "pluginId": "core", "scope": "public", @@ -8114,25 +8253,25 @@ "\n{@link IToasts}" ], "signature": [ - "{ get$: () => ", - "Observable", - "<", + "{ add: (toastOrTitle: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "section": "def-public.ToastInput", + "text": "ToastInput" }, - "[]>; add: (toastOrTitle: ", + ") => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "section": "def-public.Toast", + "text": "Toast" }, - ") => ", + "; get$: () => ", + "Observable", + "<", { "pluginId": "core", "scope": "public", @@ -8140,7 +8279,7 @@ "section": "def-public.Toast", "text": "Toast" }, - "; remove: (toastOrId: string | ", + "[]>; remove: (toastOrId: string | ", { "pluginId": "core", "scope": "public", @@ -8276,25 +8415,25 @@ "\n{@link IToasts}" ], "signature": [ - "{ get$: () => ", - "Observable", - "<", + "{ add: (toastOrTitle: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "section": "def-public.ToastInput", + "text": "ToastInput" }, - "[]>; add: (toastOrTitle: ", + ") => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "section": "def-public.Toast", + "text": "Toast" }, - ") => ", + "; get$: () => ", + "Observable", + "<", { "pluginId": "core", "scope": "public", @@ -8302,7 +8441,7 @@ "section": "def-public.Toast", "text": "Toast" }, - "; remove: (toastOrId: string | ", + "[]>; remove: (toastOrId: string | ", { "pluginId": "core", "scope": "public", @@ -9116,7 +9255,9 @@ "type": "Object", "tags": [], "label": "eventTypeOps", - "description": [], + "description": [ + "The definition of the event type {@link EventTypeOpts }." + ], "signature": [ "EventTypeOpts", "" @@ -9326,6 +9467,23 @@ ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.AnalyticsClient.shutdown", + "type": "Function", + "tags": [], + "label": "shutdown", + "description": [ + "\r\nStops the client." + ], + "signature": [ + "() => void" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -9999,6 +10157,21 @@ ], "path": "node_modules/@types/kbn__config/index.d.ts", "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.ConfigDeprecationContext.docLinks", + "type": "Object", + "tags": [], + "label": "docLinks", + "description": [ + "Allow direct access to the doc links from the deprecation handler" + ], + "signature": [ + "DocLinks" + ], + "path": "node_modules/@types/kbn__config/index.d.ts", + "deprecated": false } ], "initialIsOpen": false @@ -10534,7 +10707,23 @@ "{@link AnalyticsServicePreboot}" ], "signature": [ - "AnalyticsClient" + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" ], "path": "src/core/server/index.ts", "deprecated": false @@ -10792,7 +10981,23 @@ "{@link AnalyticsServiceSetup}" ], "signature": [ - "AnalyticsClient" + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" ], "path": "src/core/server/index.ts", "deprecated": false @@ -12366,6 +12571,51 @@ "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false, "children": [ + { + "parentPluginId": "core", + "id": "def-server.EventContext.cluster_uuid", + "type": "string", + "tags": [], + "label": "cluster_uuid", + "description": [ + "\r\nThe UUID of the cluster" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.cluster_name", + "type": "string", + "tags": [], + "label": "cluster_name", + "description": [ + "\r\nThe name of the cluster." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.EventContext.license_id", + "type": "string", + "tags": [], + "label": "license_id", + "description": [ + "\r\nThe license ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false + }, { "parentPluginId": "core", "id": "def-server.EventContext.userId", @@ -12462,7 +12712,9 @@ "type": "IndexSignature", "tags": [], "label": "[key: string]: unknown", - "description": [], + "description": [ + "\r\nAdditional keys are allowed." + ], "signature": [ "[key: string]: unknown" ], @@ -12620,7 +12872,7 @@ "Headers used for authentication against Elasticsearch" ], "signature": [ - "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; range?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "src/core/server/elasticsearch/types.ts", "deprecated": false @@ -14983,7 +15235,9 @@ "section": "def-server.RequestHandlerContext", "text": "RequestHandlerContext" }, - ", any, { custom: | Error | { message: string | Error; attributes?: ", + ", any, { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -14991,9 +15245,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -15102,6 +15354,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -15109,11 +15363,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -15133,9 +15385,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -15145,9 +15397,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -15157,9 +15409,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -15177,7 +15429,9 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | { message: string | Error; attributes?: ", + ", response: { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -15185,9 +15439,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -15296,6 +15548,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -15303,11 +15557,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -15327,9 +15579,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -15339,9 +15591,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -15351,9 +15603,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -15417,7 +15669,9 @@ "section": "def-server.RequestHandlerContext", "text": "RequestHandlerContext" }, - ", any, { custom: | Error | { message: string | Error; attributes?: ", + ", any, { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -15425,9 +15679,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -15536,6 +15788,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -15543,11 +15797,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -15567,9 +15819,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -15579,9 +15831,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -15591,9 +15843,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -18521,7 +18773,9 @@ "type": "Object", "tags": [], "label": "newContext", - "description": [], + "description": [ + "The full new context to set {@link EventContext }" + ], "signature": [ "EventContext" ], @@ -18549,6 +18803,23 @@ ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.IShipper.shutdown", + "type": "Function", + "tags": [], + "label": "shutdown", + "description": [ + "\r\nShutdown the shipper." + ], + "signature": [ + "() => void" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -22942,10 +23213,10 @@ }, { "parentPluginId": "core", - "id": "def-server.ShipperClassConstructor.Unnamed", - "type": "Any", + "id": "def-server.ShipperClassConstructor.new", + "type": "Function", "tags": [], - "label": "Unnamed", + "label": "new", "description": [ "\r\nThe constructor" ], @@ -22953,7 +23224,42 @@ "any" ], "path": "node_modules/@types/kbn__analytics-client/index.d.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ShipperClassConstructor.new.$1", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [ + "The shipper's custom config" + ], + "signature": [ + "Config" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ShipperClassConstructor.new.$2", + "type": "Object", + "tags": [], + "label": "initContext", + "description": [ + "Common context {@link AnalyticsClientInitContext }" + ], + "signature": [ + "AnalyticsClientInitContext" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -23929,7 +24235,23 @@ "\nExposes the public APIs of the AnalyticsClient during the preboot phase\n{@link AnalyticsClient}" ], "signature": [ - "AnalyticsClient" + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" ], "path": "src/core/server/analytics/analytics_service.ts", "deprecated": false, @@ -23945,7 +24267,23 @@ "\nExposes the public APIs of the AnalyticsClient during the setup phase.\n{@link AnalyticsClient}" ], "signature": [ - "AnalyticsClient" + "{ optIn: (optInConfig: ", + "OptInConfig", + ") => void; reportEvent: >(eventType: string, eventData: EventTypeData) => void; readonly telemetryCounter$: ", + "Observable", + "<", + "TelemetryCounter", + ">; registerEventType: (eventTypeOps: ", + "EventTypeOpts", + ") => void; registerShipper: (Shipper: ", + "ShipperClassConstructor", + ", shipperConfig: ShipperConfig, opts?: ", + "RegisterShipperOpts", + " | undefined) => void; registerContextProvider: (contextProviderOpts: ", + "ContextProviderOpts", + ") => void; removeContextProvider: (contextProviderName: string) => void; }" ], "path": "src/core/server/analytics/analytics_service.ts", "deprecated": false, @@ -24339,7 +24677,7 @@ "label": "EcsEventCategory", "description": [], "signature": [ - "\"database\" | \"package\" | \"network\" | \"web\" | \"host\" | \"session\" | \"file\" | \"registry\" | \"process\" | \"authentication\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" + "\"database\" | \"package\" | \"network\" | \"web\" | \"file\" | \"host\" | \"session\" | \"registry\" | \"process\" | \"authentication\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" ], "path": "node_modules/@types/kbn__logging/index.d.ts", "deprecated": false, @@ -24353,7 +24691,7 @@ "label": "EcsEventKind", "description": [], "signature": [ - "\"alert\" | \"metric\" | \"event\" | \"state\" | \"signal\" | \"pipeline_error\"" + "\"alert\" | \"state\" | \"metric\" | \"event\" | \"signal\" | \"pipeline_error\"" ], "path": "node_modules/@types/kbn__logging/index.d.ts", "deprecated": false, @@ -25609,7 +25947,7 @@ "section": "def-server.ElasticsearchConfig", "text": "ElasticsearchConfig" }, - ", \"username\" | \"customHeaders\" | \"hosts\" | \"password\" | \"sniffOnStart\" | \"sniffInterval\" | \"sniffOnConnectionFault\" | \"maxSockets\" | \"compression\" | \"serviceAccountToken\" | \"requestHeadersWhitelist\"> & { pingTimeout?: number | moment.Duration | undefined; requestTimeout?: number | moment.Duration | undefined; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"verificationMode\" | \"certificate\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; caFingerprint?: string | undefined; }" + ", \"username\" | \"password\" | \"customHeaders\" | \"hosts\" | \"sniffOnStart\" | \"sniffInterval\" | \"sniffOnConnectionFault\" | \"maxSockets\" | \"compression\" | \"serviceAccountToken\" | \"requestHeadersWhitelist\"> & { pingTimeout?: number | moment.Duration | undefined; requestTimeout?: number | moment.Duration | undefined; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"verificationMode\" | \"certificate\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; caFingerprint?: string | undefined; }" ], "path": "src/core/server/elasticsearch/client/client_config.ts", "deprecated": false, @@ -25778,7 +26116,9 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | { message: string | Error; attributes?: ", + ", response: { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -25786,9 +26126,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -25897,6 +26235,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -25904,11 +26244,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -25928,9 +26266,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -25940,9 +26278,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -25952,9 +26290,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -26089,7 +26427,9 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | { message: string | Error; attributes?: ", + ", response: { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -26097,9 +26437,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -26208,6 +26546,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -26215,11 +26555,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -26239,9 +26577,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -26251,9 +26589,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -26263,9 +26601,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -26318,7 +26656,9 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | { message: string | Error; attributes?: ", + ", response: { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -26326,9 +26666,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -26437,6 +26775,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -26444,11 +26784,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -26468,9 +26806,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -26480,9 +26818,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -26492,9 +26830,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", diff --git a/api_docs/core.mdx b/api_docs/core.mdx index 765f93b5bb6f9..8dac39426a028 100644 --- a/api_docs/core.mdx +++ b/api_docs/core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core title: "core" image: https://source.unsplash.com/400x175/?github summary: API docs for the core plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2524 | 15 | 977 | 33 | +| 2541 | 15 | 977 | 33 | ## Client diff --git a/api_docs/core_application.mdx b/api_docs/core_application.mdx index 680c5de7566c6..23dc2eaf1abbf 100644 --- a/api_docs/core_application.mdx +++ b/api_docs/core_application.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-application title: "core.application" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.application plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2524 | 15 | 977 | 33 | +| 2541 | 15 | 977 | 33 | ## Client diff --git a/api_docs/core_chrome.devdocs.json b/api_docs/core_chrome.devdocs.json index 2cfff911cd3a3..90f19604102ac 100644 --- a/api_docs/core_chrome.devdocs.json +++ b/api_docs/core_chrome.devdocs.json @@ -1886,7 +1886,7 @@ "signature": [ "{ iconType?: ", "IconType", - " | undefined; 'data-test-subj'?: string | undefined; rel?: string | undefined; target?: string | undefined; }" + " | undefined; 'data-test-subj'?: string | undefined; rel?: string | undefined; target?: string | (string & {}) | undefined; }" ], "path": "src/core/public/chrome/ui/header/header_help_menu.tsx", "deprecated": false, diff --git a/api_docs/core_chrome.mdx b/api_docs/core_chrome.mdx index 43eda7a95eaf8..836ab672a0b60 100644 --- a/api_docs/core_chrome.mdx +++ b/api_docs/core_chrome.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-chrome title: "core.chrome" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.chrome plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2524 | 15 | 977 | 33 | +| 2541 | 15 | 977 | 33 | ## Client diff --git a/api_docs/core_http.devdocs.json b/api_docs/core_http.devdocs.json index ea42549b15bf9..150cde0435095 100644 --- a/api_docs/core_http.devdocs.json +++ b/api_docs/core_http.devdocs.json @@ -2345,7 +2345,7 @@ "\nReadonly copy of incoming request headers." ], "signature": [ - "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; range?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "src/core/server/http/router/request.ts", "deprecated": false @@ -3265,9 +3265,9 @@ "HTTP message to send to the client" ], "signature": [ - "string | Record | Buffer | ", + "string | Record | ", "Stream", - " | undefined" + " | Buffer | undefined" ], "path": "src/core/server/http/router/response.ts", "deprecated": false @@ -3478,7 +3478,7 @@ "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." ], "signature": [ - "{ remove: (path: string) => string; get: (request: ", + "{ get: (request: ", { "pluginId": "core", "scope": "server", @@ -3494,7 +3494,7 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", requestSpecificBasePath: string) => void; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" + ", requestSpecificBasePath: string) => void; remove: (path: string) => string; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" ], "path": "src/core/server/http/types.ts", "deprecated": false @@ -3845,7 +3845,7 @@ "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." ], "signature": [ - "{ remove: (path: string) => string; get: (request: ", + "{ get: (request: ", { "pluginId": "core", "scope": "server", @@ -3861,7 +3861,7 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", requestSpecificBasePath: string) => void; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" + ", requestSpecificBasePath: string) => void; remove: (path: string) => string; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" ], "path": "src/core/server/http/types.ts", "deprecated": false @@ -4051,7 +4051,7 @@ "\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}." ], "signature": [ - "{ remove: (path: string) => string; get: (request: ", + "{ get: (request: ", { "pluginId": "core", "scope": "server", @@ -4067,7 +4067,7 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", requestSpecificBasePath: string) => void; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" + ", requestSpecificBasePath: string) => void; remove: (path: string) => string; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" ], "path": "src/core/server/http/types.ts", "deprecated": false @@ -4487,7 +4487,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | { message: string | Error; attributes?: ", + " | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -4495,9 +4497,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -4606,6 +4606,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -4613,11 +4615,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -4637,9 +4637,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -4649,9 +4649,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -4661,9 +4661,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -4719,7 +4719,9 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | { message: string | Error; attributes?: ", + ", response: { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -4727,9 +4729,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -4838,6 +4838,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -4845,11 +4847,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -4869,9 +4869,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -4881,9 +4881,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -4893,9 +4893,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -5003,7 +5003,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | { message: string | Error; attributes?: ", + " | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -5011,9 +5013,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -5122,6 +5122,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -5129,11 +5131,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -5153,9 +5153,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -5165,9 +5165,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -5177,9 +5177,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -5235,7 +5235,9 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | { message: string | Error; attributes?: ", + ", response: { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -5243,9 +5245,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -5354,6 +5354,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -5361,11 +5363,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -5385,9 +5385,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -5397,9 +5397,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -5409,9 +5409,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -5519,7 +5519,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | { message: string | Error; attributes?: ", + " | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -5527,9 +5529,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -5638,6 +5638,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -5645,11 +5647,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -5669,9 +5669,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -5681,9 +5681,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -5693,9 +5693,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -5751,7 +5751,9 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | { message: string | Error; attributes?: ", + ", response: { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -5759,9 +5761,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -5870,6 +5870,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -5877,11 +5879,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -5901,9 +5901,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -5913,9 +5913,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -5925,9 +5925,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -6035,7 +6035,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | { message: string | Error; attributes?: ", + " | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -6043,9 +6045,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -6154,6 +6154,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -6161,11 +6163,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -6185,9 +6185,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -6197,9 +6197,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -6209,9 +6209,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -6267,7 +6267,9 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | { message: string | Error; attributes?: ", + ", response: { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -6275,9 +6277,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -6386,6 +6386,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -6393,11 +6395,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -6417,9 +6417,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -6429,9 +6429,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -6441,9 +6441,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -6551,7 +6551,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | { message: string | Error; attributes?: ", + " | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -6559,9 +6561,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -6670,6 +6670,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -6677,11 +6679,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -6701,9 +6701,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -6713,9 +6713,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -6725,9 +6725,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -6783,7 +6783,9 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | { message: string | Error; attributes?: ", + ", response: { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -6791,9 +6793,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -6902,6 +6902,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -6909,11 +6911,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -6933,9 +6933,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -6945,9 +6945,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -6957,9 +6957,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -7075,7 +7075,9 @@ "section": "def-server.RouteMethod", "text": "RouteMethod" }, - " = any, ResponseFactory extends { custom: | Error | { message: string | Error; attributes?: ", + " = any, ResponseFactory extends { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -7083,9 +7085,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -7194,6 +7194,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -7201,11 +7203,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -7225,9 +7225,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -7237,9 +7237,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -7249,9 +7249,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -7261,7 +7261,9 @@ }, ") => ", "KibanaResponse", - "; } = { custom: | Error | { message: string | Error; attributes?: ", + "; } = { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -7269,9 +7271,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -7380,6 +7380,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -7387,11 +7389,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -7411,9 +7411,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -7423,9 +7423,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -7435,9 +7435,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -8991,6 +8991,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -8998,11 +9000,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -9022,9 +9022,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; }, toolkit: ", + " | Buffer>; }, toolkit: ", { "pluginId": "core", "scope": "server", @@ -9197,6 +9197,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -9204,11 +9206,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -9228,9 +9228,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; }" + " | Buffer>; }" ], "path": "src/core/server/http/lifecycle/auth.ts", "deprecated": false @@ -9453,7 +9453,7 @@ "\nHttp request headers to read." ], "signature": [ - "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; range?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ warning?: string | string[] | undefined; from?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; etag?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "src/core/server/http/router/headers.ts", "deprecated": false, @@ -9469,9 +9469,9 @@ "\nData send to the client as a response payload." ], "signature": [ - "string | Record | Buffer | ", + "string | Record | ", "Stream", - " | undefined" + " | Buffer | undefined" ], "path": "src/core/server/http/router/response.ts", "deprecated": false, @@ -9487,7 +9487,7 @@ "\nAccess or manipulate the Kibana base path\n\n{@link BasePath}" ], "signature": [ - "{ remove: (path: string) => string; get: (request: ", + "{ get: (request: ", { "pluginId": "core", "scope": "server", @@ -9503,7 +9503,7 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", requestSpecificBasePath: string) => void; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" + ", requestSpecificBasePath: string) => void; remove: (path: string) => string; prepend: (path: string) => string; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }" ], "path": "src/core/server/http/base_path_service.ts", "deprecated": false, @@ -9600,7 +9600,9 @@ "\nCreates an object containing request response payload, HTTP headers, error details, and other data transmitted to the client." ], "signature": [ - "{ custom: | Error | { message: string | Error; attributes?: ", + "{ custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -9608,9 +9610,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -9719,6 +9719,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -9726,11 +9728,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -9750,9 +9750,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -9762,9 +9762,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -9774,9 +9774,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -9802,7 +9802,7 @@ "\nSet of well-known HTTP headers." ], "signature": [ - "\"warning\" | \"from\" | \"date\" | \"range\" | \"location\" | \"origin\" | \"allow\" | \"accept\" | \"host\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" + "\"warning\" | \"from\" | \"date\" | \"expires\" | \"range\" | \"location\" | \"origin\" | \"allow\" | \"accept\" | \"host\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" ], "path": "src/core/server/http/router/headers.ts", "deprecated": false, @@ -9917,6 +9917,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -9924,11 +9926,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -9948,9 +9948,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; }" + " | Buffer>; }" ], "path": "src/core/server/http/router/response.ts", "deprecated": false, @@ -10073,6 +10073,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -10080,11 +10082,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -10104,9 +10104,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; }, toolkit: ", + " | Buffer>; }, toolkit: ", { "pluginId": "core", "scope": "server", @@ -10251,6 +10251,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -10258,11 +10260,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -10282,9 +10282,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; }" + " | Buffer>; }" ], "path": "src/core/server/http/lifecycle/on_post_auth.ts", "deprecated": false @@ -10428,6 +10428,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -10435,11 +10437,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -10459,9 +10459,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; }, toolkit: ", + " | Buffer>; }, toolkit: ", { "pluginId": "core", "scope": "server", @@ -10606,6 +10606,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -10613,11 +10615,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -10637,9 +10637,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; }" + " | Buffer>; }" ], "path": "src/core/server/http/lifecycle/on_pre_auth.ts", "deprecated": false @@ -10884,6 +10884,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -10891,11 +10893,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -10915,9 +10915,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; }, toolkit: ", + " | Buffer>; }, toolkit: ", { "pluginId": "core", "scope": "server", @@ -11062,6 +11062,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -11069,11 +11071,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -11093,9 +11093,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; }" + " | Buffer>; }" ], "path": "src/core/server/http/lifecycle/on_pre_routing.ts", "deprecated": false @@ -11280,7 +11280,9 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | { message: string | Error; attributes?: ", + ", response: { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -11288,9 +11290,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -11399,6 +11399,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -11406,11 +11408,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -11430,9 +11430,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -11442,9 +11442,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -11454,9 +11454,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -11503,7 +11503,9 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | { message: string | Error; attributes?: ", + ", response: { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -11511,9 +11513,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -11622,6 +11622,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -11629,11 +11631,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -11653,9 +11653,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -11665,9 +11665,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -11677,9 +11677,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -11731,7 +11731,9 @@ "section": "def-server.RouteMethod", "text": "RouteMethod" }, - " = any, ResponseFactory extends { custom: | Error | { message: string | Error; attributes?: ", + " = any, ResponseFactory extends { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -11739,9 +11741,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -11850,6 +11850,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -11857,11 +11859,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -11881,9 +11881,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -11893,9 +11893,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -11905,9 +11905,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -11917,7 +11917,9 @@ }, ") => ", "KibanaResponse", - "; } = { custom: | Error | { message: string | Error; attributes?: ", + "; } = { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -11925,9 +11927,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -12036,6 +12036,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -12043,11 +12045,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -12067,9 +12067,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -12079,9 +12079,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -12091,9 +12091,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -12264,7 +12264,7 @@ "\nHttp response headers to set." ], "signature": [ - "Record<\"warning\" | \"from\" | \"date\" | \"range\" | \"location\" | \"origin\" | \"allow\" | \"accept\" | \"host\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"expires\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record" + "Record<\"warning\" | \"from\" | \"date\" | \"expires\" | \"range\" | \"location\" | \"origin\" | \"allow\" | \"accept\" | \"host\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"etag\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record" ], "path": "src/core/server/http/router/headers.ts", "deprecated": false, @@ -12342,7 +12342,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | { message: string | Error; attributes?: ", + " | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -12350,9 +12352,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -12461,6 +12461,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -12468,11 +12470,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -12492,9 +12492,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -12504,9 +12504,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -12516,9 +12516,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -12570,7 +12570,9 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | { message: string | Error; attributes?: ", + ", response: { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -12578,9 +12580,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -12689,6 +12689,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -12696,11 +12698,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -12720,9 +12720,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -12732,9 +12732,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -12744,9 +12744,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -13032,7 +13032,9 @@ "/**\n * Creates a response with defined status code and payload.\n * @param options - {@link CustomHttpResponseOptions} configures HTTP response parameters.\n */" ], "signature": [ - " | Error | { message: string | Error; attributes?: ", + " | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -13040,9 +13042,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", diff --git a/api_docs/core_http.mdx b/api_docs/core_http.mdx index 954a5b1421f89..3e88698fc5bb8 100644 --- a/api_docs/core_http.mdx +++ b/api_docs/core_http.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-http title: "core.http" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.http plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.http'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2524 | 15 | 977 | 33 | +| 2541 | 15 | 977 | 33 | ## Client diff --git a/api_docs/core_saved_objects.devdocs.json b/api_docs/core_saved_objects.devdocs.json index ba6118416a1e1..9bc63a8bcba30 100644 --- a/api_docs/core_saved_objects.devdocs.json +++ b/api_docs/core_saved_objects.devdocs.json @@ -6526,7 +6526,7 @@ "\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n" ], "signature": [ - "({ readStream, createNewCopies, namespace, overwrite, }: ", + "({ readStream, createNewCopies, namespace, overwrite, refresh, }: ", { "pluginId": "core", "scope": "server", @@ -6552,7 +6552,7 @@ "id": "def-server.SavedObjectsImporter.import.$1", "type": "Object", "tags": [], - "label": "{\n readStream,\n createNewCopies,\n namespace,\n overwrite,\n }", + "label": "{\n readStream,\n createNewCopies,\n namespace,\n overwrite,\n refresh,\n }", "description": [], "signature": [ { @@ -12832,6 +12832,21 @@ ], "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "Refresh setting, defaults to `wait_for`" + ], + "signature": [ + "boolean | \"wait_for\" | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -13512,14 +13527,6 @@ "deprecated": true, "removeBy": "8.8.0", "references": [ - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/migrations/saved_object_migrations.ts" - }, - { - "plugin": "lens", - "path": "x-pack/plugins/lens/server/migrations/saved_object_migrations.ts" - }, { "plugin": "dashboard", "path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts" @@ -15605,7 +15612,7 @@ "tags": [], "label": "version", "description": [ - "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + "\nAn opaque version number which changes on each successful write operation.\nCan be used for implementing optimistic concurrency control." ], "signature": [ "string | undefined" @@ -15665,6 +15672,21 @@ ], "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateOptions.retryOnConflict", + "type": "number", + "tags": [], + "label": "retryOnConflict", + "description": [ + "\nThe Elasticsearch `retry_on_conflict` setting for this operation.\nDefaults to `0` when `version` is provided, `3` otherwise." + ], + "signature": [ + "number | undefined" + ], + "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "deprecated": false } ], "initialIsOpen": false @@ -15688,7 +15710,7 @@ }, " extends Omit<", "SavedObject", - ", \"references\" | \"attributes\">" + ", \"attributes\" | \"references\">" ], "path": "src/core/server/saved_objects/service/saved_objects_client.ts", "deprecated": false, @@ -15803,7 +15825,7 @@ "label": "ISavedObjectsImporter", "description": [], "signature": [ - "{ import: ({ readStream, createNewCopies, namespace, overwrite, }: ", + "{ import: ({ readStream, createNewCopies, namespace, overwrite, refresh, }: ", { "pluginId": "core", "scope": "server", diff --git a/api_docs/core_saved_objects.mdx b/api_docs/core_saved_objects.mdx index 3d2ddcc47ed8a..c68e80c1a83a8 100644 --- a/api_docs/core_saved_objects.mdx +++ b/api_docs/core_saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-savedObjects title: "core.savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the core.savedObjects plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.savedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2524 | 15 | 977 | 33 | +| 2541 | 15 | 977 | 33 | ## Client diff --git a/api_docs/custom_integrations.devdocs.json b/api_docs/custom_integrations.devdocs.json index 7351c9c7261a6..45583241f465a 100644 --- a/api_docs/custom_integrations.devdocs.json +++ b/api_docs/custom_integrations.devdocs.json @@ -349,6 +349,19 @@ "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false }, + { + "parentPluginId": "customIntegrations", + "id": "def-server.CustomIntegration.uiExternalLink", + "type": "string", + "tags": [], + "label": "uiExternalLink", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false + }, { "parentPluginId": "customIntegrations", "id": "def-server.CustomIntegration.isBeta", @@ -400,7 +413,7 @@ "label": "shipper", "description": [], "signature": [ - "\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\"" + "\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\" | \"placeholders\"" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false @@ -608,6 +621,19 @@ "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.CustomIntegration.uiExternalLink", + "type": "string", + "tags": [], + "label": "uiExternalLink", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false + }, { "parentPluginId": "customIntegrations", "id": "def-common.CustomIntegration.isBeta", @@ -659,7 +685,7 @@ "label": "shipper", "description": [], "signature": [ - "\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\"" + "\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\" | \"placeholders\"" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false @@ -851,7 +877,7 @@ "\nThe list of all known shippers." ], "signature": [ - "(\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\")[]" + "(\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\" | \"placeholders\")[]" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, @@ -867,7 +893,7 @@ "\nA shipper-- an internal or external system capable of storing data in ES/Kibana-- applicable to an Integration." ], "signature": [ - "\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\"" + "\"beats\" | \"enterprise_search\" | \"language_clients\" | \"other\" | \"sample_data\" | \"tests\" | \"tutorial\" | \"placeholders\"" ], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false, @@ -1293,6 +1319,16 @@ "description": [], "path": "src/plugins/custom_integrations/common/index.ts", "deprecated": false + }, + { + "parentPluginId": "customIntegrations", + "id": "def-common.SHIPPER_DISPLAY.placeholders", + "type": "string", + "tags": [], + "label": "placeholders", + "description": [], + "path": "src/plugins/custom_integrations/common/index.ts", + "deprecated": false } ], "initialIsOpen": false diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index 3d1c022b25501..8f5689085e3fd 100644 --- a/api_docs/custom_integrations.mdx +++ b/api_docs/custom_integrations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/customIntegrations title: "customIntegrations" image: https://source.unsplash.com/400x175/?github summary: API docs for the customIntegrations plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 98 | 0 | 79 | 1 | +| 101 | 0 | 82 | 1 | ## Client diff --git a/api_docs/dashboard.devdocs.json b/api_docs/dashboard.devdocs.json index 840d4d1eee1e8..3c7de7012e4b3 100644 --- a/api_docs/dashboard.devdocs.json +++ b/api_docs/dashboard.devdocs.json @@ -1346,6 +1346,19 @@ "path": "src/plugins/dashboard/public/types.ts", "deprecated": false }, + { + "parentPluginId": "dashboard", + "id": "def-public.DashboardContainerInput.syncTooltips", + "type": "CompoundType", + "tags": [], + "label": "syncTooltips", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/dashboard/public/types.ts", + "deprecated": false + }, { "parentPluginId": "dashboard", "id": "def-public.DashboardContainerInput.viewMode", diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index b7d6084864327..de4f5ac75f371 100644 --- a/api_docs/dashboard.mdx +++ b/api_docs/dashboard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboard title: "dashboard" image: https://source.unsplash.com/400x175/?github summary: API docs for the dashboard plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-prese | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 142 | 0 | 140 | 12 | +| 143 | 0 | 141 | 12 | ## Client diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index 458cdf96fef07..81cec6d9f2ccd 100644 --- a/api_docs/dashboard_enhanced.mdx +++ b/api_docs/dashboard_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced title: "dashboardEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the dashboardEnhanced plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data.devdocs.json b/api_docs/data.devdocs.json index 62c04ae8d5d64..12527c97b10be 100644 --- a/api_docs/data.devdocs.json +++ b/api_docs/data.devdocs.json @@ -2395,7 +2395,7 @@ "section": "def-public.PluginInitializerContext", "text": "PluginInitializerContext" }, - "; }>; }>; }>>" + "; }>; sessions: Readonly<{} & { enabled: boolean; pageSize: number; trackingInterval: moment.Duration; cleanupInterval: moment.Duration; expireInterval: moment.Duration; monitoringTaskTimeout: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; }>; }>; }>>" ], "path": "src/plugins/data/public/plugin.ts", "deprecated": false, @@ -2430,7 +2430,7 @@ "section": "def-public.DataPublicPluginStart", "text": "DataPublicPluginStart" }, - ">, { bfetch, expressions, uiActions, usageCollection, inspector, fieldFormats, }: ", + ">, { bfetch, expressions, uiActions, usageCollection, inspector, fieldFormats, management, }: ", "DataSetupDependencies", ") => ", { @@ -2480,7 +2480,7 @@ "id": "def-public.DataPublicPlugin.setup.$2", "type": "Object", "tags": [], - "label": "{\n bfetch,\n expressions,\n uiActions,\n usageCollection,\n inspector,\n fieldFormats,\n }", + "label": "{\n bfetch,\n expressions,\n uiActions,\n usageCollection,\n inspector,\n fieldFormats,\n management,\n }", "description": [], "signature": [ "DataSetupDependencies" @@ -2508,7 +2508,7 @@ "section": "def-public.CoreStart", "text": "CoreStart" }, - ", { uiActions, fieldFormats, dataViews }: ", + ", { uiActions, fieldFormats, dataViews, screenshotMode }: ", "DataStartDependencies", ") => ", { @@ -2547,7 +2547,7 @@ "id": "def-public.DataPublicPlugin.start.$2", "type": "Object", "tags": [], - "label": "{ uiActions, fieldFormats, dataViews }", + "label": "{ uiActions, fieldFormats, dataViews, screenshotMode }", "description": [], "signature": [ "DataStartDependencies" @@ -3876,6 +3876,10 @@ "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": true, "references": [ + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.ts" + }, { "plugin": "discover", "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" @@ -3883,6 +3887,10 @@ { "plugin": "discover", "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.ts" } ], "children": [], @@ -4152,16 +4160,36 @@ "removeBy": "8.1", "references": [ { - "plugin": "discover", - "path": "src/plugins/discover/public/application/context/services/anchor.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts" + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts" + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" }, { "plugin": "stackAlerts", @@ -4171,6 +4199,22 @@ "plugin": "stackAlerts", "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts" }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" + }, { "plugin": "inputControlVis", "path": "src/plugins/input_control_vis/public/control/list_control_factory.ts" @@ -7479,6 +7523,25 @@ "path": "src/plugins/data/public/types.ts", "deprecated": false }, + { + "parentPluginId": "data", + "id": "def-public.IDataPluginServices.application", + "type": "Object", + "tags": [], + "label": "application", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreApplicationPluginApi", + "section": "def-public.ApplicationStart", + "text": "ApplicationStart" + } + ], + "path": "src/plugins/data/public/types.ts", + "deprecated": false + }, { "parentPluginId": "data", "id": "def-public.IDataPluginServices.http", @@ -7668,22 +7731,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/common/fields/field_list.ts" }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, { "plugin": "dataViews", "path": "src/plugins/data_views/common/index.ts" @@ -7708,22 +7755,6 @@ "plugin": "unifiedSearch", "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" - }, { "plugin": "unifiedSearch", "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" @@ -7742,99 +7773,27 @@ }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/value_input_type.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/value_input_type.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/types.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/types.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/types.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/types.ts" }, { "plugin": "dataViews", @@ -8142,19 +8101,19 @@ }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", @@ -8162,11 +8121,11 @@ }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" } ], "children": [ @@ -10082,34 +10041,6 @@ "deprecated": true, "removeBy": "8.1", "references": [ - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, { "plugin": "discover", "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" @@ -10178,6 +10109,14 @@ "plugin": "dashboard", "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + }, { "plugin": "urlDrilldown", "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" @@ -10201,74 +10140,6 @@ { "plugin": "urlDrilldown", "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/test_helpers/get_stub_filter.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/test_helpers/get_stub_filter.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/create_search_bar.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/create_search_bar.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx" } ], "initialIsOpen": false @@ -10717,22 +10588,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/public/index.ts" }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" @@ -11099,96 +10954,7 @@ "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, "removeBy": "8.1", - "references": [ - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts" - } - ], + "references": [], "initialIsOpen": false }, { @@ -11279,6 +11045,42 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-public.QueryState", + "type": "Type", + "tags": [], + "label": "QueryState", + "description": [ + "\nAll query state service state\n" + ], + "signature": [ + "{ time?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined; refreshInterval?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + " | undefined; filters?: ", + "Filter", + "[] | undefined; query?: ", + "Query", + " | undefined; }" + ], + "path": "src/plugins/data/common/query/query_state.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-public.RangeFilter", @@ -14796,49 +14598,13 @@ "label": "query", "description": [], "signature": [ - "{ filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; timefilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; queryString: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringContract", - "text": "QueryStringContract" - }, - "; state$: ", - "Observable", - "<{ changes: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" - }, - "; state: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", - "text": "QueryState" - }, - "; }>; }" + "section": "def-public.QuerySetup", + "text": "QuerySetup" + } ], "path": "src/plugins/data/public/types.ts", "deprecated": false @@ -15131,125 +14897,13 @@ "\nquery service\n{@link QueryStart}" ], "signature": [ - "{ addToQueryLog: (appName: string, { language, query }: ", - "Query", - ") => void; filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; queryString: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringContract", - "text": "QueryStringContract" - }, - "; savedQueries: { createQuery: (attributes: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.SavedQueryAttributes", - "text": "SavedQueryAttributes" - }, - ", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; updateQuery: (id: string, attributes: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.SavedQueryAttributes", - "text": "SavedQueryAttributes" - }, - ") => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; getAllSavedQueries: () => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - "[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - "[]; }>; getSavedQuery: (id: string) => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; deleteSavedQuery: (id: string) => Promise<{}>; getSavedQueryCount: () => Promise; }; state$: ", - "Observable", - "<{ changes: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" - }, - "; state: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", - "text": "QueryState" - }, - "; }>; timefilter: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; getEsQuery: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ", timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | undefined) => { bool: ", - "BoolQuery", - "; }; }" + "section": "def-public.QueryStart", + "text": "QueryStart" + } ], "path": "src/plugins/data/public/types.ts", "deprecated": false @@ -15350,7 +15004,7 @@ "section": "def-server.PluginInitializerContext", "text": "PluginInitializerContext" }, - "; }>; }>; }>>" + "; }>; sessions: Readonly<{} & { enabled: boolean; pageSize: number; trackingInterval: moment.Duration; cleanupInterval: moment.Duration; expireInterval: moment.Duration; monitoringTaskTimeout: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; }>; }>; }>>" ], "path": "src/plugins/data/server/plugin.ts", "deprecated": false, @@ -15385,33 +15039,13 @@ "section": "def-server.DataPluginStart", "text": "DataPluginStart" }, - ">, { bfetch, expressions, usageCollection, fieldFormats }: ", + ">, { bfetch, expressions, usageCollection, fieldFormats, taskManager, security, }: ", "DataPluginSetupDependencies", - ") => { __enhance: (enhancements: DataEnhancements) => void; search: ", + ") => { search: ", "ISearchSetup", - "; query: { filterManager: { extract: (filters: ", - "Filter", - "[]) => { state: ", - "Filter", - "[]; references: ", - "SavedObjectReference", - "[]; }; inject: (filters: ", - "Filter", - "[], references: ", - "SavedObjectReference", - "[]) => ", - "Filter", - "[]; telemetry: (filters: ", - "Filter", - "[], collector: unknown) => {}; getAllMigrations: () => ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.MigrateFunctionsObject", - "text": "MigrateFunctionsObject" - }, - "; }; }; fieldFormats: ", + "; query: ", + "QuerySetup", + "; fieldFormats: ", { "pluginId": "fieldFormats", "scope": "server", @@ -15460,7 +15094,7 @@ "id": "def-server.DataServerPlugin.setup.$2", "type": "Object", "tags": [], - "label": "{ bfetch, expressions, usageCollection, fieldFormats }", + "label": "{\n bfetch,\n expressions,\n usageCollection,\n fieldFormats,\n taskManager,\n security,\n }", "description": [], "signature": [ "DataPluginSetupDependencies" @@ -15488,7 +15122,7 @@ "section": "def-server.CoreStart", "text": "CoreStart" }, - ", { fieldFormats, dataViews }: ", + ", { fieldFormats, dataViews, taskManager }: ", "DataPluginStartDependencies", ") => { datatableUtilities: ", "DatatableUtilitiesService", @@ -15556,7 +15190,7 @@ "id": "def-server.DataServerPlugin.start.$2", "type": "Object", "tags": [], - "label": "{ fieldFormats, dataViews }", + "label": "{ fieldFormats, dataViews, taskManager }", "description": [], "signature": [ "DataPluginStartDependencies" @@ -18758,34 +18392,6 @@ "deprecated": true, "removeBy": "8.1", "references": [ - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, { "plugin": "discover", "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" @@ -18854,6 +18460,14 @@ "plugin": "dashboard", "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + }, { "plugin": "urlDrilldown", "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" @@ -18877,74 +18491,6 @@ { "plugin": "urlDrilldown", "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/test_helpers/get_stub_filter.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/test_helpers/get_stub_filter.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/create_search_bar.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/create_search_bar.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx" } ], "initialIsOpen": false @@ -19046,96 +18592,7 @@ "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, "removeBy": "8.1", - "references": [ - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts" - } - ], + "references": [], "initialIsOpen": false }, { @@ -20431,29 +19888,7 @@ "label": "query", "description": [], "signature": [ - "{ filterManager: { extract: (filters: ", - "Filter", - "[]) => { state: ", - "Filter", - "[]; references: ", - "SavedObjectReference", - "[]; }; inject: (filters: ", - "Filter", - "[], references: ", - "SavedObjectReference", - "[]) => ", - "Filter", - "[]; telemetry: (filters: ", - "Filter", - "[], collector: unknown) => {}; getAllMigrations: () => ", - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.MigrateFunctionsObject", - "text": "MigrateFunctionsObject" - }, - "; }; }" + "QuerySetup" ], "path": "src/plugins/data/server/plugin.ts", "deprecated": false @@ -27605,28 +27040,7 @@ "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, "removeBy": "8.1", - "references": [ - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts" - } - ], + "references": [], "returnComment": [], "children": [ { @@ -29046,22 +28460,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/common/fields/field_list.ts" }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, - { - "plugin": "dataViews", - "path": "src/plugins/data_views/common/types.ts" - }, { "plugin": "dataViews", "path": "src/plugins/data_views/common/index.ts" @@ -29086,22 +28484,6 @@ "plugin": "unifiedSearch", "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" - }, { "plugin": "unifiedSearch", "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" @@ -29120,99 +28502,27 @@ }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/value_input_type.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/value_input_type.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/types.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/types.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/types.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "plugin": "dataViews", + "path": "src/plugins/data_views/common/types.ts" }, { "plugin": "dataViews", @@ -29520,19 +28830,19 @@ }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", @@ -29540,11 +28850,11 @@ }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" } ], "children": [ @@ -31535,34 +30845,6 @@ "deprecated": true, "removeBy": "8.1", "references": [ - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/actions/apply_filter_action.ts" - }, { "plugin": "discover", "path": "src/plugins/discover/public/application/view_alert/view_alert_route.tsx" @@ -31631,6 +30913,14 @@ "plugin": "dashboard", "path": "src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx" }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx" + }, { "plugin": "urlDrilldown", "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts" @@ -31654,74 +30944,6 @@ { "plugin": "urlDrilldown", "path": "x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/test_helpers/get_stub_filter.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/test_helpers/get_stub_filter.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/create_search_bar.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/search_bar/create_search_bar.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filter_popover_content.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/apply_filters/apply_filters_popover.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx" - }, - { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx" } ], "initialIsOpen": false @@ -32088,22 +31310,6 @@ "plugin": "dataViews", "path": "src/plugins/data_views/public/index.ts" }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" @@ -32141,96 +31347,7 @@ "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, "removeBy": "8.1", - "references": [ - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/types.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts" - } - ], + "references": [], "initialIsOpen": false }, { @@ -32284,7 +31401,7 @@ "section": "def-public.ErrorToastOptions", "text": "ErrorToastOptions" }, - ") => void" + ", key: string) => void" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, @@ -32321,6 +31438,16 @@ ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.OnError.$3", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -32341,7 +31468,7 @@ "section": "def-public.ToastInputFields", "text": "ToastInputFields" }, - ") => void" + ", key: string) => void" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, @@ -32377,6 +31504,16 @@ ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-common.OnNotification.$2", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -32595,32 +31732,7 @@ "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, "removeBy": "8.1", - "references": [ - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx" - } - ], + "references": [], "initialIsOpen": false }, { @@ -32650,56 +31762,7 @@ "path": "src/plugins/data/common/es_query/index.ts", "deprecated": true, "removeBy": "8.1", - "references": [ - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/session_service.test.ts" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/session_service.test.ts" - } - ], + "references": [], "initialIsOpen": false }, { diff --git a/api_docs/data.mdx b/api_docs/data.mdx index a876abb895181..414fd654aa3c2 100644 --- a/api_docs/data.mdx +++ b/api_docs/data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data title: "data" image: https://source.unsplash.com/400x175/?github summary: API docs for the data plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3414 | 38 | 2802 | 18 | +| 3489 | 38 | 2874 | 20 | ## Client diff --git a/api_docs/data_enhanced.devdocs.json b/api_docs/data_enhanced.devdocs.json deleted file mode 100644 index af1a90105e7f7..0000000000000 --- a/api_docs/data_enhanced.devdocs.json +++ /dev/null @@ -1,313 +0,0 @@ -{ - "id": "dataEnhanced", - "client": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [ - { - "parentPluginId": "dataEnhanced", - "id": "def-public.ENHANCED_ES_SEARCH_STRATEGY", - "type": "string", - "tags": [], - "label": "ENHANCED_ES_SEARCH_STRATEGY", - "description": [], - "signature": [ - "\"ese\"" - ], - "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataEnhanced", - "id": "def-public.EQL_SEARCH_STRATEGY", - "type": "string", - "tags": [], - "label": "EQL_SEARCH_STRATEGY", - "description": [], - "signature": [ - "\"eql\"" - ], - "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [], - "start": { - "parentPluginId": "dataEnhanced", - "id": "def-public.DataEnhancedStart", - "type": "Type", - "tags": [], - "label": "DataEnhancedStart", - "description": [], - "signature": [ - "void" - ], - "path": "x-pack/plugins/data_enhanced/public/plugin.ts", - "deprecated": false, - "lifecycle": "start", - "initialIsOpen": true - } - }, - "server": { - "classes": [ - { - "parentPluginId": "dataEnhanced", - "id": "def-server.EnhancedDataServerPlugin", - "type": "Class", - "tags": [], - "label": "EnhancedDataServerPlugin", - "description": [], - "signature": [ - { - "pluginId": "dataEnhanced", - "scope": "server", - "docId": "kibDataEnhancedPluginApi", - "section": "def-server.EnhancedDataServerPlugin", - "text": "EnhancedDataServerPlugin" - }, - " implements ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.Plugin", - "text": "Plugin" - }, - "" - ], - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataEnhanced", - "id": "def-server.EnhancedDataServerPlugin.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataEnhanced", - "id": "def-server.EnhancedDataServerPlugin.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "initializerContext", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PluginInitializerContext", - "text": "PluginInitializerContext" - }, - "; pageSize: number; trackingInterval: moment.Duration; cleanupInterval: moment.Duration; expireInterval: moment.Duration; monitoringTaskTimeout: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; }>; }>; }>>" - ], - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataEnhanced", - "id": "def-server.EnhancedDataServerPlugin.setup", - "type": "Function", - "tags": [], - "label": "setup", - "description": [], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - "<", - "DataEnhancedStartDependencies", - ", unknown>, deps: ", - "DataEnhancedSetupDependencies", - ") => void" - ], - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataEnhanced", - "id": "def-server.EnhancedDataServerPlugin.setup.$1", - "type": "Object", - "tags": [], - "label": "core", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreSetup", - "text": "CoreSetup" - }, - "<", - "DataEnhancedStartDependencies", - ", unknown>" - ], - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataEnhanced", - "id": "def-server.EnhancedDataServerPlugin.setup.$2", - "type": "Object", - "tags": [], - "label": "deps", - "description": [], - "signature": [ - "DataEnhancedSetupDependencies" - ], - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataEnhanced", - "id": "def-server.EnhancedDataServerPlugin.start", - "type": "Function", - "tags": [], - "label": "start", - "description": [], - "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - }, - ", { taskManager }: ", - "DataEnhancedStartDependencies", - ") => void" - ], - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "dataEnhanced", - "id": "def-server.EnhancedDataServerPlugin.start.$1", - "type": "Object", - "tags": [], - "label": "core", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreStart", - "text": "CoreStart" - } - ], - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "dataEnhanced", - "id": "def-server.EnhancedDataServerPlugin.start.$2", - "type": "Object", - "tags": [], - "label": "{ taskManager }", - "description": [], - "signature": [ - "DataEnhancedStartDependencies" - ], - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "dataEnhanced", - "id": "def-server.EnhancedDataServerPlugin.stop", - "type": "Function", - "tags": [], - "label": "stop", - "description": [], - "signature": [ - "() => void" - ], - "path": "x-pack/plugins/data_enhanced/server/plugin.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [ - { - "parentPluginId": "dataEnhanced", - "id": "def-server.ENHANCED_ES_SEARCH_STRATEGY", - "type": "string", - "tags": [], - "label": "ENHANCED_ES_SEARCH_STRATEGY", - "description": [], - "signature": [ - "\"ese\"" - ], - "path": "src/plugins/data/common/search/strategies/ese_search/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "dataEnhanced", - "id": "def-server.EQL_SEARCH_STRATEGY", - "type": "string", - "tags": [], - "label": "EQL_SEARCH_STRATEGY", - "description": [], - "signature": [ - "\"eql\"" - ], - "path": "src/plugins/data/common/search/strategies/eql_search/types.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] - } -} \ No newline at end of file diff --git a/api_docs/data_enhanced.mdx b/api_docs/data_enhanced.mdx deleted file mode 100644 index 6eb3ac5dc589d..0000000000000 --- a/api_docs/data_enhanced.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: kibDataEnhancedPluginApi -slug: /kibana-dev-docs/api/dataEnhanced -title: "dataEnhanced" -image: https://source.unsplash.com/400x175/?github -summary: API docs for the dataEnhanced plugin -date: 2022-04-26 -tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataEnhanced'] -warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. ---- -import dataEnhancedObj from './data_enhanced.devdocs.json'; - -Enhanced data plugin. (See src/plugins/data.) Enhances the main data plugin with a search session management UI. Includes a reusable search session indicator component to use in other applications. Exposes routes for managing search sessions. Includes a service that monitors, updates, and cleans up search session saved objects. - -Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) for questions regarding this plugin. - -**Code health stats** - -| Public API count | Any count | Items lacking comments | Missing exports | -|-------------------|-----------|------------------------|-----------------| -| 16 | 0 | 16 | 2 | - -## Client - -### Start - - -### Consts, variables and types - - -## Server - -### Classes - - -### Consts, variables and types - - diff --git a/api_docs/data_query.devdocs.json b/api_docs/data_query.devdocs.json index db5f5e436135d..85cb255d272c4 100644 --- a/api_docs/data_query.devdocs.json +++ b/api_docs/data_query.devdocs.json @@ -477,7 +477,7 @@ "Filter", "[]" ], - "path": "src/plugins/data/common/query/persistable_state.ts", + "path": "src/plugins/data/common/query/filters/persistable_state.ts", "deprecated": false } ] @@ -513,7 +513,7 @@ "Filter", "[]" ], - "path": "src/plugins/data/common/query/persistable_state.ts", + "path": "src/plugins/data/common/query/filters/persistable_state.ts", "deprecated": false }, { @@ -527,7 +527,7 @@ "SavedObjectReference", "[]" ], - "path": "src/plugins/data/common/query/persistable_state.ts", + "path": "src/plugins/data/common/query/filters/persistable_state.ts", "deprecated": false } ] @@ -559,7 +559,7 @@ "Filter", "[]" ], - "path": "src/plugins/data/common/query/persistable_state.ts", + "path": "src/plugins/data/common/query/filters/persistable_state.ts", "deprecated": false }, { @@ -572,7 +572,7 @@ "signature": [ "unknown" ], - "path": "src/plugins/data/common/query/persistable_state.ts", + "path": "src/plugins/data/common/query/filters/persistable_state.ts", "deprecated": false } ] @@ -865,526 +865,337 @@ }, { "parentPluginId": "data", - "id": "def-public.QueryService", + "id": "def-public.TimeHistory", "type": "Class", "tags": [], - "label": "QueryService", + "label": "TimeHistory", "description": [], - "path": "src/plugins/data/public/query/query_service.ts", + "path": "src/plugins/data/public/query/timefilter/time_history.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.QueryService.filterManager", - "type": "Object", + "id": "def-public.TimeHistory.Unnamed", + "type": "Function", "tags": [], - "label": "filterManager", + "label": "Constructor", "description": [], "signature": [ + "any" + ], + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "deprecated": false, + "children": [ { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" + "parentPluginId": "data", + "id": "def-public.TimeHistory.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "storage", + "description": [], + "signature": [ + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.IStorageWrapper", + "text": "IStorageWrapper" + }, + "" + ], + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "deprecated": false, + "isRequired": true } ], - "path": "src/plugins/data/public/query/query_service.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-public.QueryService.timefilter", - "type": "Object", + "id": "def-public.TimeHistory.add", + "type": "Function", "tags": [], - "label": "timefilter", + "label": "add", "description": [], "signature": [ + "(time: ", { "pluginId": "data", - "scope": "public", + "scope": "common", "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + ") => void" + ], + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.TimeHistory.add.$1", + "type": "Object", + "tags": [], + "label": "time", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + } + ], + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "deprecated": false, + "isRequired": true } ], - "path": "src/plugins/data/public/query/query_service.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-public.QueryService.queryStringManager", - "type": "Object", + "id": "def-public.TimeHistory.get", + "type": "Function", "tags": [], - "label": "queryStringManager", + "label": "get", "description": [], "signature": [ - "{ getDefaultQuery: () => { query: string; language: any; }; formatQuery: (query: string | ", - "Query", - " | undefined) => ", - "Query", - "; getUpdates$: () => ", - "Observable", - "<", - "Query", - ">; getQuery: () => ", - "Query", - "; setQuery: (query: ", - "Query", - ") => void; clearQuery: () => void; }" + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + "[]" ], - "path": "src/plugins/data/public/query/query_service.ts", - "deprecated": false + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "data", - "id": "def-public.QueryService.state$", - "type": "Object", + "id": "def-public.TimeHistory.get$", + "type": "Function", "tags": [], - "label": "state$", + "label": "get$", "description": [], "signature": [ + "() => ", "Observable", - "<{ changes: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" - }, - "; state: ", + "<", { "pluginId": "data", - "scope": "public", + "scope": "common", "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", - "text": "QueryState" + "section": "def-common.TimeRange", + "text": "TimeRange" }, - "; }>" + "[]>" ], - "path": "src/plugins/data/public/query/query_service.ts", - "deprecated": false + "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "data", + "id": "def-public.connectToQueryState", + "type": "Function", + "tags": [], + "label": "connectToQueryState", + "description": [ + "\nHelper to setup two-way syncing of global data and a state container" + ], + "signature": [ + "({ timefilter: { timefilter }, filterManager, queryString, state$, }: Pick<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStart", + "text": "QueryStart" + }, + " | ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QuerySetup", + "text": "QuerySetup" }, + ", \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">, stateContainer: ", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.BaseStateContainer", + "text": "BaseStateContainer" + }, + ", syncConfig: { time?: boolean | undefined; refreshInterval?: boolean | undefined; filters?: boolean | ", + "FilterStateStore", + " | undefined; query?: boolean | undefined; }) => () => void" + ], + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-public.QueryService.setup", - "type": "Function", + "id": "def-public.connectToQueryState.$1", + "type": "Object", "tags": [], - "label": "setup", + "label": "{\n timefilter: { timefilter },\n filterManager,\n queryString,\n state$,\n }", "description": [], "signature": [ - "({ storage, uiSettings, nowProvider }: QueryServiceSetupDependencies) => { filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; timefilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; queryString: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringContract", - "text": "QueryStringContract" - }, - "; state$: ", - "Observable", - "<{ changes: ", + "Pick<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" + "section": "def-public.QueryStart", + "text": "QueryStart" }, - "; state: ", + " | ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", - "text": "QueryState" + "section": "def-public.QuerySetup", + "text": "QuerySetup" }, - "; }>; }" + ", \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">" ], - "path": "src/plugins/data/public/query/query_service.ts", + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.QueryService.setup.$1", - "type": "Object", - "tags": [], - "label": "{ storage, uiSettings, nowProvider }", - "description": [], - "signature": [ - "QueryServiceSetupDependencies" - ], - "path": "src/plugins/data/public/query/query_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "isRequired": true }, { "parentPluginId": "data", - "id": "def-public.QueryService.start", - "type": "Function", + "id": "def-public.connectToQueryState.$2", + "type": "Object", "tags": [], - "label": "start", - "description": [], + "label": "stateContainer", + "description": [ + "to use for syncing" + ], "signature": [ - "({ storage, uiSettings, http }: QueryServiceStartDependencies) => { addToQueryLog: (appName: string, { language, query }: ", - "Query", - ") => void; filterManager: ", { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; queryString: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringContract", - "text": "QueryStringContract" - }, - "; savedQueries: { createQuery: (attributes: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.SavedQueryAttributes", - "text": "SavedQueryAttributes" - }, - ", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; updateQuery: (id: string, attributes: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.SavedQueryAttributes", - "text": "SavedQueryAttributes" - }, - ") => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; getAllSavedQueries: () => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - "[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - "[]; }>; getSavedQuery: (id: string) => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; deleteSavedQuery: (id: string) => Promise<{}>; getSavedQueryCount: () => Promise; }; state$: ", - "Observable", - "<{ changes: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" - }, - "; state: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", - "text": "QueryState" - }, - "; }>; timefilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; getEsQuery: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ", timeRange?: ", - { - "pluginId": "data", + "pluginId": "kibanaUtils", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.BaseStateContainer", + "text": "BaseStateContainer" }, - " | undefined) => { bool: ", - "BoolQuery", - "; }; }" + "" ], - "path": "src/plugins/data/public/query/query_service.ts", + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.QueryService.start.$1", - "type": "Object", - "tags": [], - "label": "{ storage, uiSettings, http }", - "description": [], - "signature": [ - "QueryServiceStartDependencies" - ], - "path": "src/plugins/data/public/query/query_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "isRequired": true }, { "parentPluginId": "data", - "id": "def-public.QueryService.stop", - "type": "Function", - "tags": [], - "label": "stop", - "description": [], - "signature": [ - "() => void" - ], - "path": "src/plugins/data/public/query/query_service.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.TimeHistory", - "type": "Class", - "tags": [], - "label": "TimeHistory", - "description": [], - "path": "src/plugins/data/public/query/timefilter/time_history.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.TimeHistory.Unnamed", - "type": "Function", + "id": "def-public.connectToQueryState.$3", + "type": "Object", "tags": [], - "label": "Constructor", + "label": "syncConfig", "description": [], - "signature": [ - "any" - ], - "path": "src/plugins/data/public/query/timefilter/time_history.ts", + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.TimeHistory.Unnamed.$1", - "type": "Object", + "id": "def-public.connectToQueryState.$3.time", + "type": "CompoundType", "tags": [], - "label": "storage", + "label": "time", "description": [], "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "public", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-public.IStorageWrapper", - "text": "IStorageWrapper" - }, - "" + "boolean | undefined" ], - "path": "src/plugins/data/public/query/timefilter/time_history.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-public.TimeHistory.add", - "type": "Function", - "tags": [], - "label": "add", - "description": [], - "signature": [ - "(time: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "deprecated": false }, - ") => void" - ], - "path": "src/plugins/data/public/query/timefilter/time_history.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-public.TimeHistory.add.$1", - "type": "Object", + "id": "def-public.connectToQueryState.$3.refreshInterval", + "type": "CompoundType", "tags": [], - "label": "time", + "label": "refreshInterval", "description": [], "signature": [ - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - } + "boolean | undefined" ], - "path": "src/plugins/data/public/query/timefilter/time_history.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-public.TimeHistory.get", - "type": "Function", - "tags": [], - "label": "get", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "deprecated": false }, - "[]" - ], - "path": "src/plugins/data/public/query/timefilter/time_history.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "data", - "id": "def-public.TimeHistory.get$", - "type": "Function", - "tags": [], - "label": "get$", - "description": [], - "signature": [ - "() => ", - "Observable", - "<", { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "parentPluginId": "data", + "id": "def-public.connectToQueryState.$3.filters", + "type": "CompoundType", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + "boolean | ", + "FilterStateStore", + " | undefined" + ], + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "deprecated": false }, - "[]>" - ], - "path": "src/plugins/data/public/query/timefilter/time_history.ts", - "deprecated": false, - "children": [], - "returnComment": [] + { + "parentPluginId": "data", + "id": "def-public.connectToQueryState.$3.query", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "deprecated": false + } + ] } ], + "returnComment": [], "initialIsOpen": false - } - ], - "functions": [ + }, { "parentPluginId": "data", - "id": "def-public.connectToQueryState", + "id": "def-public.createSavedQueryService", "type": "Function", "tags": [], - "label": "connectToQueryState", - "description": [ - "\nHelper to setup two-way syncing of global data and a state container" - ], + "label": "createSavedQueryService", + "description": [], "signature": [ - "({ timefilter: { timefilter }, filterManager, queryString, state$, }: Pick<{ addToQueryLog: (appName: string, { language, query }: ", - "Query", - ") => void; filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; queryString: ", + "(http: ", { - "pluginId": "data", + "pluginId": "core", "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringContract", - "text": "QueryStringContract" + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" }, - "; savedQueries: { createQuery: (attributes: ", + ") => { createQuery: (attributes: ", { "pluginId": "data", "scope": "common", @@ -1440,41 +1251,48 @@ "section": "def-public.SavedQuery", "text": "SavedQuery" }, - ">; deleteSavedQuery: (id: string) => Promise<{}>; getSavedQueryCount: () => Promise; }; state$: ", - "Observable", - "<{ changes: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" - }, - "; state: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", - "text": "QueryState" - }, - "; }>; timefilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; getEsQuery: (indexPattern: ", + ">; deleteSavedQuery: (id: string) => Promise<{}>; getSavedQueryCount: () => Promise; }" + ], + "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", + "deprecated": false, + "children": [ { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ", timeRange?: ", + "parentPluginId": "data", + "id": "def-public.createSavedQueryService.$1", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.extractTimeRange", + "type": "Function", + "tags": [], + "label": "extractTimeRange", + "description": [], + "signature": [ + "(filters: ", + "Filter", + "[], timeFieldName: string | undefined) => { restOfFilters: ", + "Filter", + "[]; timeRange?: ", { "pluginId": "data", "scope": "common", @@ -1482,327 +1300,264 @@ "section": "def-common.TimeRange", "text": "TimeRange" }, - " | undefined) => { bool: ", - "BoolQuery", - "; }; } | { filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; timefilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; queryString: ", + " | undefined; }" + ], + "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", + "deprecated": false, + "children": [ { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringContract", - "text": "QueryStringContract" + "parentPluginId": "data", + "id": "def-public.extractTimeRange.$1", + "type": "Array", + "tags": [], + "label": "filters", + "description": [], + "signature": [ + "Filter", + "[]" + ], + "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", + "deprecated": false, + "isRequired": true }, - "; state$: ", - "Observable", - "<{ changes: ", { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" - }, - "; state: ", + "parentPluginId": "data", + "id": "def-public.extractTimeRange.$2", + "type": "string", + "tags": [], + "label": "timeFieldName", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.generateFilters", + "type": "Function", + "tags": [], + "label": "generateFilters", + "description": [ + "\nGenerate filter objects, as a result of triggering a filter action on a\nspecific index pattern field.\n" + ], + "signature": [ + "(filterManager: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", - "text": "QueryState" + "section": "def-public.FilterManager", + "text": "FilterManager" }, - "; }>; }, \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">, stateContainer: ", + ", field: string | ", { - "pluginId": "kibanaUtils", + "pluginId": "dataViews", "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.BaseStateContainer", - "text": "BaseStateContainer" + "docId": "kibDataViewsPluginApi", + "section": "def-common.IFieldType", + "text": "IFieldType" }, - ", syncConfig: { time?: boolean | undefined; refreshInterval?: boolean | undefined; filters?: boolean | ", - "FilterStateStore", - " | undefined; query?: boolean | undefined; }) => () => void" + ", values: any, operation: string, index: string) => ", + "Filter", + "[]" ], - "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.connectToQueryState.$1", + "id": "def-public.generateFilters.$1", "type": "Object", "tags": [], - "label": "{\n timefilter: { timefilter },\n filterManager,\n queryString,\n state$,\n }", - "description": [], + "label": "filterManager", + "description": [ + "- The active filter manager to lookup for existing filters" + ], "signature": [ - "Pick<{ addToQueryLog: (appName: string, { language, query }: ", - "Query", - ") => void; filterManager: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", "section": "def-public.FilterManager", "text": "FilterManager" - }, - "; queryString: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringContract", - "text": "QueryStringContract" - }, - "; savedQueries: { createQuery: (attributes: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.SavedQueryAttributes", - "text": "SavedQueryAttributes" - }, - ", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; updateQuery: (id: string, attributes: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.SavedQueryAttributes", - "text": "SavedQueryAttributes" - }, - ") => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; getAllSavedQueries: () => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - "[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - "[]; }>; getSavedQuery: (id: string) => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; deleteSavedQuery: (id: string) => Promise<{}>; getSavedQueryCount: () => Promise; }; state$: ", - "Observable", - "<{ changes: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" - }, - "; state: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", - "text": "QueryState" - }, - "; }>; timefilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; getEsQuery: (indexPattern: ", + } + ], + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.generateFilters.$2", + "type": "CompoundType", + "tags": [], + "label": "field", + "description": [ + "- The field for which filters should be generated" + ], + "signature": [ + "string | ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ", timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | undefined) => { bool: ", - "BoolQuery", - "; }; } | { filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; timefilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; queryString: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringContract", - "text": "QueryStringContract" - }, - "; state$: ", - "Observable", - "<{ changes: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" - }, - "; state: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", - "text": "QueryState" - }, - "; }>; }, \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">" + "section": "def-common.IFieldType", + "text": "IFieldType" + } + ], + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.generateFilters.$3", + "type": "Any", + "tags": [], + "label": "values", + "description": [ + "- One or more values to filter for." + ], + "signature": [ + "any" + ], + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.generateFilters.$4", + "type": "string", + "tags": [], + "label": "operation", + "description": [ + "- \"-\" to create a negated filter" + ], + "signature": [ + "string" + ], + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.generateFilters.$5", + "type": "string", + "tags": [], + "label": "index", + "description": [ + "- Index string to generate filters for" + ], + "signature": [ + "string" ], - "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [ + "An array of filters to be added back to filterManager" + ], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.getDefaultQuery", + "type": "Function", + "tags": [], + "label": "getDefaultQuery", + "description": [], + "signature": [ + "(language: QueryLanguage) => { query: string; language: QueryLanguage; }" + ], + "path": "src/plugins/data/public/query/lib/get_default_query.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-public.connectToQueryState.$2", - "type": "Object", + "id": "def-public.getDefaultQuery.$1", + "type": "CompoundType", "tags": [], - "label": "stateContainer", - "description": [ - "to use for syncing" - ], + "label": "language", + "description": [], "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "common", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-common.BaseStateContainer", - "text": "BaseStateContainer" - }, - "" + "QueryLanguage" ], - "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "path": "src/plugins/data/public/query/lib/get_default_query.ts", "deprecated": false, "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.getDisplayValueFromFilter", + "type": "Function", + "tags": [], + "label": "getDisplayValueFromFilter", + "description": [], + "signature": [ + "(filter: ", + "Filter", + ", indexPatterns: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, + "[]) => string" + ], + "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", + "deprecated": false, + "children": [ { "parentPluginId": "data", - "id": "def-public.connectToQueryState.$3", + "id": "def-public.getDisplayValueFromFilter.$1", "type": "Object", "tags": [], - "label": "syncConfig", + "label": "filter", "description": [], - "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", + "signature": [ + "Filter" + ], + "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.connectToQueryState.$3.time", - "type": "CompoundType", - "tags": [], - "label": "time", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.connectToQueryState.$3.refreshInterval", - "type": "CompoundType", - "tags": [], - "label": "refreshInterval", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", - "deprecated": false - }, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.getDisplayValueFromFilter.$2", + "type": "Array", + "tags": [], + "label": "indexPatterns", + "description": [], + "signature": [ { - "parentPluginId": "data", - "id": "def-public.connectToQueryState.$3.filters", - "type": "CompoundType", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "boolean | ", - "FilterStateStore", - " | undefined" - ], - "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", - "deprecated": false + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, - { - "parentPluginId": "data", - "id": "def-public.connectToQueryState.$3.query", - "type": "CompoundType", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/data/public/query/state_sync/connect_to_query_state.ts", - "deprecated": false - } - ] + "[]" + ], + "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", + "deprecated": false, + "isRequired": true } ], "returnComment": [], @@ -1810,98 +1565,129 @@ }, { "parentPluginId": "data", - "id": "def-public.createSavedQueryService", + "id": "def-public.getFieldDisplayValueFromFilter", "type": "Function", "tags": [], - "label": "createSavedQueryService", + "label": "getFieldDisplayValueFromFilter", "description": [], "signature": [ - "(http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, - ") => { createQuery: (attributes: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.SavedQueryAttributes", - "text": "SavedQueryAttributes" - }, - ", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; updateQuery: (id: string, attributes: ", + "(filter: ", + "Filter", + ", indexPatterns: ", { - "pluginId": "data", + "pluginId": "dataViews", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.SavedQueryAttributes", - "text": "SavedQueryAttributes" + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, - ") => Promise<", + "[]) => string" + ], + "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", + "deprecated": false, + "children": [ { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" + "parentPluginId": "data", + "id": "def-public.getFieldDisplayValueFromFilter.$1", + "type": "Object", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "Filter" + ], + "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", + "deprecated": false, + "isRequired": true }, - ">; getAllSavedQueries: () => Promise<", { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - "[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ", + "parentPluginId": "data", + "id": "def-public.getFieldDisplayValueFromFilter.$2", + "type": "Array", + "tags": [], + "label": "indexPatterns", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[]" + ], + "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.getIndexPatternFromFilter", + "type": "Function", + "tags": [], + "label": "getIndexPatternFromFilter", + "description": [], + "signature": [ + "(filter: ", + "Filter", + ", indexPatterns: ", { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, - "[]; }>; getSavedQuery: (id: string) => Promise<", + "[]) => ", { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" }, - ">; deleteSavedQuery: (id: string) => Promise<{}>; getSavedQueryCount: () => Promise; }" + " | undefined" ], - "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", + "path": "src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.createSavedQueryService.$1", + "id": "def-public.getIndexPatternFromFilter.$1", "type": "Object", "tags": [], - "label": "http", + "label": "filter", + "description": [], + "signature": [ + "Filter" + ], + "path": "src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.getIndexPatternFromFilter.$2", + "type": "Array", + "tags": [], + "label": "indexPatterns", "description": [], "signature": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[]" ], - "path": "src/plugins/data/public/query/saved_query/saved_query_service.ts", + "path": "src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts", "deprecated": false, "isRequired": true } @@ -1911,32 +1697,24 @@ }, { "parentPluginId": "data", - "id": "def-public.extractTimeRange", + "id": "def-public.mapAndFlattenFilters", "type": "Function", "tags": [], - "label": "extractTimeRange", + "label": "mapAndFlattenFilters", "description": [], "signature": [ "(filters: ", "Filter", - "[], timeFieldName: string | undefined) => { restOfFilters: ", + "[]) => ", "Filter", - "[]; timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | undefined; }" + "[]" ], - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", + "path": "src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.extractTimeRange.$1", + "id": "def-public.mapAndFlattenFilters.$1", "type": "Array", "tags": [], "label": "filters", @@ -1945,23 +1723,9 @@ "Filter", "[]" ], - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", + "path": "src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.ts", "deprecated": false, "isRequired": true - }, - { - "parentPluginId": "data", - "id": "def-public.extractTimeRange.$2", - "type": "string", - "tags": [], - "label": "timeFieldName", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts", - "deprecated": false, - "isRequired": false } ], "returnComment": [], @@ -1969,545 +1733,690 @@ }, { "parentPluginId": "data", - "id": "def-public.generateFilters", + "id": "def-public.syncGlobalQueryStateWithUrl", "type": "Function", "tags": [], - "label": "generateFilters", + "label": "syncGlobalQueryStateWithUrl", "description": [ - "\nGenerate filter objects, as a result of triggering a filter action on a\nspecific index pattern field.\n" + "\nHelper to sync global query state {@link GlobalQueryStateFromUrl} with the URL (`_g` query param that is preserved between apps)" ], "signature": [ - "(filterManager: ", + "(query: Pick<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" + "section": "def-public.QueryStart", + "text": "QueryStart" }, - ", field: string | ", + " | ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QuerySetup", + "text": "QuerySetup" }, - ", values: any, operation: string, index: string) => ", - "Filter", - "[]" + ", \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">, kbnUrlStateStorage: ", + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.IKbnUrlStateStorage", + "text": "IKbnUrlStateStorage" + }, + ") => { stop: () => void; hasInheritedQueryFromUrl: boolean; }" ], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.generateFilters.$1", + "id": "def-public.syncGlobalQueryStateWithUrl.$1", "type": "Object", "tags": [], - "label": "filterManager", - "description": [ - "- The active filter manager to lookup for existing filters" - ], + "label": "query", + "description": [], "signature": [ + "Pick<", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - } + "section": "def-public.QueryStart", + "text": "QueryStart" + }, + " | ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QuerySetup", + "text": "QuerySetup" + }, + ", \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">" ], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "data", - "id": "def-public.generateFilters.$2", - "type": "CompoundType", + "id": "def-public.syncGlobalQueryStateWithUrl.$2", + "type": "Object", "tags": [], - "label": "field", + "label": "kbnUrlStateStorage", "description": [ - "- The field for which filters should be generated" + "to use for syncing" ], "signature": [ - "string | ", { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IFieldType", - "text": "IFieldType" + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.IKbnUrlStateStorage", + "text": "IKbnUrlStateStorage" } ], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", + "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", "deprecated": false, "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-public.syncQueryStateWithUrl", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "syncQueryStateWithUrl", + "description": [], + "signature": [ + "(query: Pick<", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStart", + "text": "QueryStart" }, + " | ", { - "parentPluginId": "data", - "id": "def-public.generateFilters.$3", - "type": "Any", - "tags": [], - "label": "values", - "description": [ - "- One or more values to filter for." - ], - "signature": [ - "any" - ], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", - "deprecated": false, - "isRequired": true + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QuerySetup", + "text": "QuerySetup" + }, + ", \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">, kbnUrlStateStorage: ", + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.IKbnUrlStateStorage", + "text": "IKbnUrlStateStorage" + }, + ") => { stop: () => void; hasInheritedQueryFromUrl: boolean; }" + ], + "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", + "deprecated": true, + "references": [ + { + "plugin": "discover", + "path": "src/plugins/discover/public/application/main/services/discover_state.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/public/application/main/services/discover_state.ts" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/visualize_app/app.tsx" + }, + { + "plugin": "visualizations", + "path": "src/plugins/visualizations/public/visualize_app/app.tsx" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/listing/dashboard_listing.tsx" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/public/application/listing/dashboard_listing.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/app_plugin/app.tsx" + }, + { + "plugin": "lens", + "path": "x-pack/plugins/lens/public/app_plugin/app.tsx" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" + }, + { + "plugin": "maps", + "path": "x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts" + }, + { + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/url_state.ts" }, + { + "plugin": "monitoring", + "path": "x-pack/plugins/monitoring/public/url_state.ts" + } + ], + "returnComment": [], + "children": [ { "parentPluginId": "data", - "id": "def-public.generateFilters.$4", - "type": "string", + "id": "def-public.syncQueryStateWithUrl.$1", + "type": "Object", "tags": [], - "label": "operation", - "description": [ - "- \"-\" to create a negated filter" - ], + "label": "query", + "description": [], "signature": [ - "string" + "{ state$: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryState", + "text": "QueryState" + }, + "$; timefilter: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + }, + "; filterManager: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + }, + "; queryString: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStringContract", + "text": "QueryStringContract" + }, + "; }" ], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.generateFilters.$5", - "type": "string", + "id": "def-public.syncQueryStateWithUrl.$2", + "type": "Object", "tags": [], - "label": "index", - "description": [ - "- Index string to generate filters for" - ], + "label": "kbnUrlStateStorage", + "description": [], "signature": [ - "string" + { + "pluginId": "kibanaUtils", + "scope": "public", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-public.IKbnUrlStateStorage", + "text": "IKbnUrlStateStorage" + } ], - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", + "deprecated": false } ], - "returnComment": [ - "An array of filters to be added back to filterManager" - ], "initialIsOpen": false - }, + } + ], + "interfaces": [ { "parentPluginId": "data", - "id": "def-public.getDefaultQuery", - "type": "Function", + "id": "def-public.GlobalQueryStateFromUrl", + "type": "Interface", "tags": [], - "label": "getDefaultQuery", - "description": [], - "signature": [ - "(language: QueryLanguage) => { query: string; language: QueryLanguage; }" + "label": "GlobalQueryStateFromUrl", + "description": [ + "\nPart of {@link QueryState} serialized in the `_g` portion of Url" ], - "path": "src/plugins/data/public/query/lib/get_default_query.ts", + "path": "src/plugins/data/public/query/state_sync/types.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.getDefaultQuery.$1", - "type": "CompoundType", + "id": "def-public.GlobalQueryStateFromUrl.time", + "type": "Object", "tags": [], - "label": "language", + "label": "time", "description": [], "signature": [ - "QueryLanguage" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined" ], - "path": "src/plugins/data/public/query/lib/get_default_query.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.getDisplayValueFromFilter", - "type": "Function", - "tags": [], - "label": "getDisplayValueFromFilter", - "description": [], - "signature": [ - "(filter: ", - "Filter", - ", indexPatterns: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "path": "src/plugins/data/public/query/state_sync/types.ts", + "deprecated": false }, - "[]) => string" - ], - "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-public.getDisplayValueFromFilter.$1", + "id": "def-public.GlobalQueryStateFromUrl.refreshInterval", "type": "Object", "tags": [], - "label": "filter", + "label": "refreshInterval", "description": [], "signature": [ - "Filter" + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + " | undefined" ], - "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/public/query/state_sync/types.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.getDisplayValueFromFilter.$2", + "id": "def-public.GlobalQueryStateFromUrl.filters", "type": "Array", "tags": [], - "label": "indexPatterns", + "label": "filters", "description": [], "signature": [ - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" - }, - "[]" + "Filter", + "[] | undefined" ], - "path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/public/query/state_sync/types.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.getIndexPatternFromFilter", - "type": "Function", + "id": "def-public.QuerySetup", + "type": "Interface", "tags": [], - "label": "getIndexPatternFromFilter", + "label": "QuerySetup", "description": [], "signature": [ - "(filter: ", - "Filter", - ", indexPatterns: ", { - "pluginId": "dataViews", + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QuerySetup", + "text": "QuerySetup" + }, + " extends ", + { + "pluginId": "kibanaUtils", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableStateService", + "text": "PersistableStateService" }, - "[]) => ", + "<", { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "docId": "kibDataQueryPluginApi", + "section": "def-common.QueryState", + "text": "QueryState" }, - " | undefined" + ">" ], - "path": "src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts", + "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, "children": [ { "parentPluginId": "data", - "id": "def-public.getIndexPatternFromFilter.$1", + "id": "def-public.QuerySetup.filterManager", "type": "Object", "tags": [], - "label": "filter", + "label": "filterManager", "description": [], "signature": [ - "Filter" + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + } ], - "path": "src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.getIndexPatternFromFilter.$2", - "type": "Array", + "id": "def-public.QuerySetup.timefilter", + "type": "Object", "tags": [], - "label": "indexPatterns", + "label": "timefilter", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + } + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.QuerySetup.queryString", + "type": "Object", + "tags": [], + "label": "queryString", "description": [], "signature": [ + "{ getDefaultQuery: () => { query: string; language: any; }; formatQuery: (query: string | ", + "Query", + " | undefined) => ", + "Query", + "; getUpdates$: () => ", + "Observable", + "<", + "Query", + ">; getQuery: () => ", + "Query", + "; setQuery: (query: ", + "Query", + ") => void; clearQuery: () => void; }" + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.QuerySetup.state$", + "type": "Object", + "tags": [], + "label": "state$", + "description": [], + "signature": [ + "Observable", + "<{ changes: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.QueryStateChange", + "text": "QueryStateChange" + }, + "; state: ", { - "pluginId": "dataViews", + "pluginId": "data", "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.DataView", - "text": "DataView" + "docId": "kibDataQueryPluginApi", + "section": "def-common.QueryState", + "text": "QueryState" }, - "[]" + "; }>" ], - "path": "src/plugins/data/public/query/filter_manager/lib/get_index_pattern_from_filter.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.mapAndFlattenFilters", - "type": "Function", - "tags": [], - "label": "mapAndFlattenFilters", - "description": [], - "signature": [ - "(filters: ", - "Filter", - "[]) => ", - "Filter", - "[]" - ], - "path": "src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.ts", - "deprecated": false, - "children": [ + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false + }, { "parentPluginId": "data", - "id": "def-public.mapAndFlattenFilters.$1", - "type": "Array", + "id": "def-public.QuerySetup.getState", + "type": "Function", "tags": [], - "label": "filters", + "label": "getState", "description": [], "signature": [ - "Filter", - "[]" + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.QueryState", + "text": "QueryState" + } ], - "path": "src/plugins/data/public/query/filter_manager/lib/map_and_flatten_filters.ts", + "path": "src/plugins/data/public/query/query_service.ts", "deprecated": false, - "isRequired": true + "children": [], + "returnComment": [] } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "data", - "id": "def-public.syncQueryStateWithUrl", - "type": "Function", + "id": "def-public.QueryStart", + "type": "Interface", "tags": [], - "label": "syncQueryStateWithUrl", - "description": [ - "\nHelper to setup syncing of global data with the URL" - ], + "label": "QueryStart", + "description": [], "signature": [ - "(query: Pick<{ addToQueryLog: (appName: string, { language, query }: ", - "Query", - ") => void; filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; queryString: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringContract", - "text": "QueryStringContract" + "section": "def-public.QueryStart", + "text": "QueryStart" }, - "; savedQueries: { createQuery: (attributes: ", + " extends ", { - "pluginId": "data", + "pluginId": "kibanaUtils", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.SavedQueryAttributes", - "text": "SavedQueryAttributes" - }, - ", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableStateService", + "text": "PersistableStateService" }, - ">; updateQuery: (id: string, attributes: ", + "<", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", - "section": "def-common.SavedQueryAttributes", - "text": "SavedQueryAttributes" - }, - ") => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; getAllSavedQueries: () => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - "[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - "[]; }>; getSavedQuery: (id: string) => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; deleteSavedQuery: (id: string) => Promise<{}>; getSavedQueryCount: () => Promise; }; state$: ", - "Observable", - "<{ changes: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" - }, - "; state: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", + "section": "def-common.QueryState", "text": "QueryState" }, - "; }>; timefilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; getEsQuery: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ", timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | undefined) => { bool: ", - "BoolQuery", - "; }; } | { filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; timefilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; queryString: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringContract", - "text": "QueryStringContract" - }, - "; state$: ", - "Observable", - "<{ changes: ", + ">" + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false, + "children": [ { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" + "parentPluginId": "data", + "id": "def-public.QueryStart.filterManager", + "type": "Object", + "tags": [], + "label": "filterManager", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.FilterManager", + "text": "FilterManager" + } + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false }, - "; state: ", { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", - "text": "QueryState" + "parentPluginId": "data", + "id": "def-public.QueryStart.timefilter", + "type": "Object", + "tags": [], + "label": "timefilter", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimefilterSetup", + "text": "TimefilterSetup" + } + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false }, - "; }>; }, \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">, kbnUrlStateStorage: ", { - "pluginId": "kibanaUtils", - "scope": "public", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-public.IKbnUrlStateStorage", - "text": "IKbnUrlStateStorage" + "parentPluginId": "data", + "id": "def-public.QueryStart.queryString", + "type": "Object", + "tags": [], + "label": "queryString", + "description": [], + "signature": [ + "{ getDefaultQuery: () => { query: string; language: any; }; formatQuery: (query: string | ", + "Query", + " | undefined) => ", + "Query", + "; getUpdates$: () => ", + "Observable", + "<", + "Query", + ">; getQuery: () => ", + "Query", + "; setQuery: (query: ", + "Query", + ") => void; clearQuery: () => void; }" + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false }, - ") => { stop: () => void; hasInheritedQueryFromUrl: boolean; }" - ], - "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", - "deprecated": false, - "children": [ { "parentPluginId": "data", - "id": "def-public.syncQueryStateWithUrl.$1", + "id": "def-public.QueryStart.state$", "type": "Object", "tags": [], - "label": "query", + "label": "state$", "description": [], "signature": [ - "Pick<{ addToQueryLog: (appName: string, { language, query }: ", - "Query", - ") => void; filterManager: ", + "Observable", + "<{ changes: ", { "pluginId": "data", "scope": "public", "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" + "section": "def-public.QueryStateChange", + "text": "QueryStateChange" }, - "; queryString: ", + "; state: ", { "pluginId": "data", - "scope": "public", + "scope": "common", "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringContract", - "text": "QueryStringContract" + "section": "def-common.QueryState", + "text": "QueryState" + }, + "; }>" + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false + }, + { + "parentPluginId": "data", + "id": "def-public.QueryStart.getState", + "type": "Function", + "tags": [], + "label": "getState", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.QueryState", + "text": "QueryState" + } + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-public.QueryStart.addToQueryLog", + "type": "Function", + "tags": [], + "label": "addToQueryLog", + "description": [], + "signature": [ + "(appName: string, { language, query }: ", + "Query", + ") => void" + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-public.QueryStart.addToQueryLog.$1", + "type": "string", + "tags": [], + "label": "appName", + "description": [], + "path": "src/plugins/data/public/query/lib/add_to_query_log.ts", + "deprecated": false }, - "; savedQueries: { createQuery: (attributes: ", + { + "parentPluginId": "data", + "id": "def-public.QueryStart.addToQueryLog.$2", + "type": "Object", + "tags": [], + "label": "__1", + "description": [], + "signature": [ + "{ query: string | { [key: string]: any; }; language: string; }" + ], + "path": "src/plugins/data/public/query/lib/add_to_query_log.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "data", + "id": "def-public.QueryStart.savedQueries", + "type": "Object", + "tags": [], + "label": "savedQueries", + "description": [], + "signature": [ + "{ createQuery: (attributes: ", { "pluginId": "data", "scope": "common", @@ -2563,205 +2472,85 @@ "section": "def-public.SavedQuery", "text": "SavedQuery" }, - ">; deleteSavedQuery: (id: string) => Promise<{}>; getSavedQueryCount: () => Promise; }; state$: ", - "Observable", - "<{ changes: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" - }, - "; state: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", - "text": "QueryState" - }, - "; }>; timefilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; getEsQuery: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ", timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | undefined) => { bool: ", - "BoolQuery", - "; }; } | { filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; timefilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; queryString: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringContract", - "text": "QueryStringContract" - }, - "; state$: ", - "Observable", - "<{ changes: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" - }, - "; state: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", - "text": "QueryState" - }, - "; }>; }, \"state$\" | \"timefilter\" | \"filterManager\" | \"queryString\">" + ">; deleteSavedQuery: (id: string) => Promise<{}>; getSavedQueryCount: () => Promise; }" ], - "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", - "deprecated": false, - "isRequired": true + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false }, { "parentPluginId": "data", - "id": "def-public.syncQueryStateWithUrl.$2", - "type": "Object", - "tags": [], - "label": "kbnUrlStateStorage", - "description": [ - "to use for syncing" - ], - "signature": [ - { - "pluginId": "kibanaUtils", - "scope": "public", - "docId": "kibKibanaUtilsPluginApi", - "section": "def-public.IKbnUrlStateStorage", - "text": "IKbnUrlStateStorage" - } - ], - "path": "src/plugins/data/public/query/state_sync/sync_state_with_url.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "parentPluginId": "data", - "id": "def-public.QueryState", - "type": "Interface", - "tags": [], - "label": "QueryState", - "description": [ - "\nAll query state service state" - ], - "path": "src/plugins/data/public/query/state_sync/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "data", - "id": "def-public.QueryState.time", - "type": "Object", + "id": "def-public.QueryStart.getEsQuery", + "type": "Function", "tags": [], - "label": "time", + "label": "getEsQuery", "description": [], "signature": [ + "(indexPattern: ", { - "pluginId": "data", + "pluginId": "dataViews", "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" + "docId": "kibDataViewsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" }, - " | undefined" - ], - "path": "src/plugins/data/public/query/state_sync/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QueryState.refreshInterval", - "type": "Object", - "tags": [], - "label": "refreshInterval", - "description": [], - "signature": [ + ", timeRange?: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", - "section": "def-common.RefreshInterval", - "text": "RefreshInterval" + "section": "def-common.TimeRange", + "text": "TimeRange" }, - " | undefined" - ], - "path": "src/plugins/data/public/query/state_sync/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QueryState.filters", - "type": "Array", - "tags": [], - "label": "filters", - "description": [], - "signature": [ - "Filter", - "[] | undefined" - ], - "path": "src/plugins/data/public/query/state_sync/types.ts", - "deprecated": false - }, - { - "parentPluginId": "data", - "id": "def-public.QueryState.query", - "type": "Object", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "Query", - " | undefined" + " | undefined) => { bool: ", + "BoolQuery", + "; }" ], - "path": "src/plugins/data/public/query/state_sync/types.ts", - "deprecated": false + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-public.QueryStart.getEsQuery.$1", + "type": "Object", + "tags": [], + "label": "indexPattern", + "description": [], + "signature": [ + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.IndexPattern", + "text": "IndexPattern" + } + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-public.QueryStart.getEsQuery.$2", + "type": "Object", + "tags": [], + "label": "timeRange", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined" + ], + "path": "src/plugins/data/public/query/query_service.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -3301,9 +3090,7 @@ "label": "history", "description": [], "signature": [ - "{ get$: () => ", - "Observable", - "<", + "{ get: () => ", { "pluginId": "data", "scope": "common", @@ -3311,7 +3098,7 @@ "section": "def-common.TimeRange", "text": "TimeRange" }, - "[]>; add: (time: ", + "[]; add: (time: ", { "pluginId": "data", "scope": "common", @@ -3319,7 +3106,9 @@ "section": "def-common.TimeRange", "text": "TimeRange" }, - ") => void; get: () => ", + ") => void; get$: () => ", + "Observable", + "<", { "pluginId": "data", "scope": "common", @@ -3327,7 +3116,7 @@ "section": "def-common.TimeRange", "text": "TimeRange" }, - "[]; }" + "[]>; }" ], "path": "src/plugins/data/public/query/timefilter/timefilter_service.ts", "deprecated": false @@ -3356,37 +3145,12 @@ }, { "parentPluginId": "data", - "id": "def-public.QuerySetup", + "id": "def-public.QueryState$", "type": "Type", "tags": [], - "label": "QuerySetup", + "label": "QueryState$", "description": [], "signature": [ - "{ filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; timefilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; queryString: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringContract", - "text": "QueryStringContract" - }, - "; state$: ", "Observable", "<{ changes: ", { @@ -3397,148 +3161,16 @@ "text": "QueryStateChange" }, "; state: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", - "text": "QueryState" - }, - "; }>; }" - ], - "path": "src/plugins/data/public/query/query_service.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "data", - "id": "def-public.QueryStart", - "type": "Type", - "tags": [], - "label": "QueryStart", - "description": [], - "signature": [ - "{ addToQueryLog: (appName: string, { language, query }: ", - "Query", - ") => void; filterManager: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.FilterManager", - "text": "FilterManager" - }, - "; queryString: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStringContract", - "text": "QueryStringContract" - }, - "; savedQueries: { createQuery: (attributes: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.SavedQueryAttributes", - "text": "SavedQueryAttributes" - }, - ", { overwrite }?: { overwrite?: boolean | undefined; }) => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; updateQuery: (id: string, attributes: ", { "pluginId": "data", "scope": "common", "docId": "kibDataQueryPluginApi", - "section": "def-common.SavedQueryAttributes", - "text": "SavedQueryAttributes" - }, - ") => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; getAllSavedQueries: () => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - "[]>; findSavedQueries: (search?: string, perPage?: number, page?: number) => Promise<{ total: number; queries: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - "[]; }>; getSavedQuery: (id: string) => Promise<", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.SavedQuery", - "text": "SavedQuery" - }, - ">; deleteSavedQuery: (id: string) => Promise<{}>; getSavedQueryCount: () => Promise; }; state$: ", - "Observable", - "<{ changes: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryStateChange", - "text": "QueryStateChange" - }, - "; state: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.QueryState", + "section": "def-common.QueryState", "text": "QueryState" }, - "; }>; timefilter: ", - { - "pluginId": "data", - "scope": "public", - "docId": "kibDataQueryPluginApi", - "section": "def-public.TimefilterSetup", - "text": "TimefilterSetup" - }, - "; getEsQuery: (indexPattern: ", - { - "pluginId": "dataViews", - "scope": "common", - "docId": "kibDataViewsPluginApi", - "section": "def-common.IndexPattern", - "text": "IndexPattern" - }, - ", timeRange?: ", - { - "pluginId": "data", - "scope": "common", - "docId": "kibDataQueryPluginApi", - "section": "def-common.TimeRange", - "text": "TimeRange" - }, - " | undefined) => { bool: ", - "BoolQuery", - "; }; }" + "; }>" ], - "path": "src/plugins/data/public/query/query_service.ts", + "path": "src/plugins/data/public/query/state_sync/create_query_state_observable.ts", "deprecated": false, "initialIsOpen": false }, @@ -3759,9 +3391,7 @@ "label": "TimeHistoryContract", "description": [], "signature": [ - "{ get$: () => ", - "Observable", - "<", + "{ get: () => ", { "pluginId": "data", "scope": "common", @@ -3769,7 +3399,7 @@ "section": "def-common.TimeRange", "text": "TimeRange" }, - "[]>; add: (time: ", + "[]; add: (time: ", { "pluginId": "data", "scope": "common", @@ -3777,7 +3407,9 @@ "section": "def-common.TimeRange", "text": "TimeRange" }, - ") => void; get: () => ", + ") => void; get$: () => ", + "Observable", + "<", { "pluginId": "data", "scope": "common", @@ -3785,7 +3417,7 @@ "section": "def-common.TimeRange", "text": "TimeRange" }, - "[]; }" + "[]>; }" ], "path": "src/plugins/data/public/query/timefilter/time_history.ts", "deprecated": false, @@ -4249,6 +3881,60 @@ ], "returnComment": [], "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-common.queryStateToExpressionAst", + "type": "Function", + "tags": [], + "label": "queryStateToExpressionAst", + "description": [ + "\nConverts QueryState to expression AST" + ], + "signature": [ + "({ filters, query, time }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.QueryState", + "text": "QueryState" + }, + ") => ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" + } + ], + "path": "src/plugins/data/common/query/to_expression_ast.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.queryStateToExpressionAst.$1", + "type": "Object", + "tags": [], + "label": "{ filters, query, time }", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.QueryState", + "text": "QueryState" + } + ], + "path": "src/plugins/data/common/query/to_expression_ast.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false } ], "interfaces": [ @@ -4416,6 +4102,42 @@ ], "enums": [], "misc": [ + { + "parentPluginId": "data", + "id": "def-common.QueryState", + "type": "Type", + "tags": [], + "label": "QueryState", + "description": [ + "\nAll query state service state\n" + ], + "signature": [ + "{ time?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.TimeRange", + "text": "TimeRange" + }, + " | undefined; refreshInterval?: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataQueryPluginApi", + "section": "def-common.RefreshInterval", + "text": "RefreshInterval" + }, + " | undefined; filters?: ", + "Filter", + "[] | undefined; query?: ", + "Query", + " | undefined; }" + ], + "path": "src/plugins/data/common/query/query_state.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.RefreshInterval", diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index 76b3bbc03583e..c69c181b91554 100644 --- a/api_docs/data_query.mdx +++ b/api_docs/data_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-query title: "data.query" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.query plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3414 | 38 | 2802 | 18 | +| 3489 | 38 | 2874 | 20 | ## Client diff --git a/api_docs/data_search.devdocs.json b/api_docs/data_search.devdocs.json index 733c32b8df845..e0f7557060304 100644 --- a/api_docs/data_search.devdocs.json +++ b/api_docs/data_search.devdocs.json @@ -1422,6 +1422,1201 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService", + "type": "Class", + "tags": [], + "label": "SearchSessionService", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.SearchSessionService", + "text": "SearchSessionService" + }, + " implements ", + { + "pluginId": "data", + "scope": "server", + "docId": "kibDataSearchPluginApi", + "section": "def-server.ISearchSessionService", + "text": "ISearchSessionService" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Readonly<{} & { search: Readonly<{} & { aggs: Readonly<{} & { shardDelay: Readonly<{} & { enabled: boolean; }>; }>; sessions: Readonly<{} & { enabled: boolean; pageSize: number; trackingInterval: moment.Duration; cleanupInterval: moment.Duration; expireInterval: moment.Duration; monitoringTaskTimeout: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; }>; }>; }>" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.Unnamed.$3", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.setup", + "type": "Function", + "tags": [], + "label": "setup", + "description": [], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + ", deps: SetupDependencies) => void" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.setup.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreSetup", + "text": "CoreSetup" + }, + "" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.setup.$2", + "type": "Object", + "tags": [], + "label": "deps", + "description": [], + "signature": [ + "SetupDependencies" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.start", + "type": "Function", + "tags": [], + "label": "start", + "description": [], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ", deps: StartDependencies) => Promise" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.start.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.start.$2", + "type": "Object", + "tags": [], + "label": "deps", + "description": [], + "signature": [ + "StartDependencies" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "() => void" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.save", + "type": "Function", + "tags": [], + "label": "save", + "description": [], + "signature": [ + "(deps: ", + "SearchSessionDependencies", + ", user: ", + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null, sessionId: string, { name, appId, locatorId, initialState, restoreState, }: Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">) => Promise<", + "SavedObject", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + "> | undefined>" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.save.$1", + "type": "Object", + "tags": [], + "label": "deps", + "description": [], + "signature": [ + "SearchSessionDependencies" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.save.$2", + "type": "CompoundType", + "tags": [], + "label": "user", + "description": [], + "signature": [ + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.save.$3", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.save.$4", + "type": "Object", + "tags": [], + "label": "{\n name,\n appId,\n locatorId,\n initialState = {},\n restoreState = {},\n }", + "description": [], + "signature": [ + "Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "({ savedObjectsClient }: ", + "SearchSessionDependencies", + ", user: ", + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null, sessionId: string) => Promise<", + "SavedObject", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">>" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.get.$1", + "type": "Object", + "tags": [], + "label": "{ savedObjectsClient }", + "description": [], + "signature": [ + "SearchSessionDependencies" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.get.$2", + "type": "CompoundType", + "tags": [], + "label": "user", + "description": [], + "signature": [ + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.get.$3", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.find", + "type": "Function", + "tags": [], + "label": "find", + "description": [], + "signature": [ + "({ savedObjectsClient }: ", + "SearchSessionDependencies", + ", user: ", + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null, options: Omit<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\">) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ", unknown>>" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.find.$1", + "type": "Object", + "tags": [], + "label": "{ savedObjectsClient }", + "description": [], + "signature": [ + "SearchSessionDependencies" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.find.$2", + "type": "CompoundType", + "tags": [], + "label": "user", + "description": [], + "signature": [ + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.find.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Omit<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\">" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.update", + "type": "Function", + "tags": [], + "label": "update", + "description": [], + "signature": [ + "(deps: ", + "SearchSessionDependencies", + ", user: ", + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null, sessionId: string, attributes: Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">>" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.update.$1", + "type": "Object", + "tags": [], + "label": "deps", + "description": [], + "signature": [ + "SearchSessionDependencies" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.update.$2", + "type": "CompoundType", + "tags": [], + "label": "user", + "description": [], + "signature": [ + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.update.$3", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.update.$4", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.extend", + "type": "Function", + "tags": [], + "label": "extend", + "description": [], + "signature": [ + "(deps: ", + "SearchSessionDependencies", + ", user: ", + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null, sessionId: string, expires: Date) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">>" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.extend.$1", + "type": "Object", + "tags": [], + "label": "deps", + "description": [], + "signature": [ + "SearchSessionDependencies" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.extend.$2", + "type": "CompoundType", + "tags": [], + "label": "user", + "description": [], + "signature": [ + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.extend.$3", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.extend.$4", + "type": "Object", + "tags": [], + "label": "expires", + "description": [], + "signature": [ + "Date" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.cancel", + "type": "Function", + "tags": [], + "label": "cancel", + "description": [], + "signature": [ + "(deps: ", + "SearchSessionDependencies", + ", user: ", + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null, sessionId: string) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">>" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.cancel.$1", + "type": "Object", + "tags": [], + "label": "deps", + "description": [], + "signature": [ + "SearchSessionDependencies" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.cancel.$2", + "type": "CompoundType", + "tags": [], + "label": "user", + "description": [], + "signature": [ + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.cancel.$3", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [], + "signature": [ + "(deps: ", + "SearchSessionDependencies", + ", user: ", + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null, sessionId: string) => Promise<{}>" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.delete.$1", + "type": "Object", + "tags": [], + "label": "deps", + "description": [], + "signature": [ + "SearchSessionDependencies" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.delete.$2", + "type": "CompoundType", + "tags": [], + "label": "user", + "description": [], + "signature": [ + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.delete.$3", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.getSearchIdMapping", + "type": "Function", + "tags": [], + "label": "getSearchIdMapping", + "description": [], + "signature": [ + "(deps: ", + "SearchSessionDependencies", + ", user: ", + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null, sessionId: string) => Promise>" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.getSearchIdMapping.$1", + "type": "Object", + "tags": [], + "label": "deps", + "description": [], + "signature": [ + "SearchSessionDependencies" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.getSearchIdMapping.$2", + "type": "CompoundType", + "tags": [], + "label": "user", + "description": [], + "signature": [ + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.AuthenticatedUser", + "text": "AuthenticatedUser" + }, + " | null" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.getSearchIdMapping.$3", + "type": "string", + "tags": [], + "label": "sessionId", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.asScopedProvider", + "type": "Function", + "tags": [], + "label": "asScopedProvider", + "description": [], + "signature": [ + "({ savedObjects }: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + }, + ") => (request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => { getId: (args_0: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" + }, + ", args_1: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => Promise; trackId: (args_0: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.IKibanaSearchRequest", + "text": "IKibanaSearchRequest" + }, + ", args_1: string, args_2: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.ISearchOptions", + "text": "ISearchOptions" + }, + ") => Promise; getSearchIdMapping: (sessionId: string) => Promise>; save: (args_0: string, args_1: Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">) => Promise<", + "SavedObject", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + "> | undefined>; get: (sessionId: string) => Promise<", + "SavedObject", + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">>; find: (options: Omit<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ", \"type\">) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ", unknown>>; update: (sessionId: string, attributes: Partial<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">>; extend: (sessionId: string, expires: Date) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">>; cancel: (sessionId: string) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + "<", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.SearchSessionSavedObjectAttributes", + "text": "SearchSessionSavedObjectAttributes" + }, + ">>; delete: (sessionId: string) => Promise<{}>; getConfig: () => Readonly<{} & { enabled: boolean; pageSize: number; trackingInterval: moment.Duration; cleanupInterval: moment.Duration; expireInterval: moment.Duration; monitoringTaskTimeout: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; management: Readonly<{} & { refreshInterval: moment.Duration; maxSessions: number; refreshTimeout: moment.Duration; expiresSoonWarning: moment.Duration; }>; }>; }" + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-server.SearchSessionService.asScopedProvider.$1", + "type": "Object", + "tags": [], + "label": "{ savedObjects }", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreStart", + "text": "CoreStart" + } + ], + "path": "src/plugins/data/server/search/session/session_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false } ], "functions": [], @@ -8341,6 +9536,10 @@ "path": "src/plugins/data/common/search/search_source/search_source.ts", "deprecated": true, "references": [ + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.ts" + }, { "plugin": "discover", "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" @@ -8348,6 +9547,10 @@ { "plugin": "discover", "path": "src/plugins/discover/public/embeddable/saved_search_embeddable.tsx" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.ts" } ], "children": [], @@ -8617,16 +9820,36 @@ "removeBy": "8.1", "references": [ { - "plugin": "discover", - "path": "src/plugins/discover/public/application/context/services/anchor.ts" + "plugin": "stackAlerts", + "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts" }, { - "plugin": "discover", - "path": "src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts" + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" }, { - "plugin": "stackAlerts", - "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts" + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" + }, + { + "plugin": "alerting", + "path": "x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts" }, { "plugin": "stackAlerts", @@ -8636,6 +9859,22 @@ "plugin": "stackAlerts", "path": "x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts" }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" + }, + { + "plugin": "securitySolution", + "path": "x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts" + }, { "plugin": "inputControlVis", "path": "src/plugins/input_control_vis/public/control/list_control_factory.ts" @@ -11447,7 +12686,15 @@ "label": "getFilteredMetricAgg", "description": [], "signature": [ - "() => ", + "({ getConfig }: ", + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.FiltersMetricAggDependencies", + "text": "FiltersMetricAggDependencies" + }, + ") => ", { "pluginId": "data", "scope": "common", @@ -11467,7 +12714,28 @@ ], "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "data", + "id": "def-common.getFilteredMetricAgg.$1", + "type": "Object", + "tags": [], + "label": "{ getConfig }", + "description": [], + "signature": [ + { + "pluginId": "data", + "scope": "common", + "docId": "kibDataSearchPluginApi", + "section": "def-common.FiltersMetricAggDependencies", + "text": "FiltersMetricAggDependencies" + } + ], + "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", + "deprecated": false, + "isRequired": true + } + ], "returnComment": [], "initialIsOpen": false }, @@ -13341,6 +14609,37 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.isSerializedSearchSource", + "type": "Function", + "tags": [], + "label": "isSerializedSearchSource", + "description": [], + "signature": [ + "(maybeSerializedSearchSource: unknown) => boolean" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.isSerializedSearchSource.$1", + "type": "Unknown", + "tags": [], + "label": "maybeSerializedSearchSource", + "description": [], + "signature": [ + "unknown" + ], + "path": "src/plugins/data/common/search/search_source/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.isStringOrNumberType", @@ -21308,6 +22607,49 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "data", + "id": "def-common.FiltersMetricAggDependencies", + "type": "Interface", + "tags": [], + "label": "FiltersMetricAggDependencies", + "description": [], + "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.FiltersMetricAggDependencies.getConfig", + "type": "Function", + "tags": [], + "label": "getConfig", + "description": [], + "signature": [ + "(key: string) => T" + ], + "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "data", + "id": "def-common.FiltersMetricAggDependencies.getConfig.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/data/common/search/aggs/metrics/filtered_metric.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "data", "id": "def-common.HistogramBucketAggDependencies", diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index ae24c35139513..fb7595b89a21a 100644 --- a/api_docs/data_search.mdx +++ b/api_docs/data_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-search title: "data.search" image: https://source.unsplash.com/400x175/?github summary: API docs for the data.search plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 3414 | 38 | 2802 | 18 | +| 3489 | 38 | 2874 | 20 | ## Client diff --git a/api_docs/data_view_editor.devdocs.json b/api_docs/data_view_editor.devdocs.json index fd2a8166663dd..86703f76519a4 100644 --- a/api_docs/data_view_editor.devdocs.json +++ b/api_docs/data_view_editor.devdocs.json @@ -106,6 +106,21 @@ ], "path": "src/plugins/data_view_editor/public/types.ts", "deprecated": false + }, + { + "parentPluginId": "dataViewEditor", + "id": "def-public.DataViewEditorProps.showEmptyPrompt", + "type": "CompoundType", + "tags": [], + "label": "showEmptyPrompt", + "description": [ + "\nIf set to false, the screen for prompting a user to create a data view will be skipped, and the user will be taken directly\nto data view creation." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/data_view_editor/public/types.ts", + "deprecated": false } ], "initialIsOpen": false diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 01bc3bf40b471..79d79f21cd941 100644 --- a/api_docs/data_view_editor.mdx +++ b/api_docs/data_view_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewEditor title: "dataViewEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewEditor plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 13 | 0 | 7 | 0 | +| 14 | 0 | 7 | 0 | ## Client diff --git a/api_docs/data_view_field_editor.mdx b/api_docs/data_view_field_editor.mdx index 27b12a115195c..c0535e6e74ef0 100644 --- a/api_docs/data_view_field_editor.mdx +++ b/api_docs/data_view_field_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor title: "dataViewFieldEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewFieldEditor plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_view_management.mdx b/api_docs/data_view_management.mdx index b1bfe293c7c92..024d28f66182b 100644 --- a/api_docs/data_view_management.mdx +++ b/api_docs/data_view_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewManagement title: "dataViewManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViewManagement plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/data_views.devdocs.json b/api_docs/data_views.devdocs.json index 327d6e36ba3f4..aa7880b787b46 100644 --- a/api_docs/data_views.devdocs.json +++ b/api_docs/data_views.devdocs.json @@ -4075,6 +4075,10 @@ "plugin": "data", "path": "src/plugins/data/public/query/query_service.ts" }, + { + "plugin": "data", + "path": "src/plugins/data/public/query/query_service.ts" + }, { "plugin": "savedObjects", "path": "src/plugins/saved_objects/public/types.ts" @@ -4220,106 +4224,6 @@ "path": "src/plugins/data_views/common/fields/data_view_field.ts", "deprecated": true, "references": [ - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, { "plugin": "data", "path": "src/plugins/data/public/index.ts" @@ -4607,6 +4511,106 @@ { "plugin": "dataViewEditor", "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/index.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/search_source/search_source.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/search_source/search_source.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/search_source/search_source.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/server/index.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/param_types/field.ts" } ], "children": [], @@ -6637,6 +6641,29 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "dataViews", + "id": "def-public.IndicesViaSearchResponse", + "type": "Interface", + "tags": [], + "label": "IndicesViaSearchResponse", + "description": [], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataViews", + "id": "def-public.IndicesViaSearchResponse.total", + "type": "number", + "tags": [], + "label": "total", + "description": [], + "path": "src/plugins/data_views/public/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "dataViews", "id": "def-public.TypeMeta", @@ -7084,22 +7111,6 @@ "plugin": "data", "path": "src/plugins/data/public/search/search_service.ts" }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" @@ -15711,6 +15722,10 @@ "plugin": "data", "path": "src/plugins/data/public/query/query_service.ts" }, + { + "plugin": "data", + "path": "src/plugins/data/public/query/query_service.ts" + }, { "plugin": "savedObjects", "path": "src/plugins/saved_objects/public/types.ts" @@ -15858,119 +15873,19 @@ "references": [ { "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + "path": "src/plugins/data/public/index.ts" }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/shared_imports.ts" }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" }, { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/param_types/field.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/server/index.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/public/index.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/shared_imports.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" - }, - { - "plugin": "dataViewEditor", - "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" + "plugin": "dataViewEditor", + "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.ts" }, { "plugin": "maps", @@ -16243,6 +16158,106 @@ { "plugin": "dataViewEditor", "path": "src/plugins/data_view_editor/public/lib/extract_time_fields.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/index.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/expressions/kibana_context_type.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/search_source/search_source.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/search_source/search_source.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/search_source/search_source.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/server/index.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/agg_config.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/_terms_other_bucket_helper.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/multi_terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/rare_terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/buckets/terms.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/utils/infer_time_zone.test.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/param_types/field.ts" + }, + { + "plugin": "data", + "path": "src/plugins/data/common/search/aggs/param_types/field.ts" } ], "children": [], @@ -18925,11 +18940,11 @@ }, { "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts" + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts" }, { "plugin": "data", - "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts" + "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts" }, { "plugin": "data", @@ -18941,11 +18956,11 @@ }, { "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts" }, { "plugin": "data", - "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts" + "path": "src/plugins/data/common/search/aggs/buckets/date_histogram.ts" }, { "plugin": "data", @@ -18971,94 +18986,6 @@ "plugin": "unifiedSearch", "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx" }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/phrase_suggestor.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/range_value_input.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_enum.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/server/autocomplete/terms_agg.ts" - }, { "plugin": "data", "path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.test.ts" @@ -19085,43 +19012,27 @@ }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_operators.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/value_input_type.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/value_input_type.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" }, { "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/filter_bar/filter_editor/index.tsx" + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" } ], "children": [ @@ -19427,26 +19338,6 @@ "plugin": "data", "path": "src/plugins/data/common/query/timefilter/get_time.ts" }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/normalize_sort_request.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/normalize_sort_request.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/normalize_sort_request.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, - { - "plugin": "data", - "path": "src/plugins/data/common/search/search_source/search_source.ts" - }, { "plugin": "data", "path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts" @@ -19473,35 +19364,27 @@ }, { "plugin": "data", - "path": "src/plugins/data/public/index.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" + "path": "src/plugins/data/common/search/search_source/normalize_sort_request.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" + "plugin": "data", + "path": "src/plugins/data/common/search/search_source/normalize_sort_request.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" + "plugin": "data", + "path": "src/plugins/data/common/search/search_source/normalize_sort_request.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + "plugin": "data", + "path": "src/plugins/data/common/search/search_source/search_source.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + "plugin": "data", + "path": "src/plugins/data/common/search/search_source/search_source.ts" }, { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + "plugin": "data", + "path": "src/plugins/data/public/index.ts" }, { "plugin": "data", @@ -19566,6 +19449,34 @@ { "plugin": "data", "path": "src/plugins/data/public/query/filter_manager/lib/mappers/map_exists.test.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" + }, + { + "plugin": "unifiedSearch", + "path": "src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts" } ], "children": [ @@ -21904,22 +21815,6 @@ "plugin": "data", "path": "src/plugins/data/public/search/search_service.ts" }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx" - }, - { - "plugin": "unifiedSearch", - "path": "src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx" - }, { "plugin": "maps", "path": "x-pack/plugins/maps/public/lazy_load_bundle/index.ts" @@ -21977,7 +21872,7 @@ "section": "def-public.ErrorToastOptions", "text": "ErrorToastOptions" }, - ") => void" + ", key: string) => void" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, @@ -22014,6 +21909,16 @@ ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.OnError.$3", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -22034,7 +21939,7 @@ "section": "def-public.ToastInputFields", "text": "ToastInputFields" }, - ") => void" + ", key: string) => void" ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false, @@ -22070,6 +21975,16 @@ ], "path": "src/plugins/data_views/common/types.ts", "deprecated": false + }, + { + "parentPluginId": "dataViews", + "id": "def-common.OnNotification.$2", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "path": "src/plugins/data_views/common/types.ts", + "deprecated": false } ], "initialIsOpen": false diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index 24669a558c24f..b1f5398789392 100644 --- a/api_docs/data_views.mdx +++ b/api_docs/data_views.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViews title: "dataViews" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataViews plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 862 | 3 | 710 | 15 | +| 866 | 3 | 714 | 15 | ## Client diff --git a/api_docs/data_visualizer.devdocs.json b/api_docs/data_visualizer.devdocs.json index f1872077f3338..523e60342f41d 100644 --- a/api_docs/data_visualizer.devdocs.json +++ b/api_docs/data_visualizer.devdocs.json @@ -4,6 +4,55 @@ "classes": [], "functions": [], "interfaces": [ + { + "parentPluginId": "dataVisualizer", + "id": "def-public.GetAdditionalLinksParams", + "type": "Interface", + "tags": [], + "label": "GetAdditionalLinksParams", + "description": [], + "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "dataVisualizer", + "id": "def-public.GetAdditionalLinksParams.dataViewId", + "type": "string", + "tags": [], + "label": "dataViewId", + "description": [], + "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx", + "deprecated": false + }, + { + "parentPluginId": "dataVisualizer", + "id": "def-public.GetAdditionalLinksParams.dataViewTitle", + "type": "string", + "tags": [], + "label": "dataViewTitle", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx", + "deprecated": false + }, + { + "parentPluginId": "dataVisualizer", + "id": "def-public.GetAdditionalLinksParams.globalState", + "type": "Any", + "tags": [], + "label": "globalState", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "dataVisualizer", "id": "def-public.IndexDataVisualizerViewProps", @@ -62,20 +111,20 @@ }, { "parentPluginId": "dataVisualizer", - "id": "def-public.IndexDataVisualizerViewProps.additionalLinks", + "id": "def-public.IndexDataVisualizerViewProps.getAdditionalLinks", "type": "Array", "tags": [], - "label": "additionalLinks", + "label": "getAdditionalLinks", "description": [], "signature": [ { "pluginId": "dataVisualizer", "scope": "public", "docId": "kibDataVisualizerPluginApi", - "section": "def-public.ResultLink", - "text": "ResultLink" + "section": "def-public.GetAdditionalLinks", + "text": "GetAdditionalLinks" }, - "[] | undefined" + " | undefined" ], "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/components/index_data_visualizer_view/index_data_visualizer_view.tsx", "deprecated": false @@ -208,10 +257,10 @@ }, { "parentPluginId": "dataVisualizer", - "id": "def-public.ResultLink.dataTestSubj", + "id": "def-public.ResultLink.datatestsubj", "type": "string", "tags": [], - "label": "dataTestSubj", + "label": "'data-test-subj'", "description": [], "signature": [ "string | undefined" @@ -270,13 +319,21 @@ }, { "parentPluginId": "dataVisualizer", - "id": "def-public.IndexDataVisualizerSpec", + "id": "def-public.GetAdditionalLinks", "type": "Type", "tags": [], - "label": "IndexDataVisualizerSpec", + "label": "GetAdditionalLinks", "description": [], "signature": [ - "React.FunctionComponent<{ additionalLinks: ", + "((params: ", + { + "pluginId": "dataVisualizer", + "scope": "public", + "docId": "kibDataVisualizerPluginApi", + "section": "def-public.GetAdditionalLinksParams", + "text": "GetAdditionalLinksParams" + }, + ") => Promise<", { "pluginId": "dataVisualizer", "scope": "public", @@ -284,7 +341,29 @@ "section": "def-public.ResultLink", "text": "ResultLink" }, - "[]; }>" + "[] | undefined>)[]" + ], + "path": "x-pack/plugins/data_visualizer/public/application/common/components/results_links/results_links.tsx", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "dataVisualizer", + "id": "def-public.IndexDataVisualizerSpec", + "type": "Type", + "tags": [], + "label": "IndexDataVisualizerSpec", + "description": [], + "signature": [ + "React.FunctionComponent<{ getAdditionalLinks?: ", + { + "pluginId": "dataVisualizer", + "scope": "public", + "docId": "kibDataVisualizerPluginApi", + "section": "def-public.GetAdditionalLinks", + "text": "GetAdditionalLinks" + }, + " | undefined; }>" ], "path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/index_data_visualizer.tsx", "deprecated": false, @@ -329,15 +408,15 @@ "label": "DataVisualizerPluginStart", "description": [], "signature": [ - "{ getFileDataVisualizerComponent: () => Promise<() => React.FC>; getIndexDataVisualizerComponent: () => Promise<() => React.FC<{ additionalLinks: ", + "{ getFileDataVisualizerComponent: () => Promise<() => React.FC>; getIndexDataVisualizerComponent: () => Promise<() => React.FC<{ getAdditionalLinks?: ", { "pluginId": "dataVisualizer", "scope": "public", "docId": "kibDataVisualizerPluginApi", - "section": "def-public.ResultLink", - "text": "ResultLink" + "section": "def-public.GetAdditionalLinks", + "text": "GetAdditionalLinks" }, - "[]; }>>; getMaxBytesFormatted: () => string; }" + " | undefined; }>>; getMaxBytesFormatted: () => string; }" ], "path": "x-pack/plugins/data_visualizer/public/plugin.ts", "deprecated": false, diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index dba30154fefa5..75c8e68cedce5 100644 --- a/api_docs/data_visualizer.mdx +++ b/api_docs/data_visualizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataVisualizer title: "dataVisualizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the dataVisualizer plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 23 | 2 | 19 | 1 | +| 28 | 3 | 24 | 1 | ## Client diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx index a9ce0254cea52..8864885c93091 100644 --- a/api_docs/deprecations_by_api.mdx +++ b/api_docs/deprecations_by_api.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByApi slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api title: Deprecated API usage by API summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -14,14 +14,14 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Referencing plugin(s) | Remove By | | ---------------|-----------|-----------| | | dataViews, maps, data | - | -| | dataViews, unifiedSearch, maps, data | - | +| | dataViews, maps, data | - | | | dataViews, discover, ux, savedObjects, dataViewEditor, maps, visDefaultEditor, data | - | | | dataViews, dataViewEditor, maps, visDefaultEditor, data | - | | | dataViews, unifiedSearch | - | | | dataViews, canvas | - | | | dataViews, unifiedSearch, data | - | | | dataViews, canvas, data | - | -| | dataViews, unifiedSearch, maps, data | - | +| | dataViews, maps, data | - | | | dataViews, dataViewEditor, maps, visDefaultEditor, data | - | | | dataViews, maps, data | - | | | dataViews | - | @@ -38,16 +38,17 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | dataViewManagement, dataViews | - | | | visTypeTimeseries, graph, dataViewManagement, dataViews | - | | | dataViews, dataViewManagement | - | +| | discover, visualizations, dashboard, lens, maps, monitoring | - | | | unifiedSearch, discover, maps, infra, graph, securitySolution, stackAlerts, inputControlVis, savedObjects | - | | | maps | - | | | data, infra, maps | - | -| | discover | - | -| | discover | - | +| | alerting, discover, securitySolution | - | +| | alerting, discover, securitySolution | - | | | data, discover, embeddable | - | | | advancedSettings, discover | - | | | advancedSettings, discover | - | -| | management, observability, infra, apm, cloudSecurityPosture, enterpriseSearch, securitySolution, synthetics, ux, kibanaOverview | - | -| | esUiShared, home, spaces, fleet, visualizations, lens, observability, dataEnhanced, ml, apm, cloudSecurityPosture, indexLifecycleManagement, synthetics, upgradeAssistant, ux, kibanaOverview, savedObjectsManagement | - | +| | management, observability, infra, apm, cloudSecurityPosture, enterpriseSearch, synthetics, ux, kibanaOverview | - | +| | esUiShared, home, data, spaces, fleet, visualizations, lens, observability, ml, apm, cloudSecurityPosture, indexLifecycleManagement, synthetics, upgradeAssistant, ux, savedObjectsManagement, kibanaOverview | - | | | canvas, visTypeXy | - | | | canvas | - | | | canvas | - | @@ -58,11 +59,12 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | canvas | - | | | canvas | - | | | canvas, visTypeXy | - | -| | management, spaces, observability, ml, canvas, cloudSecurityPosture, enterpriseSearch, osquery, securitySolution, kibanaOverview | - | +| | management, spaces, observability, ml, canvas, cloudSecurityPosture, enterpriseSearch, osquery, kibanaOverview | - | +| | actions, alerting | - | +| | encryptedSavedObjects, actions, data, cloud, ml, logstash, securitySolution | - | | | dashboard, lens, stackAlerts, visTypeTable, visTypeTimeseries, visTypeXy, visTypeVislib, expressionPartitionVis | - | -| | visTypeTimeseries, graph, dataViewManagement | - | -| | encryptedSavedObjects, actions, cloud, ml, dataEnhanced, logstash, securitySolution | - | | | dashboard | - | +| | visTypeTimeseries, graph, dataViewManagement | - | | | visTypeTimeseries | - | | | dataViewManagement | - | | | dataViewManagement | - | @@ -72,44 +74,36 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | visTypeGauge | - | | | visTypePie | - | | | visTypePie | - | -| | actions, alerting | - | | | console | - | +| | discover, dashboard, lens, urlDrilldown | 8.1 | +| | discover, dashboard, lens, urlDrilldown | 8.1 | +| | discover, dashboard, lens, urlDrilldown | 8.1 | | | unifiedSearch | 8.1 | -| | unifiedSearch, dataEnhanced | 8.1 | -| | unifiedSearch, discover, dashboard, urlDrilldown, stackAlerts | 8.1 | -| | unifiedSearch | 8.1 | -| | unifiedSearch | 8.1 | -| | unifiedSearch, discover, dashboard, urlDrilldown, stackAlerts | 8.1 | -| | unifiedSearch, dataEnhanced | 8.1 | -| | unifiedSearch, discover, dashboard, urlDrilldown, stackAlerts | 8.1 | -| | unifiedSearch, dataEnhanced | 8.1 | -| | discover, stackAlerts, inputControlVis | 8.1 | -| | discover, stackAlerts, inputControlVis | 8.1 | -| | dataEnhanced | 8.1 | +| | stackAlerts, alerting, securitySolution, inputControlVis | 8.1 | +| | stackAlerts, alerting, securitySolution, inputControlVis | 8.1 | | | apm | 8.1 | | | dataViews, unifiedSearch | 8.2 | | | dataViews, unifiedSearch, data | 8.2 | | | visualizations, dashboard, lens, maps, ml, securitySolution, security | 8.8.0 | -| | lens, dashboard, maps | 8.8.0 | +| | dashboard, maps | 8.8.0 | | | embeddable, discover, presentationUtil, dashboard, graph | 8.8.0 | +| | spaces, security, alerting | 8.8.0 | | | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | 8.8.0 | | | apm, security, securitySolution | 8.8.0 | | | apm, security, securitySolution | 8.8.0 | | | securitySolution | 8.8.0 | | | savedObjectsTaggingOss, visualizations, dashboard, lens | 8.8.0 | | | dashboard | 8.8.0 | +| | monitoring | 8.8.0 | +| | monitoring, kibanaUsageCollection | 8.8.0 | | | cloud, apm | 8.8.0 | | | security, licenseManagement, ml, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | 8.8.0 | | | management, fleet, security, kibanaOverview | 8.8.0 | -| | spaces, security, alerting | 8.8.0 | | | security, fleet | 8.8.0 | | | security, fleet | 8.8.0 | | | security, fleet | 8.8.0 | | | security | 8.8.0 | | | mapsEms | 8.8.0 | -| | visTypeVega | 8.8.0 | -| | monitoring, visTypeVega | 8.8.0 | -| | monitoring, kibanaUsageCollection | 8.8.0 | | | ml | 8.8.0 Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, @@ -132,6 +126,7 @@ Safe to remove. | ---------------|------------| | | data | | | data | +| | data | | | data | | | data | | | data | @@ -168,12 +163,15 @@ Safe to remove. | | data | | | data | | | data | +| | data | | | data | +| | data | | | data | | | data | | | data | | | data | | | data | +| | data | | | data | | | data | | | data | @@ -181,11 +179,13 @@ Safe to remove. | | data | | | data | | | data | +| | data | | | data | | | data | | | data | | | data | | | data | +| | data | | | dataViews | | | dataViews | | | expressions | @@ -211,5 +211,6 @@ Safe to remove. | | reporting | | | taskManager | | | core | +| | core | | | core | | | core | \ No newline at end of file diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index 4904da587db13..f105045929426 100644 --- a/api_docs/deprecations_by_plugin.mdx +++ b/api_docs/deprecations_by_plugin.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByPlugin slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin title: Deprecated API usage by plugin summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by. -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -33,6 +33,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.ts#:~:text=create) | - | +| | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 | +| | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.ts#:~:text=create) | - | +| | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 | | | [plugin.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/plugin.test.ts#:~:text=getKibanaFeatures) | 8.8.0 | | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/plugin.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24) | 8.8.0 | | | [task.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/usage/task.ts#:~:text=index) | - | @@ -113,6 +117,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [sync_dashboard_filter_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts#:~:text=syncQueryStateWithUrl), [sync_dashboard_filter_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts#:~:text=syncQueryStateWithUrl), [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=syncQueryStateWithUrl), [dashboard_listing.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/listing/dashboard_listing.tsx#:~:text=syncQueryStateWithUrl) | - | | | [export_csv_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/export_csv_action.tsx#:~:text=fieldFormats) | - | | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | | | [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [filter_utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/filter_utils.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter), [dashboard_state_slice.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/state/dashboard_state_slice.ts#:~:text=Filter)+ 5 more | 8.1 | @@ -130,32 +135,21 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [mapping.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/mapping.ts#:~:text=IndexPatternField), [mapping.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/mapping.ts#:~:text=IndexPatternField), [mapping.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/mapping.ts#:~:text=IndexPatternField), [mapping.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/mapping.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField)+ 16 more | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternField), [agg_config.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/agg_config.test.ts#:~:text=IndexPatternField), [agg_config.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/agg_config.test.ts#:~:text=IndexPatternField)+ 16 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [create_search_source.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.test.ts#:~:text=IndexPatternsContract)+ 19 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternsService) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern)+ 89 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IFieldType), [date_histogram.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/buckets/date_histogram.ts#:~:text=IFieldType), [date_histogram.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/buckets/date_histogram.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IFieldType), [create_filters_from_range_select.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/actions/filters/create_filters_from_range_select.ts#:~:text=IFieldType), [create_filters_from_range_select.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/actions/filters/create_filters_from_range_select.ts#:~:text=IFieldType)+ 6 more | 8.2 | -| | [mapping.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/mapping.ts#:~:text=IndexPatternField), [mapping.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/mapping.ts#:~:text=IndexPatternField), [mapping.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/mapping.ts#:~:text=IndexPatternField), [mapping.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/param_types/mapping.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField)+ 16 more | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [normalize_sort_request.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/normalize_sort_request.ts#:~:text=IIndexPattern), [normalize_sort_request.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/normalize_sort_request.ts#:~:text=IIndexPattern), [normalize_sort_request.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/normalize_sort_request.ts#:~:text=IIndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IIndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IIndexPattern)+ 23 more | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern)+ 90 more | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IFieldType), [date_histogram.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/buckets/date_histogram.ts#:~:text=IFieldType), [date_histogram.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/buckets/date_histogram.ts#:~:text=IFieldType), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IFieldType), [create_filters_from_range_select.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/actions/filters/create_filters_from_range_select.ts#:~:text=IFieldType), [create_filters_from_range_select.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/actions/filters/create_filters_from_range_select.ts#:~:text=IFieldType)+ 6 more | 8.2 | +| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [kibana_context_type.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/kibana_context_type.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternField), [agg_config.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/agg_config.test.ts#:~:text=IndexPatternField), [agg_config.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/aggs/agg_config.test.ts#:~:text=IndexPatternField)+ 16 more | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [get_time.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/query/timefilter/get_time.ts#:~:text=IIndexPattern), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IIndexPattern), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IIndexPattern), [generate_filters.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/filter_manager/lib/generate_filters.ts#:~:text=IIndexPattern), [timefilter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/timefilter/timefilter.ts#:~:text=IIndexPattern), [timefilter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/query/timefilter/timefilter.ts#:~:text=IIndexPattern)+ 23 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternAttributes), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternAttributes), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternAttributes) | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [create_search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [search_source_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source_service.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [esaggs_fn.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/types.ts#:~:text=IndexPatternsContract), [create_search_source.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/create_search_source.test.ts#:~:text=IndexPatternsContract)+ 19 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/index.ts#:~:text=IndexPatternsService), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/index.ts#:~:text=IndexPatternsService) | - | -| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern)+ 89 more | - | +| | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/index.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/types.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [search_source.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/search_source/search_source.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern), [tabify_docs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/common/search/tabify/tabify_docs.ts#:~:text=IndexPattern)+ 90 more | - | | | [aggs_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/search/aggs/aggs_service.ts#:~:text=indexPatternsServiceFactory), [esaggs.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/search/expressions/esaggs.ts#:~:text=indexPatternsServiceFactory), [search_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/search/search_service.ts#:~:text=indexPatternsServiceFactory) | - | +| | [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks) | - | | | [data_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/utils/table_inspector_view/components/data_table.tsx#:~:text=executeTriggerActions), [data_table.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/data/public/utils/table_inspector_view/components/data_table.tsx#:~:text=executeTriggerActions) | - | - - - -## dataEnhanced - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode) | 8.1 | -| | [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=nodeBuilder), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder)+ 2 more | 8.1 | -| | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode) | 8.1 | -| | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode) | 8.1 | -| | [get_columns.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/public/search/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/public/search/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [get_columns.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/public/search/sessions_mgmt/lib/get_columns.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/public/search/ui/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/public/search/ui/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks), [connected_search_session_indicator.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/public/search/ui/connected_search_session_indicator/connected_search_session_indicator.tsx#:~:text=RedirectAppLinks) | - | -| | [session_service.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/session_service.ts#:~:text=authc) | - | +| | [session_service.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data/server/search/session/session_service.ts#:~:text=authc) | - | @@ -197,9 +191,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPattern), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPattern) | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternField), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField), [data_view_field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.test.ts#:~:text=IndexPatternField)+ 2 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern) | - | -| | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 7 more | 8.2 | +| | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IFieldType), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IFieldType)+ 7 more | 8.2 | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternAttributes) | - | -| | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 7 more | 8.2 | +| | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IFieldType), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IFieldType)+ 7 more | 8.2 | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IIndexPattern) | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternAttributes) | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/public/index.ts#:~:text=IndexPatternsContract) | - | @@ -228,13 +222,12 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | ---------------|-----------|-----------| | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern) | - | | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create) | - | -| | [anchor.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/anchor.ts#:~:text=fetch), [fetch_hits_in_interval.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts#:~:text=fetch) | 8.1 | +| | [discover_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/services/discover_state.ts#:~:text=syncQueryStateWithUrl), [discover_state.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/main/services/discover_state.ts#:~:text=syncQueryStateWithUrl) | - | | | [plugin.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/plugin.tsx#:~:text=indexPatterns) | - | | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern) | - | | | [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create), [saved_search_embeddable.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/embeddable/saved_search_embeddable.tsx#:~:text=create) | - | -| | [anchor.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/anchor.ts#:~:text=fetch), [fetch_hits_in_interval.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts#:~:text=fetch) | 8.1 | | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=IndexPattern) | - | | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | | | [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/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/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | @@ -372,11 +365,14 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/app.tsx#:~:text=syncQueryStateWithUrl), [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/app.tsx#:~:text=syncQueryStateWithUrl) | - | | | [ranges.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/ranges/ranges.tsx#:~:text=fieldFormats), [droppable.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/indexpattern_datasource/dimension_panel/droppable/droppable.test.ts#:~:text=fieldFormats) | - | +| | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | +| | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | +| | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | | | [workspace_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx#:~:text=RedirectAppLinks), [workspace_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx#:~:text=RedirectAppLinks), [workspace_panel.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/editor_frame_service/editor_frame/workspace_panel/workspace_panel.tsx#:~:text=RedirectAppLinks) | - | | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave) | 8.8.0 | -| | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts#:~:text=warning), [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | @@ -415,6 +411,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract) | - | | | [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [get_docvalue_source_fields.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/util/get_docvalue_source_fields.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [es_tooltip_property.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/tooltips/es_tooltip_property.test.ts#:~:text=IndexPattern), [percentile_agg_field.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/agg/percentile_agg_field.test.ts#:~:text=IndexPattern)+ 4 more | - | | | [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField)+ 84 more | - | +| | [global_sync.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts#:~:text=syncQueryStateWithUrl), [global_sync.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/routes/map_page/url_state/global_sync.ts#:~:text=syncQueryStateWithUrl) | - | | | [kibana_services.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/kibana_services.ts#:~:text=indexPatterns) | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/lazy_load_bundle/index.ts#:~:text=IndexPatternsContract) | - | | | [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField), [single_field_select.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/components/single_field_select.tsx#:~:text=IndexPatternField)+ 84 more | - | @@ -463,6 +460,7 @@ so TS and code-reference navigation might not highlight them. | | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=syncQueryStateWithUrl), [url_state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/url_state.ts#:~:text=syncQueryStateWithUrl) | - | | | [legacy_shims.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/public/legacy_shims.ts#:~:text=injectedMetadata) | 8.8.0 | | | [bulk_uploader.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/monitoring/server/kibana_monitoring/bulk_uploader.ts#:~:text=process) | 8.8.0 | @@ -569,13 +567,13 @@ so TS and code-reference navigation might not highlight them. | | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | +| | [role_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | | | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | 8.8.0 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 | -| | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | -| | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | +| | [role_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | +| | [role_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | | | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | 8.8.0 This is relied on by the reporting feature, and should be removed once reporting @@ -595,9 +593,11 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.ts#:~:text=create) | - | +| | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 | | | [middleware.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=indexPatterns), [dependencies_start_mock.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/mock/endpoint/dependencies_start_mock.ts#:~:text=indexPatterns) | - | -| | [use_primary_navigation.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/navigation/use_security_solution_navigation/use_primary_navigation.tsx#:~:text=KibanaPageTemplateProps), [use_primary_navigation.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/components/navigation/use_security_solution_navigation/use_primary_navigation.tsx#:~:text=KibanaPageTemplateProps), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=KibanaPageTemplateProps), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx#:~:text=KibanaPageTemplateProps) | - | -| | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=KibanaPageTemplate), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx#:~:text=KibanaPageTemplate) | - | +| | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.ts#:~:text=create) | - | +| | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 | | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/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/master/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/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 more | 8.8.0 | | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/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/master/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/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 more | 8.8.0 | | | [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [create_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts#:~:text=authc), [delete_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts#:~:text=authc), [finalize_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts#:~:text=authc), [open_close_signals_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts#:~:text=authc), [preview_rules_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/preview_rules_route.ts#:~:text=authc), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts#:~:text=authc) | - | @@ -634,10 +634,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch) | 8.1 | | | [entity_index_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx#:~:text=indexPatterns), [boundary_index_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns) | - | | | [expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/threshold/expression.tsx#:~:text=fieldFormats) | - | -| | [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter) | 8.1 | -| | [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter) | 8.1 | | | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch) | 8.1 | -| | [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter) | 8.1 | @@ -645,8 +642,8 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [use_no_data_config.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/apps/use_no_data_config.ts#:~:text=KibanaPageTemplateProps), [use_no_data_config.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/apps/use_no_data_config.ts#:~:text=KibanaPageTemplateProps) | - | -| | [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/apps/uptime_app.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/apps/uptime_app.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/apps/uptime_app.tsx#:~:text=RedirectAppLinks) | - | +| | [use_no_data_config.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/legacy_uptime/app/use_no_data_config.ts#:~:text=KibanaPageTemplateProps), [use_no_data_config.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/legacy_uptime/app/use_no_data_config.ts#:~:text=KibanaPageTemplateProps) | - | +| | [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [alert_messages.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/alert_messages.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_app.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_app.tsx#:~:text=RedirectAppLinks), [uptime_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_app.tsx#:~:text=RedirectAppLinks), [synthetics_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=RedirectAppLinks), [synthetics_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=RedirectAppLinks), [synthetics_app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx#:~:text=RedirectAppLinks) | - | @@ -662,22 +659,12 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract) | - | -| | [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern) | - | -| | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType)+ 25 more | 8.2 | +| | [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern) | - | +| | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType) | 8.2 | | | [query_string_input.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/query_string_input/query_string_input.tsx#:~:text=indexPatterns) | - | | | [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters) | 8.1 | -| | [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [value.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts#:~:text=KueryNode)+ 2 more | 8.1 | -| | [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=Filter)+ 10 more | 8.1 | -| | [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS) | 8.1 | -| | [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated) | 8.1 | -| | [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=Filter)+ 10 more | 8.1 | -| | [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [value.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts#:~:text=KueryNode)+ 2 more | 8.1 | -| | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType)+ 60 more | 8.2 | -| | [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern)+ 4 more | - | -| | [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract), [create_index_pattern_select.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/index_pattern_select/create_index_pattern_select.tsx#:~:text=IndexPatternsContract) | - | -| | [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=Filter)+ 10 more | 8.1 | -| | [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [value.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts#:~:text=KueryNode)+ 2 more | 8.1 | +| | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType)+ 8 more | 8.2 | +| | [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IIndexPattern), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IIndexPattern)+ 4 more | - | @@ -762,15 +749,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ -## visTypeVega - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/plugin.ts#:~:text=injectedMetadata) | 8.8.0 | -| | [search_api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/search_api.ts#:~:text=injectedMetadata), [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/plugin.ts#:~:text=injectedMetadata) | 8.8.0 | - - - ## visTypeVislib | Deprecated API | Reference location(s) | Remove By | @@ -795,6 +773,7 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| +| | [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=syncQueryStateWithUrl), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=syncQueryStateWithUrl) | - | | | [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks), [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks), [get_table_columns.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/utils/get_table_columns.tsx#:~:text=RedirectAppLinks) | - | | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | | | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave) | 8.8.0 | diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index aab61180e9dc8..8c94102fdb2b6 100644 --- a/api_docs/deprecations_by_team.mdx +++ b/api_docs/deprecations_by_team.mdx @@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsDueByTeam slug: /kibana-dev-docs/api-meta/deprecations-due-by-team title: Deprecated APIs due to be removed, by team summary: Lists the teams that are referencing deprecated APIs with a remove by date. -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -25,12 +25,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| dataViews | | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 7 more | 8.2 | -| dataViews | | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType), [types.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/types.ts#:~:text=IFieldType)+ 23 more | 8.2 | -| dataEnhanced | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode) | 8.1 | -| dataEnhanced | | [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=nodeBuilder), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=nodeBuilder), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=nodeBuilder)+ 2 more | 8.1 | -| dataEnhanced | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode) | 8.1 | -| dataEnhanced | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/types.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [get_search_session_page.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/get_search_session_page.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [check_non_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/check_non_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode), [expire_persisted_sessions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/data_enhanced/server/search/session/expire_persisted_sessions.ts#:~:text=KueryNode) | 8.1 | +| dataViews | | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IFieldType), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IFieldType)+ 7 more | 8.2 | +| dataViews | | [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [utils.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/utils.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [data_view_field.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/data_view_field.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [field_list.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/fields/field_list.ts#:~:text=IFieldType), [index.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/index.ts#:~:text=IFieldType), [data_view.ts](https://github.com/elastic/kibana/tree/master/src/plugins/data_views/common/data_views/data_view.ts#:~:text=IFieldType)+ 23 more | 8.2 | | urlDrilldown | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | | urlDrilldown | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | | urlDrilldown | | [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [context_variables.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/variables/context_variables.ts#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [url_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/url_drilldown.tsx#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter), [data.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/drilldowns/url_drilldown/public/lib/test/data.ts#:~:text=Filter) | 8.1 | @@ -42,10 +38,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| discover | | [anchor.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/anchor.ts#:~:text=fetch), [fetch_hits_in_interval.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts#:~:text=fetch) | 8.1 | | discover | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | | discover | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | -| discover | | [anchor.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/services/anchor.ts#:~:text=fetch), [fetch_hits_in_interval.ts](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/context/utils/fetch_hits_in_interval.ts#:~:text=fetch) | 8.1 | | discover | | [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter), [view_alert_route.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/discover/public/application/view_alert/view_alert_route.tsx#:~:text=Filter) | 8.1 | | discover | | [on_save_search.tsx](https://github.com/elastic/kibana/tree/master/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/master/src/plugins/discover/public/application/main/components/top_nav/on_save_search.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/public/components/save_modal.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 | | graph | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/graph/server/plugin.ts#:~:text=license%24) | 8.8.0 | @@ -137,13 +131,13 @@ so TS and code-reference navigation might not highlight them. | | --------|-------|-----------|-----------| | spaces | | [on_post_auth_interceptor.ts](https://github.com/elastic/kibana/tree/master/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/master/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/master/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/master/x-pack/plugins/security/server/authorization/app_authorization.ts#:~:text=getKibanaFeatures), [privileges.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.ts#:~:text=getKibanaFeatures), [authorization_service.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getKibanaFeatures), [app_authorization.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/app_authorization.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures)+ 17 more | 8.8.0 | | spaces | | [spaces_usage_collector.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/plugin.ts#:~:text=license%24), [spaces_usage_collector.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/spaces/server/usage_collection/spaces_usage_collector.test.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/plugin.ts#:~:text=license%24) | 8.8.0 | -| security | | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | +| security | | [role_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | | security | | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | 8.8.0 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 | -| security | | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | -| security | | [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [put_payload.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | +| security | | [role_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | +| security | | [role_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [role_utils.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/lib/role_utils.ts#:~:text=disabled), [elasticsearch_role.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts#:~:text=disabled), [primary_feature_privilege.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/model/primary_feature_privilege.ts#:~:text=disabled), [elasticsearch_role.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/roles/elasticsearch_role.test.ts#:~:text=disabled), [kibana_features.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/public/management/roles/__fixtures__/kibana_features.ts#:~:text=disabled), [put.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/put.test.ts#:~:text=disabled), [put_payload.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.test.ts#:~:text=disabled) | 8.8.0 | | security | | [disable_ui_capabilities.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security/server/authorization/disable_ui_capabilities.ts#:~:text=requiredRoles) | 8.8.0 This is relied on by the reporting feature, and should be removed once reporting @@ -161,11 +155,8 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| stackAlerts | | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch) | 8.1 | -| stackAlerts | | [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter) | 8.1 | -| stackAlerts | | [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter) | 8.1 | -| stackAlerts | | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch) | 8.1 | -| stackAlerts | | [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [read_only_filter_items.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/read_only_filter_items.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter), [search_source_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/es_query/expression/search_source_expression.tsx#:~:text=Filter) | 8.1 | +| alerting | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch) | 8.1 | +| alerting | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch), [alert_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/alert_type.test.ts#:~:text=fetch) | 8.1 | | alerting | | [plugin.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/plugin.test.ts#:~:text=getKibanaFeatures) | 8.8.0 | | alerting | | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/plugin.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/lib/license_state.test.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/lib/license_state.test.ts#:~:text=license%24) | 8.8.0 | @@ -175,6 +166,8 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| +| securitySolution | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 | +| securitySolution | | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 | | securitySolution | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/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/master/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/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 more | 8.8.0 | | securitySolution | | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/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/master/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/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode), [isolation.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/isolation.test.ts#:~:text=mode)+ 2 more | 8.8.0 | | securitySolution | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/index.tsx#:~:text=onAppLeave) | 8.8.0 | @@ -204,17 +197,9 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| unifiedSearch | | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType)+ 25 more | 8.2 | +| unifiedSearch | | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType) | 8.2 | | unifiedSearch | | [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=esFilters) | 8.1 | -| unifiedSearch | | [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [value.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts#:~:text=KueryNode)+ 2 more | 8.1 | -| unifiedSearch | | [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=Filter)+ 10 more | 8.1 | -| unifiedSearch | | [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=FILTERS) | 8.1 | -| unifiedSearch | | [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated), [filter_editor_utils.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_editor_utils.test.ts#:~:text=toggleFilterNegated) | 8.1 | -| unifiedSearch | | [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=Filter)+ 10 more | 8.1 | -| unifiedSearch | | [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [value.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts#:~:text=KueryNode)+ 2 more | 8.1 | -| unifiedSearch | | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [query_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/query_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType)+ 60 more | 8.2 | -| unifiedSearch | | [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [use_filter_manager.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/search_bar/lib/use_filter_manager.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [apply_filter_action.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/actions/apply_filter_action.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [get_stub_filter.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/test_helpers/get_stub_filter.ts#:~:text=Filter), [filter_label.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/filter_bar/filter_editor/lib/filter_label.tsx#:~:text=Filter)+ 10 more | 8.1 | -| unifiedSearch | | [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [conjunction.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/conjunction.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [field.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [operator.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/operator.test.ts#:~:text=KueryNode), [value.test.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.test.ts#:~:text=KueryNode)+ 2 more | 8.1 | +| unifiedSearch | | [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value_suggestion_provider.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/value_suggestion_provider.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [value.ts](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/value.ts#:~:text=IFieldType), [field.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/unified_search/public/autocomplete/providers/kql_query_suggestion/field.tsx#:~:text=IFieldType)+ 8 more | 8.2 | @@ -222,9 +207,9 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Plugin | Deprecated API | Reference location(s) | Remove By | | --------|-------|-----------|-----------| -| lens | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | -| lens | | [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave), [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave) | 8.8.0 | -| lens | | [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts#:~:text=warning), [saved_object_migrations.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/server/migrations/saved_object_migrations.ts#:~:text=warning) | 8.8.0 | -| management | | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 | -| visTypeVega | | [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/plugin.ts#:~:text=injectedMetadata) | 8.8.0 | -| visTypeVega | | [search_api.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/data_model/search_api.ts#:~:text=injectedMetadata), [plugin.ts](https://github.com/elastic/kibana/tree/master/src/plugins/vis_types/vega/public/plugin.ts#:~:text=injectedMetadata) | 8.8.0 | \ No newline at end of file +| visualizations | | [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/utils/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [display_duplicate_title_confirm_modal.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/display_duplicate_title_confirm_modal.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject), [check_for_duplicate_title.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/persistence/saved_objects_utils/check_for_duplicate_title.ts#:~:text=SavedObject) | 8.8.0 | +| visualizations | | [visualize_top_nav.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_top_nav.tsx#:~:text=onAppLeave), [visualize_editor_common.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx#:~:text=onAppLeave), [app.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/app.tsx#:~:text=onAppLeave), [index.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/visualizations/public/visualize_app/index.tsx#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [types.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/types.ts#:~:text=onAppLeave), [mounter.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/app_plugin/mounter.tsx#:~:text=onAppLeave) | 8.8.0 | +| lens | | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | +| lens | | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | +| lens | | [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter), [open_in_discover_drilldown.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/lens/public/trigger_actions/open_in_discover_drilldown.tsx#:~:text=Filter) | 8.1 | +| management | | [application.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/management/public/application.tsx#:~:text=appBasePath) | 8.8.0 | \ No newline at end of file diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index 21a175173b3f6..aca0ece095362 100644 --- a/api_docs/dev_tools.mdx +++ b/api_docs/dev_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/devTools title: "devTools" image: https://source.unsplash.com/400x175/?github summary: API docs for the devTools plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/discover.devdocs.json b/api_docs/discover.devdocs.json index e4d6e9e749105..2680b1282dac2 100644 --- a/api_docs/discover.devdocs.json +++ b/api_docs/discover.devdocs.json @@ -66,7 +66,7 @@ "signature": [ "(id?: string | undefined) => string" ], - "path": "src/plugins/discover/public/services/saved_searches/saved_searches_utils.ts", + "path": "src/plugins/discover/common/services/saved_searches/saved_searches_url.ts", "deprecated": false, "children": [ { @@ -79,7 +79,7 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/discover/public/services/saved_searches/saved_searches_utils.ts", + "path": "src/plugins/discover/common/services/saved_searches/saved_searches_url.ts", "deprecated": false, "isRequired": false } @@ -97,7 +97,7 @@ "signature": [ "(id?: string | undefined) => string" ], - "path": "src/plugins/discover/public/services/saved_searches/saved_searches_utils.ts", + "path": "src/plugins/discover/common/services/saved_searches/saved_searches_url.ts", "deprecated": false, "children": [ { @@ -110,7 +110,7 @@ "signature": [ "string | undefined" ], - "path": "src/plugins/discover/public/services/saved_searches/saved_searches_utils.ts", + "path": "src/plugins/discover/common/services/saved_searches/saved_searches_url.ts", "deprecated": false, "isRequired": false } @@ -1222,6 +1222,20 @@ "interfaces": [], "enums": [], "misc": [ + { + "parentPluginId": "discover", + "id": "def-common.APP_ICON", + "type": "string", + "tags": [], + "label": "APP_ICON", + "description": [], + "signature": [ + "\"discoverApp\"" + ], + "path": "src/plugins/discover/common/index.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "discover", "id": "def-common.CONTEXT_DEFAULT_SIZE_SETTING", @@ -1348,6 +1362,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "discover", + "id": "def-common.PLUGIN_ID", + "type": "string", + "tags": [], + "label": "PLUGIN_ID", + "description": [], + "signature": [ + "\"discover\"" + ], + "path": "src/plugins/discover/common/index.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "discover", "id": "def-common.ROW_HEIGHT_OPTION", diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index 960d60c26777d..07f47f01f9cb0 100644 --- a/api_docs/discover.mdx +++ b/api_docs/discover.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discover title: "discover" image: https://source.unsplash.com/400x175/?github summary: API docs for the discover plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-disco | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 76 | 0 | 60 | 7 | +| 78 | 0 | 62 | 7 | ## Client diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx index e8c18b01c1cfc..b836a8f1a4ca8 100644 --- a/api_docs/discover_enhanced.mdx +++ b/api_docs/discover_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced title: "discoverEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the discoverEnhanced plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/elastic_apm_synthtrace.devdocs.json b/api_docs/elastic_apm_synthtrace.devdocs.json index aa59d75c2508a..9cae9120751e9 100644 --- a/api_docs/elastic_apm_synthtrace.devdocs.json +++ b/api_docs/elastic_apm_synthtrace.devdocs.json @@ -102,11 +102,26 @@ "label": "clean", "description": [], "signature": [ - "() => Promise" + "(dataStreams?: string[] | undefined) => Promise" ], "path": "packages/elastic-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "@elastic/apm-synthtrace", + "id": "def-server.ApmSynthtraceEsClient.clean.$1", + "type": "Array", + "tags": [], + "label": "dataStreams", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "packages/elastic-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client.ts", + "deprecated": false, + "isRequired": false + } + ], "returnComment": [] }, { @@ -312,6 +327,55 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "@elastic/apm-synthtrace", + "id": "def-server.ApmSynthtraceEsClient.createDataStream", + "type": "Function", + "tags": [], + "label": "createDataStream", + "description": [], + "signature": [ + "(aggregator: ", + "StreamAggregator", + "<", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmFields", + "text": "ApmFields" + }, + ">) => Promise" + ], + "path": "packages/elastic-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@elastic/apm-synthtrace", + "id": "def-server.ApmSynthtraceEsClient.createDataStream.$1", + "type": "Object", + "tags": [], + "label": "aggregator", + "description": [], + "signature": [ + "StreamAggregator", + "<", + { + "pluginId": "@elastic/apm-synthtrace", + "scope": "server", + "docId": "kibElasticApmSynthtracePluginApi", + "section": "def-server.ApmFields", + "text": "ApmFields" + }, + ">" + ], + "path": "packages/elastic-apm-synthtrace/src/lib/apm/client/apm_synthtrace_es_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -616,6 +680,23 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@elastic/apm-synthtrace", + "id": "def-server.observer", + "type": "Function", + "tags": [], + "label": "observer", + "description": [], + "signature": [ + "() => ", + "Observer" + ], + "path": "packages/elastic-apm-synthtrace/src/lib/agent_config/observer.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@elastic/apm-synthtrace", "id": "def-server.timerange", @@ -876,7 +957,7 @@ }, "[]; 'error.grouping_name': string; 'error.grouping_key': string; 'host.name': string; 'kubernetes.pod.uid': string; 'metricset.name': string; observer: ", "Observer", - "; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.version': string; 'service.environment': string; 'service.node.name': string; 'service.runtime.name': string; 'service.runtime.version': string; 'service.framework.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; 'span.self_time.count': number; 'span.self_time.sum.us': number; 'cloud.provider': string; 'cloud.project.name': string; 'cloud.service.name': string; 'cloud.availability_zone': string; 'cloud.machine.type': string; 'cloud.region': string; 'host.os.platform': string; 'faas.id': string; 'faas.coldstart': boolean; 'faas.execution': string; 'faas.trigger.type': string; 'faas.trigger.request_id': string; }> & Partial<{ 'system.process.memory.size': number; 'system.memory.actual.free': number; 'system.memory.total': number; 'system.cpu.total.norm.pct': number; 'system.process.memory.rss.bytes': number; 'system.process.cpu.total.norm.pct': number; 'jvm.memory.heap.used': number; 'jvm.memory.non_heap.used': number; 'jvm.thread.count': number; }>" + "; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.version': string; 'service.environment': string; 'service.node.name': string; 'service.runtime.name': string; 'service.runtime.version': string; 'service.framework.name': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; 'span.self_time.count': number; 'span.self_time.sum.us': number; 'span.links': { trace: { id: string; }; span: { id: string; }; }[]; 'cloud.provider': string; 'cloud.project.name': string; 'cloud.service.name': string; 'cloud.availability_zone': string; 'cloud.machine.type': string; 'cloud.region': string; 'host.os.platform': string; 'faas.id': string; 'faas.coldstart': boolean; 'faas.execution': string; 'faas.trigger.type': string; 'faas.trigger.request_id': string; }> & Partial<{ 'system.process.memory.size': number; 'system.memory.actual.free': number; 'system.memory.total': number; 'system.cpu.total.norm.pct': number; 'system.process.memory.rss.bytes': number; 'system.process.cpu.total.norm.pct': number; 'jvm.memory.heap.used': number; 'jvm.memory.non_heap.used': number; 'jvm.thread.count': number; }>" ], "path": "packages/elastic-apm-synthtrace/src/lib/apm/apm_fields.ts", "deprecated": false, @@ -1017,7 +1098,7 @@ }, "[] | undefined; 'error.grouping_name'?: string | undefined; 'error.grouping_key'?: string | undefined; 'host.name'?: string | undefined; 'kubernetes.pod.uid'?: string | undefined; observer?: ", "Observer", - " | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.destination.service.response_time.sum.us'?: number | undefined; 'span.destination.service.response_time.count'?: number | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; }[]" + " | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.destination.service.response_time.sum.us'?: number | undefined; 'span.destination.service.response_time.count'?: number | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; }[]" ], "path": "packages/elastic-apm-synthtrace/src/lib/apm/index.ts", "deprecated": false, @@ -1071,7 +1152,7 @@ }, "[] | undefined; 'error.grouping_name'?: string | undefined; 'error.grouping_key'?: string | undefined; 'host.name'?: string | undefined; 'kubernetes.pod.uid'?: string | undefined; observer?: ", "Observer", - " | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.duration.histogram'?: { values: number[]; counts: number[]; } | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; }[]" + " | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.duration.histogram'?: { values: number[]; counts: number[]; } | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; }[]" ], "path": "packages/elastic-apm-synthtrace/src/lib/apm/index.ts", "deprecated": false, diff --git a/api_docs/elastic_apm_synthtrace.mdx b/api_docs/elastic_apm_synthtrace.mdx index 727d8b367a3a2..8393de70a5e6a 100644 --- a/api_docs/elastic_apm_synthtrace.mdx +++ b/api_docs/elastic_apm_synthtrace.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/elastic-apm-synthtrace title: "@elastic/apm-synthtrace" image: https://source.unsplash.com/400x175/?github summary: API docs for the @elastic/apm-synthtrace plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/apm-synthtrace'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 70 | 0 | 70 | 10 | +| 74 | 0 | 74 | 11 | ## Server diff --git a/api_docs/embeddable.devdocs.json b/api_docs/embeddable.devdocs.json index d8d5fd3006360..a5976ceb8f469 100644 --- a/api_docs/embeddable.devdocs.json +++ b/api_docs/embeddable.devdocs.json @@ -1276,6 +1276,112 @@ ], "returnComment": [] }, + { + "parentPluginId": "embeddable", + "id": "def-public.Container.replaceEmbeddable", + "type": "Function", + "tags": [], + "label": "replaceEmbeddable", + "description": [], + "signature": [ + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IEmbeddable", + "text": "IEmbeddable" + }, + ">(id: string, newExplicitInput: Partial, newType?: string | undefined) => Promise" + ], + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.Container.replaceEmbeddable.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Container.replaceEmbeddable.$2", + "type": "Object", + "tags": [], + "label": "newExplicitInput", + "description": [], + "signature": [ + "Partial" + ], + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "embeddable", + "id": "def-public.Container.replaceEmbeddable.$3", + "type": "string", + "tags": [], + "label": "newType", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/embeddable/public/lib/containers/container.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, { "parentPluginId": "embeddable", "id": "def-public.Container.removeEmbeddable", @@ -6761,12 +6867,18 @@ { "parentPluginId": "embeddable", "id": "def-public.EmbeddableOutput.error", - "type": "Object", + "type": "CompoundType", "tags": [], "label": "error", "description": [], "signature": [ - "EmbeddableError", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.ErrorLike", + "text": "ErrorLike" + }, " | undefined" ], "path": "src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts", @@ -7656,6 +7768,112 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "embeddable", + "id": "def-public.IContainer.replaceEmbeddable", + "type": "Function", + "tags": [], + "label": "replaceEmbeddable", + "description": [], + "signature": [ + " = ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Embeddable", + "text": "Embeddable" + }, + ">(id: string, newExplicitInput: Partial, newType?: string | undefined) => void" + ], + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-public.IContainer.replaceEmbeddable.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "embeddable", + "id": "def-public.IContainer.replaceEmbeddable.$2", + "type": "Object", + "tags": [], + "label": "newExplicitInput", + "description": [], + "signature": [ + "Partial" + ], + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "embeddable", + "id": "def-public.IContainer.replaceEmbeddable.$3", + "type": "string", + "tags": [], + "label": "newType", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/embeddable/public/lib/containers/i_container.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -8781,7 +8999,7 @@ }, " | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ", "SerializableRecord", - " | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; executionContext?: ", + " | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; syncTooltips?: boolean | undefined; executionContext?: ", "KibanaExecutionContext", " | undefined; }" ], @@ -9689,9 +9907,9 @@ "signature": [ { "pluginId": "embeddable", - "scope": "server", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-server.EmbeddableRegistryDefinition", + "section": "def-common.EmbeddableRegistryDefinition", "text": "EmbeddableRegistryDefinition" }, "

extends Partial<", @@ -9704,7 +9922,7 @@ }, "

>" ], - "path": "src/plugins/embeddable/server/types.ts", + "path": "src/plugins/embeddable/common/types.ts", "deprecated": false, "children": [ { @@ -9714,7 +9932,7 @@ "tags": [], "label": "id", "description": [], - "path": "src/plugins/embeddable/server/types.ts", + "path": "src/plugins/embeddable/common/types.ts", "deprecated": false } ], @@ -9812,9 +10030,9 @@ "(factory: ", { "pluginId": "embeddable", - "scope": "server", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-server.EmbeddableRegistryDefinition", + "section": "def-common.EmbeddableRegistryDefinition", "text": "EmbeddableRegistryDefinition" }, "<", @@ -9840,9 +10058,9 @@ "signature": [ { "pluginId": "embeddable", - "scope": "server", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-server.EmbeddableRegistryDefinition", + "section": "def-common.EmbeddableRegistryDefinition", "text": "EmbeddableRegistryDefinition" }, "<", @@ -10127,6 +10345,47 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "embeddable", + "id": "def-common.EmbeddableRegistryDefinition", + "type": "Interface", + "tags": [], + "label": "EmbeddableRegistryDefinition", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "common", + "docId": "kibEmbeddablePluginApi", + "section": "def-common.EmbeddableRegistryDefinition", + "text": "EmbeddableRegistryDefinition" + }, + "

extends Partial<", + { + "pluginId": "kibanaUtils", + "scope": "common", + "docId": "kibKibanaUtilsPluginApi", + "section": "def-common.PersistableState", + "text": "PersistableState" + }, + "

>" + ], + "path": "src/plugins/embeddable/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "embeddable", + "id": "def-common.EmbeddableRegistryDefinition.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "src/plugins/embeddable/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "embeddable", "id": "def-common.PanelState", @@ -10246,7 +10505,7 @@ }, " | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ", "SerializableRecord", - " | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; executionContext?: ", + " | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; syncTooltips?: boolean | undefined; executionContext?: ", "KibanaExecutionContext", " | undefined; }" ], diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index db04d8b3950c9..a13e8eb4c357a 100644 --- a/api_docs/embeddable.mdx +++ b/api_docs/embeddable.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddable title: "embeddable" image: https://source.unsplash.com/400x175/?github summary: API docs for the embeddable plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 476 | 0 | 386 | 4 | +| 486 | 0 | 396 | 3 | ## Client diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx index 03f58e6dd5a00..05fff13665fcb 100644 --- a/api_docs/embeddable_enhanced.mdx +++ b/api_docs/embeddable_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced title: "embeddableEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the embeddableEnhanced plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/encrypted_saved_objects.devdocs.json b/api_docs/encrypted_saved_objects.devdocs.json index 4e765abe70a0f..9423813bd2bd9 100644 --- a/api_docs/encrypted_saved_objects.devdocs.json +++ b/api_docs/encrypted_saved_objects.devdocs.json @@ -467,6 +467,93 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "encryptedSavedObjects", + "id": "def-server.EncryptedSavedObjectsClient.createPointInTimeFinderDecryptedAsInternalUser", + "type": "Function", + "tags": [], + "label": "createPointInTimeFinderDecryptedAsInternalUser", + "description": [ + "\nAPI method, that can be used to help page through large sets of saved objects and returns decrypted properties in result SO.\nIts interface matches interface of the corresponding Saved Objects API `createPointInTimeFinder` method:\n" + ], + "signature": [ + "(findOptions: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "text": "SavedObjectsCreatePointInTimeFinderOptions" + }, + ", dependencies?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectsPointInTimeFinder", + "text": "ISavedObjectsPointInTimeFinder" + }, + ">" + ], + "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "encryptedSavedObjects", + "id": "def-server.EncryptedSavedObjectsClient.createPointInTimeFinderDecryptedAsInternalUser.$1", + "type": "Object", + "tags": [], + "label": "findOptions", + "description": [ + "matches interface of corresponding argument of Saved Objects API `createPointInTimeFinder` {@link SavedObjectsCreatePointInTimeFinderOptions }" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "text": "SavedObjectsCreatePointInTimeFinderOptions" + } + ], + "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "encryptedSavedObjects", + "id": "def-server.EncryptedSavedObjectsClient.createPointInTimeFinderDecryptedAsInternalUser.$2", + "type": "Object", + "tags": [], + "label": "dependencies", + "description": [ + "matches interface of corresponding argument of Saved Objects API `createPointInTimeFinder` {@link SavedObjectsCreatePointInTimeFinderDependencies }" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" + }, + " | undefined" + ], + "path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/encrypted_saved_objects.mdx b/api_docs/encrypted_saved_objects.mdx index adf446ddde1bd..4756a8ea73fa5 100644 --- a/api_docs/encrypted_saved_objects.mdx +++ b/api_docs/encrypted_saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects title: "encryptedSavedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the encryptedSavedObjects plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Platform Security](https://github.com/orgs/elastic/teams/kibana-securit | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 48 | 0 | 44 | 0 | +| 51 | 0 | 44 | 0 | ## Server diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx index 4e4c43e2977c1..9e648e6ca85cc 100644 --- a/api_docs/enterprise_search.mdx +++ b/api_docs/enterprise_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch title: "enterpriseSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the enterpriseSearch plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/es_ui_shared.devdocs.json b/api_docs/es_ui_shared.devdocs.json index 16fd42fccb948..b173688f2c996 100644 --- a/api_docs/es_ui_shared.devdocs.json +++ b/api_docs/es_ui_shared.devdocs.json @@ -1042,6 +1042,39 @@ ], "path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx", "deprecated": false + }, + { + "parentPluginId": "esUiShared", + "id": "def-public.EuiCodeEditorProps.onAceEditorRef", + "type": "Function", + "tags": [], + "label": "onAceEditorRef", + "description": [], + "signature": [ + "((editor: ", + "default", + " | null) => void) | undefined" + ], + "path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "esUiShared", + "id": "def-public.EuiCodeEditorProps.onAceEditorRef.$1", + "type": "CompoundType", + "tags": [], + "label": "editor", + "description": [], + "signature": [ + "default", + " | null" + ], + "path": "src/plugins/es_ui_shared/public/components/code_editor/code_editor.tsx", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] } ], "initialIsOpen": false diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx index 937c0be2c8ba3..c85fb60616b15 100644 --- a/api_docs/es_ui_shared.mdx +++ b/api_docs/es_ui_shared.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/esUiShared title: "esUiShared" image: https://source.unsplash.com/400x175/?github summary: API docs for the esUiShared plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-ma | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 112 | 3 | 108 | 3 | +| 114 | 3 | 110 | 3 | ## Client diff --git a/api_docs/event_annotation.devdocs.json b/api_docs/event_annotation.devdocs.json index 681635d96de86..25eadc7becdbb 100644 --- a/api_docs/event_annotation.devdocs.json +++ b/api_docs/event_annotation.devdocs.json @@ -2,7 +2,61 @@ "id": "eventAnnotation", "client": { "classes": [], - "functions": [], + "functions": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-public.isRangeAnnotation", + "type": "Function", + "tags": [], + "label": "isRangeAnnotation", + "description": [], + "signature": [ + "(annotation?: ", + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined) => annotation is ", + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.RangeEventAnnotationConfig", + "text": "RangeEventAnnotationConfig" + } + ], + "path": "src/plugins/event_annotation/public/event_annotation_service/helpers.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-public.isRangeAnnotation.$1", + "type": "CompoundType", + "tags": [], + "label": "annotation", + "description": [], + "signature": [ + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" + }, + " | undefined" + ], + "path": "src/plugins/event_annotation/public/event_annotation_service/helpers.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], "interfaces": [ { "parentPluginId": "eventAnnotation", @@ -27,8 +81,8 @@ "pluginId": "eventAnnotation", "scope": "common", "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationArgs", - "text": "EventAnnotationArgs" + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" }, ") => ", { @@ -54,8 +108,8 @@ "pluginId": "eventAnnotation", "scope": "common", "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationArgs", - "text": "EventAnnotationArgs" + "section": "def-common.EventAnnotationConfig", + "text": "EventAnnotationConfig" } ], "path": "src/plugins/event_annotation/public/event_annotation_service/types.ts", @@ -81,6 +135,20 @@ "path": "src/plugins/event_annotation/public/event_annotation_service/helpers.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-public.defaultAnnotationRangeColor", + "type": "string", + "tags": [], + "label": "defaultAnnotationRangeColor", + "description": [], + "signature": [ + "\"#F04E981A\"" + ], + "path": "src/plugins/event_annotation/public/event_annotation_service/helpers.ts", + "deprecated": false, + "initialIsOpen": false } ], "objects": [], @@ -223,6 +291,20 @@ ], "enums": [], "misc": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.AvailableAnnotationIcon", + "type": "Type", + "tags": [], + "label": "AvailableAnnotationIcon", + "description": [], + "signature": [ + "\"alert\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"tag\" | \"circle\" | \"triangle\"" + ], + "path": "src/plugins/event_annotation/common/types.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "eventAnnotation", "id": "def-common.EventAnnotationArgs", @@ -231,8 +313,21 @@ "label": "EventAnnotationArgs", "description": [], "signature": [ - "{ time: string; } & ", - "StyleProps" + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.ManualPointEventAnnotationArgs", + "text": "ManualPointEventAnnotationArgs" + }, + " | ", + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.ManualRangeEventAnnotationArgs", + "text": "ManualRangeEventAnnotationArgs" + } ], "path": "src/plugins/event_annotation/common/manual_event_annotation/types.ts", "deprecated": false, @@ -246,8 +341,15 @@ "label": "EventAnnotationConfig", "description": [], "signature": [ - "{ id: string; key: { type: \"point_in_time\"; timestamp: string; }; } & ", - "StyleProps" + "PointInTimeEventAnnotationConfig", + " | ", + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.RangeEventAnnotationConfig", + "text": "RangeEventAnnotationConfig" + } ], "path": "src/plugins/event_annotation/common/types.ts", "deprecated": false, @@ -260,43 +362,132 @@ "tags": [], "label": "EventAnnotationOutput", "description": [], + "signature": [ + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.ManualPointEventAnnotationOutput", + "text": "ManualPointEventAnnotationOutput" + }, + " | ", + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.ManualRangeEventAnnotationOutput", + "text": "ManualRangeEventAnnotationOutput" + } + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.ManualPointEventAnnotationArgs", + "type": "Type", + "tags": [], + "label": "ManualPointEventAnnotationArgs", + "description": [], "signature": [ "{ time: string; } & ", - "StyleProps", - " & { type: \"manual_event_annotation\"; }" + "PointStyleProps" ], "path": "src/plugins/event_annotation/common/manual_event_annotation/types.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.ManualPointEventAnnotationOutput", + "type": "Type", + "tags": [], + "label": "ManualPointEventAnnotationOutput", + "description": [], + "signature": [ + "{ time: string; } & ", + "PointStyleProps", + " & { type: \"manual_point_event_annotation\"; }" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.ManualRangeEventAnnotationArgs", + "type": "Type", + "tags": [], + "label": "ManualRangeEventAnnotationArgs", + "description": [], + "signature": [ + "{ time: string; endTime: string; } & ", + "RangeStyleProps" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.ManualRangeEventAnnotationOutput", + "type": "Type", + "tags": [], + "label": "ManualRangeEventAnnotationOutput", + "description": [], + "signature": [ + "{ time: string; endTime: string; } & ", + "RangeStyleProps", + " & { type: \"manual_range_event_annotation\"; }" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.RangeEventAnnotationConfig", + "type": "Type", + "tags": [], + "label": "RangeEventAnnotationConfig", + "description": [], + "signature": [ + "{ id: string; key: { type: \"range\"; timestamp: string; endTimestamp: string; }; } & ", + "RangeStyleProps" + ], + "path": "src/plugins/event_annotation/common/types.ts", + "deprecated": false, + "initialIsOpen": false } ], "objects": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation", + "id": "def-common.manualPointEventAnnotation", "type": "Object", "tags": [], - "label": "manualEventAnnotation", + "label": "manualPointEventAnnotation", "description": [], "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "deprecated": false, "children": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.name", + "id": "def-common.manualPointEventAnnotation.name", "type": "string", "tags": [], "label": "name", "description": [], "signature": [ - "\"manual_event_annotation\"" + "\"manual_point_event_annotation\"" ], "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "deprecated": false }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.aliases", + "id": "def-common.manualPointEventAnnotation.aliases", "type": "Array", "tags": [], "label": "aliases", @@ -309,20 +500,20 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.type", + "id": "def-common.manualPointEventAnnotation.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ - "\"manual_event_annotation\"" + "\"manual_point_event_annotation\"" ], "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "deprecated": false }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.help", + "id": "def-common.manualPointEventAnnotation.help", "type": "string", "tags": [], "label": "help", @@ -332,7 +523,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.inputTypes", + "id": "def-common.manualPointEventAnnotation.inputTypes", "type": "Array", "tags": [], "label": "inputTypes", @@ -345,7 +536,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args", + "id": "def-common.manualPointEventAnnotation.args", "type": "Object", "tags": [], "label": "args", @@ -355,7 +546,7 @@ "children": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.time", + "id": "def-common.manualPointEventAnnotation.args.time", "type": "Object", "tags": [], "label": "time", @@ -365,7 +556,7 @@ "children": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.time.types", + "id": "def-common.manualPointEventAnnotation.args.time.types", "type": "Array", "tags": [], "label": "types", @@ -378,7 +569,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.time.help", + "id": "def-common.manualPointEventAnnotation.args.time.help", "type": "string", "tags": [], "label": "help", @@ -390,7 +581,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.label", + "id": "def-common.manualPointEventAnnotation.args.label", "type": "Object", "tags": [], "label": "label", @@ -400,7 +591,7 @@ "children": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.label.types", + "id": "def-common.manualPointEventAnnotation.args.label.types", "type": "Array", "tags": [], "label": "types", @@ -413,7 +604,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.label.help", + "id": "def-common.manualPointEventAnnotation.args.label.help", "type": "string", "tags": [], "label": "help", @@ -425,7 +616,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.color", + "id": "def-common.manualPointEventAnnotation.args.color", "type": "Object", "tags": [], "label": "color", @@ -435,7 +626,7 @@ "children": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.color.types", + "id": "def-common.manualPointEventAnnotation.args.color.types", "type": "Array", "tags": [], "label": "types", @@ -448,7 +639,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.color.help", + "id": "def-common.manualPointEventAnnotation.args.color.help", "type": "string", "tags": [], "label": "help", @@ -460,7 +651,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.lineStyle", + "id": "def-common.manualPointEventAnnotation.args.lineStyle", "type": "Object", "tags": [], "label": "lineStyle", @@ -470,7 +661,7 @@ "children": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.lineStyle.types", + "id": "def-common.manualPointEventAnnotation.args.lineStyle.types", "type": "Array", "tags": [], "label": "types", @@ -483,7 +674,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.lineStyle.options", + "id": "def-common.manualPointEventAnnotation.args.lineStyle.options", "type": "Array", "tags": [], "label": "options", @@ -496,7 +687,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.lineStyle.help", + "id": "def-common.manualPointEventAnnotation.args.lineStyle.help", "type": "string", "tags": [], "label": "help", @@ -508,7 +699,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.lineWidth", + "id": "def-common.manualPointEventAnnotation.args.lineWidth", "type": "Object", "tags": [], "label": "lineWidth", @@ -518,7 +709,7 @@ "children": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.lineWidth.types", + "id": "def-common.manualPointEventAnnotation.args.lineWidth.types", "type": "Array", "tags": [], "label": "types", @@ -531,7 +722,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.lineWidth.help", + "id": "def-common.manualPointEventAnnotation.args.lineWidth.help", "type": "string", "tags": [], "label": "help", @@ -543,7 +734,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.icon", + "id": "def-common.manualPointEventAnnotation.args.icon", "type": "Object", "tags": [], "label": "icon", @@ -553,7 +744,7 @@ "children": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.icon.types", + "id": "def-common.manualPointEventAnnotation.args.icon.types", "type": "Array", "tags": [], "label": "types", @@ -566,19 +757,45 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.icon.help", + "id": "def-common.manualPointEventAnnotation.args.icon.help", "type": "string", "tags": [], "label": "help", "description": [], "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualPointEventAnnotation.args.icon.options", + "type": "Array", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "(\"alert\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"tag\" | \"circle\" | \"triangle\")[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualPointEventAnnotation.args.icon.strict", + "type": "boolean", + "tags": [], + "label": "strict", + "description": [], + "signature": [ + "true" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false } ] }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.textVisibility", + "id": "def-common.manualPointEventAnnotation.args.textVisibility", "type": "Object", "tags": [], "label": "textVisibility", @@ -588,7 +805,7 @@ "children": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.textVisibility.types", + "id": "def-common.manualPointEventAnnotation.args.textVisibility.types", "type": "Array", "tags": [], "label": "types", @@ -601,7 +818,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.textVisibility.help", + "id": "def-common.manualPointEventAnnotation.args.textVisibility.help", "type": "string", "tags": [], "label": "help", @@ -613,7 +830,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.isHidden", + "id": "def-common.manualPointEventAnnotation.args.isHidden", "type": "Object", "tags": [], "label": "isHidden", @@ -623,7 +840,7 @@ "children": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.isHidden.types", + "id": "def-common.manualPointEventAnnotation.args.isHidden.types", "type": "Array", "tags": [], "label": "types", @@ -636,7 +853,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.args.isHidden.help", + "id": "def-common.manualPointEventAnnotation.args.isHidden.help", "type": "string", "tags": [], "label": "help", @@ -650,7 +867,7 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.fn", + "id": "def-common.manualPointEventAnnotation.fn", "type": "Function", "tags": [], "label": "fn", @@ -661,12 +878,20 @@ "pluginId": "eventAnnotation", "scope": "common", "docId": "kibEventAnnotationPluginApi", - "section": "def-common.EventAnnotationArgs", - "text": "EventAnnotationArgs" + "section": "def-common.ManualPointEventAnnotationArgs", + "text": "ManualPointEventAnnotationArgs" }, - ") => { time: string; label: string; color?: string | undefined; icon?: string | undefined; lineWidth?: number | undefined; lineStyle?: ", + ") => { time: string; label: string; color?: string | undefined; icon?: ", + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.AvailableAnnotationIcon", + "text": "AvailableAnnotationIcon" + }, + " | undefined; lineWidth?: number | undefined; lineStyle?: ", "LineStyle", - " | undefined; textVisibility?: boolean | undefined; isHidden?: boolean | undefined; type: \"manual_event_annotation\"; }" + " | undefined; textVisibility?: boolean | undefined; isHidden?: boolean | undefined; type: \"manual_point_event_annotation\"; }" ], "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "deprecated": false, @@ -674,7 +899,7 @@ "children": [ { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.fn.$1", + "id": "def-common.manualPointEventAnnotation.fn.$1", "type": "Unknown", "tags": [], "label": "input", @@ -687,14 +912,388 @@ }, { "parentPluginId": "eventAnnotation", - "id": "def-common.manualEventAnnotation.fn.$2", + "id": "def-common.manualPointEventAnnotation.fn.$2", "type": "CompoundType", "tags": [], "label": "args", "description": [], "signature": [ "{ time: string; } & ", - "StyleProps" + "PointStyleProps" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation", + "type": "Object", + "tags": [], + "label": "manualRangeEventAnnotation", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "\"manual_range_event_annotation\"" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.aliases", + "type": "Array", + "tags": [], + "label": "aliases", + "description": [], + "signature": [ + "never[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"manual_range_event_annotation\"" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.inputTypes", + "type": "Array", + "tags": [], + "label": "inputTypes", + "description": [], + "signature": [ + "\"null\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args", + "type": "Object", + "tags": [], + "label": "args", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.time", + "type": "Object", + "tags": [], + "label": "time", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.time.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"string\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.time.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.endTime", + "type": "Object", + "tags": [], + "label": "endTime", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.endTime.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"string\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.endTime.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.endTime.required", + "type": "boolean", + "tags": [], + "label": "required", + "description": [], + "signature": [ + "false" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.outside", + "type": "Object", + "tags": [], + "label": "outside", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.outside.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"boolean\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.outside.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.outside.required", + "type": "boolean", + "tags": [], + "label": "required", + "description": [], + "signature": [ + "false" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.label", + "type": "Object", + "tags": [], + "label": "label", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.label.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"string\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.label.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.color", + "type": "Object", + "tags": [], + "label": "color", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.color.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"string\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.color.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.isHidden", + "type": "Object", + "tags": [], + "label": "isHidden", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.isHidden.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + "\"boolean\"[]" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.args.isHidden.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + } + ] + } + ] + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.fn", + "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + "(input: unknown, args: ", + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.ManualRangeEventAnnotationArgs", + "text": "ManualRangeEventAnnotationArgs" + }, + ") => { time: string; endTime: string; label: string; color?: string | undefined; outside?: boolean | undefined; isHidden?: boolean | undefined; type: \"manual_range_event_annotation\"; }" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.fn.$1", + "type": "Unknown", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "unknown" + ], + "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", + "deprecated": false + }, + { + "parentPluginId": "eventAnnotation", + "id": "def-common.manualRangeEventAnnotation.fn.$2", + "type": "CompoundType", + "tags": [], + "label": "args", + "description": [], + "signature": [ + "{ time: string; endTime: string; } & ", + "RangeStyleProps" ], "path": "src/plugins/event_annotation/common/manual_event_annotation/index.ts", "deprecated": false diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index 5e3d34fcae086..d998330158a07 100644 --- a/api_docs/event_annotation.mdx +++ b/api_docs/event_annotation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventAnnotation title: "eventAnnotation" image: https://source.unsplash.com/400x175/?github summary: API docs for the eventAnnotation plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,13 +18,16 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 49 | 0 | 49 | 3 | +| 90 | 0 | 90 | 5 | ## Client ### Start +### Functions + + ### Interfaces diff --git a/api_docs/event_log.devdocs.json b/api_docs/event_log.devdocs.json index 1a4840efc4729..37aeae0f18f44 100644 --- a/api_docs/event_log.devdocs.json +++ b/api_docs/event_log.devdocs.json @@ -678,6 +678,68 @@ "children": [], "returnComment": [], "initialIsOpen": false + }, + { + "parentPluginId": "eventLog", + "id": "def-server.millisToNanos", + "type": "Function", + "tags": [], + "label": "millisToNanos", + "description": [], + "signature": [ + "(millis: number) => string" + ], + "path": "x-pack/plugins/event_log/common/lib/millis_to_nanos.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventLog", + "id": "def-server.millisToNanos.$1", + "type": "number", + "tags": [], + "label": "millis", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/event_log/common/lib/millis_to_nanos.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "eventLog", + "id": "def-server.nanosToMillis", + "type": "Function", + "tags": [], + "label": "nanosToMillis", + "description": [], + "signature": [ + "(nanos: string | number) => number" + ], + "path": "x-pack/plugins/event_log/common/lib/nanos_to_millis.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventLog", + "id": "def-server.nanosToMillis.$1", + "type": "CompoundType", + "tags": [], + "label": "nanos", + "description": [], + "signature": [ + "string | number" + ], + "path": "x-pack/plugins/event_log/common/lib/nanos_to_millis.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false } ], "interfaces": [ @@ -942,7 +1004,7 @@ "signature": [ "(event: ", "IEvent", - ") => void" + ", startTime?: Date | undefined) => void" ], "path": "x-pack/plugins/event_log/server/types.ts", "deprecated": false, @@ -960,6 +1022,20 @@ "path": "x-pack/plugins/event_log/server/types.ts", "deprecated": false, "isRequired": false + }, + { + "parentPluginId": "eventLog", + "id": "def-server.IEventLogger.startTiming.$2", + "type": "Object", + "tags": [], + "label": "startTime", + "description": [], + "signature": [ + "Date | undefined" + ], + "path": "x-pack/plugins/event_log/server/types.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -1047,7 +1123,7 @@ "label": "data", "description": [], "signature": [ - "(Readonly<{ error?: Readonly<{ message?: string | undefined; id?: string | undefined; type?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_generated_actions?: number | undefined; number_of_new_alerts?: number | undefined; number_of_active_alerts?: number | undefined; number_of_recovered_alerts?: number | undefined; total_number_of_alerts?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]" + "(Readonly<{ error?: Readonly<{ message?: string | undefined; id?: string | undefined; type?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]" ], "path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts", "deprecated": false @@ -1066,7 +1142,7 @@ "label": "IEvent", "description": [], "signature": [ - "DeepPartial | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_generated_actions?: number | undefined; number_of_new_alerts?: number | undefined; number_of_active_alerts?: number | undefined; number_of_recovered_alerts?: number | undefined; total_number_of_alerts?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined" + "DeepPartial | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined" ], "path": "x-pack/plugins/event_log/generated/schemas.ts", "deprecated": false, @@ -1080,7 +1156,7 @@ "label": "IValidatedEvent", "description": [], "signature": [ - "Readonly<{ error?: Readonly<{ message?: string | undefined; id?: string | undefined; type?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: number | undefined; number_of_generated_actions?: number | undefined; number_of_new_alerts?: number | undefined; number_of_active_alerts?: number | undefined; number_of_recovered_alerts?: number | undefined; total_number_of_alerts?: number | undefined; number_of_searches?: number | undefined; total_indexing_duration_ms?: number | undefined; es_search_duration_ms?: number | undefined; total_search_duration_ms?: number | undefined; execution_gap_duration_s?: number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: number | undefined; created?: string | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined" + "Readonly<{ error?: Readonly<{ message?: string | undefined; id?: string | undefined; type?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; saved_objects?: Readonly<{ id?: string | undefined; type?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; space_ids?: string[] | undefined; } & {}> | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; id?: string | undefined; type?: string[] | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; url?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined" ], "path": "x-pack/plugins/event_log/generated/schemas.ts", "deprecated": false, @@ -1433,7 +1509,70 @@ }, "common": { "classes": [], - "functions": [], + "functions": [ + { + "parentPluginId": "eventLog", + "id": "def-common.millisToNanos", + "type": "Function", + "tags": [], + "label": "millisToNanos", + "description": [], + "signature": [ + "(millis: number) => string" + ], + "path": "x-pack/plugins/event_log/common/lib/millis_to_nanos.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventLog", + "id": "def-common.millisToNanos.$1", + "type": "number", + "tags": [], + "label": "millis", + "description": [], + "signature": [ + "number" + ], + "path": "x-pack/plugins/event_log/common/lib/millis_to_nanos.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "eventLog", + "id": "def-common.nanosToMillis", + "type": "Function", + "tags": [], + "label": "nanosToMillis", + "description": [], + "signature": [ + "(nanos: string | number) => number" + ], + "path": "x-pack/plugins/event_log/common/lib/nanos_to_millis.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "eventLog", + "id": "def-common.nanosToMillis.$1", + "type": "CompoundType", + "tags": [], + "label": "nanos", + "description": [], + "signature": [ + "string | number" + ], + "path": "x-pack/plugins/event_log/common/lib/nanos_to_millis.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], "interfaces": [], "enums": [], "misc": [ diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index 562f7fee9dbbb..2145ea524c6b7 100644 --- a/api_docs/event_log.mdx +++ b/api_docs/event_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventLog title: "eventLog" image: https://source.unsplash.com/400x175/?github summary: API docs for the eventLog plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 91 | 0 | 91 | 9 | +| 100 | 0 | 100 | 9 | ## Server @@ -42,6 +42,9 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q ## Common +### Functions + + ### Consts, variables and types diff --git a/api_docs/expression_error.mdx b/api_docs/expression_error.mdx index 22245b38031d1..ed92bc259f348 100644 --- a/api_docs/expression_error.mdx +++ b/api_docs/expression_error.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionError title: "expressionError" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionError plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_gauge.mdx b/api_docs/expression_gauge.mdx index f83a1b80f6f29..2f67074b09ff3 100644 --- a/api_docs/expression_gauge.mdx +++ b/api_docs/expression_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionGauge title: "expressionGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionGauge plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_heatmap.devdocs.json b/api_docs/expression_heatmap.devdocs.json index e686e8a1e7b76..1660cb3e4eea7 100644 --- a/api_docs/expression_heatmap.devdocs.json +++ b/api_docs/expression_heatmap.devdocs.json @@ -1454,7 +1454,26 @@ "label": "types", "description": [], "signature": [ - "\"number\"[]" + "\"string\"[]" + ], + "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionHeatmap", + "id": "def-common.heatmapLegendConfig.args.legendSize.default", + "type": "Enum", + "tags": [], + "label": "default", + "description": [], + "signature": [ + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.LegendSize", + "text": "LegendSize" + } ], "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "deprecated": false @@ -1468,6 +1487,39 @@ "description": [], "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "deprecated": false + }, + { + "parentPluginId": "expressionHeatmap", + "id": "def-common.heatmapLegendConfig.args.legendSize.options", + "type": "Array", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.LegendSize", + "text": "LegendSize" + }, + "[]" + ], + "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionHeatmap", + "id": "def-common.heatmapLegendConfig.args.legendSize.strict", + "type": "boolean", + "tags": [], + "label": "strict", + "description": [], + "signature": [ + "true" + ], + "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", + "deprecated": false } ] } @@ -1485,7 +1537,15 @@ "HeatmapLegendConfig", ") => { isVisible: boolean; position: ", "Position", - "; maxLines?: number | undefined; shouldTruncate?: boolean | undefined; legendSize?: number | undefined; type: \"heatmap_legend\"; }" + "; maxLines?: number | undefined; shouldTruncate?: boolean | undefined; legendSize?: ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.LegendSize", + "text": "LegendSize" + }, + " | undefined; type: \"heatmap_legend\"; }" ], "path": "src/plugins/chart_expressions/expression_heatmap/common/expression_functions/heatmap_legend.ts", "deprecated": false, diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx index d828747b22637..d52fc5c6ac8f4 100644 --- a/api_docs/expression_heatmap.mdx +++ b/api_docs/expression_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap title: "expressionHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionHeatmap plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 104 | 0 | 100 | 3 | +| 107 | 0 | 103 | 3 | ## Client diff --git a/api_docs/expression_image.mdx b/api_docs/expression_image.mdx index 093aecd94cd99..9227f43df484c 100644 --- a/api_docs/expression_image.mdx +++ b/api_docs/expression_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionImage title: "expressionImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionImage plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_metric.mdx b/api_docs/expression_metric.mdx index 527d9a85c187c..8a77a609d2c94 100644 --- a/api_docs/expression_metric.mdx +++ b/api_docs/expression_metric.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetric title: "expressionMetric" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionMetric plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_metric_vis.devdocs.json b/api_docs/expression_metric_vis.devdocs.json index de4956164a459..1cb75f69b1e8f 100644 --- a/api_docs/expression_metric_vis.devdocs.json +++ b/api_docs/expression_metric_vis.devdocs.json @@ -348,6 +348,26 @@ "description": [], "path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts", "deprecated": false + }, + { + "parentPluginId": "expressionMetricVis", + "id": "def-common.MetricOptions.colIndex", + "type": "number", + "tags": [], + "label": "colIndex", + "description": [], + "path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionMetricVis", + "id": "def-common.MetricOptions.rowIndex", + "type": "number", + "tags": [], + "label": "rowIndex", + "description": [], + "path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts", + "deprecated": false } ], "initialIsOpen": false diff --git a/api_docs/expression_metric_vis.mdx b/api_docs/expression_metric_vis.mdx index e4d8c09eb36cd..ad4ff663df344 100644 --- a/api_docs/expression_metric_vis.mdx +++ b/api_docs/expression_metric_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis title: "expressionMetricVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionMetricVis plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 46 | 0 | 46 | 1 | +| 48 | 0 | 48 | 1 | ## Common diff --git a/api_docs/expression_partition_vis.mdx b/api_docs/expression_partition_vis.mdx index 97c89c561e56c..e35d34a78a388 100644 --- a/api_docs/expression_partition_vis.mdx +++ b/api_docs/expression_partition_vis.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis title: "expressionPartitionVis" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionPartitionVis plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_repeat_image.mdx b/api_docs/expression_repeat_image.mdx index 5b0af3d5efbc8..9dbaddde6b0ce 100644 --- a/api_docs/expression_repeat_image.mdx +++ b/api_docs/expression_repeat_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage title: "expressionRepeatImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionRepeatImage plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_reveal_image.mdx b/api_docs/expression_reveal_image.mdx index c7eca19a624cb..aa0e2f15ad1ad 100644 --- a/api_docs/expression_reveal_image.mdx +++ b/api_docs/expression_reveal_image.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage title: "expressionRevealImage" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionRevealImage plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_shape.mdx b/api_docs/expression_shape.mdx index f3ee5306578c3..1d7b9d029305e 100644 --- a/api_docs/expression_shape.mdx +++ b/api_docs/expression_shape.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionShape title: "expressionShape" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionShape plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_tagcloud.mdx b/api_docs/expression_tagcloud.mdx index 8331a345d07cc..3b04ac523d9ce 100644 --- a/api_docs/expression_tagcloud.mdx +++ b/api_docs/expression_tagcloud.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud title: "expressionTagcloud" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionTagcloud plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/expression_x_y.devdocs.json b/api_docs/expression_x_y.devdocs.json index 7064fd2035207..6e0298f3ebc5c 100644 --- a/api_docs/expression_x_y.devdocs.json +++ b/api_docs/expression_x_y.devdocs.json @@ -62,66 +62,7 @@ }, "common": { "classes": [], - "functions": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.annotationLayerConfigFunction", - "type": "Function", - "tags": [], - "label": "annotationLayerConfigFunction", - "description": [], - "signature": [ - "() => ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionFunctionDefinition", - "text": "ExpressionFunctionDefinition" - }, - "<\"annotationLayer\", null, ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AnnotationLayerArgs", - "text": "AnnotationLayerArgs" - }, - ", ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AnnotationLayerConfigResult", - "text": "AnnotationLayerConfigResult" - }, - ", ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableRecord", - ">>" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/annotation_layer_config.ts", - "deprecated": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - } - ], + "functions": [], "interfaces": [ { "parentPluginId": "expressionXY", @@ -153,16 +94,6 @@ "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, - { - "parentPluginId": "expressionXY", - "id": "def-common.AnnotationLayerArgs.layerId", - "type": "string", - "tags": [], - "label": "layerId", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, { "parentPluginId": "expressionXY", "id": "def-common.AnnotationLayerArgs.hide", @@ -312,24 +243,95 @@ }, { "parentPluginId": "expressionXY", - "id": "def-common.DataLayerArgs", + "id": "def-common.CollectiveConfig", "type": "Interface", "tags": [], - "label": "DataLayerArgs", + "label": "CollectiveConfig", "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.CollectiveConfig", + "text": "CollectiveConfig" + }, + " extends Omit<", + { + "pluginId": "eventAnnotation", + "scope": "common", + "docId": "kibEventAnnotationPluginApi", + "section": "def-common.ManualPointEventAnnotationArgs", + "text": "ManualPointEventAnnotationArgs" + }, + ", \"icon\">" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", "deprecated": false, "children": [ { "parentPluginId": "expressionXY", - "id": "def-common.DataLayerArgs.layerId", + "id": "def-common.CollectiveConfig.roundedTimestamp", + "type": "number", + "tags": [], + "label": "roundedTimestamp", + "description": [], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.CollectiveConfig.axisMode", "type": "string", "tags": [], - "label": "layerId", + "label": "axisMode", "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "signature": [ + "\"bottom\"" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.CollectiveConfig.icon", + "type": "string", + "tags": [], + "label": "icon", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", "deprecated": false }, + { + "parentPluginId": "expressionXY", + "id": "def-common.CollectiveConfig.customTooltipDetails", + "type": "Function", + "tags": [], + "label": "customTooltipDetails", + "description": [], + "signature": [ + "AnnotationTooltipFormatter", + " | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.DataLayerArgs", + "type": "Interface", + "tags": [], + "label": "DataLayerArgs", + "description": [], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "children": [ { "parentPluginId": "expressionXY", "id": "def-common.DataLayerArgs.accessors", @@ -338,7 +340,15 @@ "label": "accessors", "description": [], "signature": [ - "string[]" + "(string | ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.ExpressionValueVisDimension", + "text": "ExpressionValueVisDimension" + }, + ")[]" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -359,12 +369,20 @@ { "parentPluginId": "expressionXY", "id": "def-common.DataLayerArgs.xAccessor", - "type": "string", + "type": "CompoundType", "tags": [], "label": "xAccessor", "description": [], "signature": [ - "string | undefined" + "string | ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.ExpressionValueVisDimension", + "text": "ExpressionValueVisDimension" + }, + " | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -385,38 +403,93 @@ { "parentPluginId": "expressionXY", "id": "def-common.DataLayerArgs.splitAccessor", - "type": "string", + "type": "CompoundType", "tags": [], "label": "splitAccessor", "description": [], "signature": [ - "string | undefined" + "string | ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.ExpressionValueVisDimension", + "text": "ExpressionValueVisDimension" + }, + " | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "expressionXY", - "id": "def-common.DataLayerArgs.columnToLabel", - "type": "string", + "id": "def-common.DataLayerArgs.markSizeAccessor", + "type": "CompoundType", "tags": [], - "label": "columnToLabel", + "label": "markSizeAccessor", "description": [], "signature": [ - "string | undefined" + "string | ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.ExpressionValueVisDimension", + "text": "ExpressionValueVisDimension" + }, + " | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.DataLayerArgs.lineWidth", + "type": "number", + "tags": [], + "label": "lineWidth", + "description": [], + "signature": [ + "number | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "expressionXY", - "id": "def-common.DataLayerArgs.yScaleType", + "id": "def-common.DataLayerArgs.showPoints", "type": "CompoundType", "tags": [], - "label": "yScaleType", + "label": "showPoints", "description": [], "signature": [ - "\"time\" | \"log\" | \"sqrt\" | \"linear\"" + "boolean | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.DataLayerArgs.pointsRadius", + "type": "number", + "tags": [], + "label": "pointsRadius", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.DataLayerArgs.columnToLabel", + "type": "string", + "tags": [], + "label": "columnToLabel", + "description": [], + "signature": [ + "string | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -466,13 +539,7 @@ "label": "yConfig", "description": [], "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.YConfigResult", - "text": "YConfigResult" - }, + "YConfigResult", "[] | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", @@ -483,76 +550,212 @@ }, { "parentPluginId": "expressionXY", - "id": "def-common.LabelsOrientationConfig", + "id": "def-common.ExtendedYConfig", "type": "Interface", "tags": [], - "label": "LabelsOrientationConfig", + "label": "ExtendedYConfig", "description": [], + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.ExtendedYConfig", + "text": "ExtendedYConfig" + }, + " extends ", + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.YConfig", + "text": "YConfig" + } + ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, "children": [ { "parentPluginId": "expressionXY", - "id": "def-common.LabelsOrientationConfig.x", - "type": "number", + "id": "def-common.ExtendedYConfig.icon", + "type": "CompoundType", "tags": [], - "label": "x", + "label": "icon", "description": [], + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.AvailableReferenceLineIcon", + "text": "AvailableReferenceLineIcon" + }, + " | undefined" + ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "expressionXY", - "id": "def-common.LabelsOrientationConfig.yLeft", + "id": "def-common.ExtendedYConfig.lineWidth", "type": "number", "tags": [], - "label": "yLeft", + "label": "lineWidth", "description": [], + "signature": [ + "number | undefined" + ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "expressionXY", - "id": "def-common.LabelsOrientationConfig.yRight", - "type": "number", + "id": "def-common.ExtendedYConfig.lineStyle", + "type": "CompoundType", "tags": [], - "label": "yRight", + "label": "lineStyle", "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.LegendConfig", - "type": "Interface", - "tags": [], - "label": "LegendConfig", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.LegendConfig.isVisible", - "type": "boolean", - "tags": [], - "label": "isVisible", - "description": [ - "\nFlag whether the legend should be shown. If there is just a single series, it will be hidden" + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.LineStyle", + "text": "LineStyle" + }, + " | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "expressionXY", - "id": "def-common.LegendConfig.position", + "id": "def-common.ExtendedYConfig.fill", "type": "CompoundType", "tags": [], - "label": "position", - "description": [ + "label": "fill", + "description": [], + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.FillStyle", + "text": "FillStyle" + }, + " | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.ExtendedYConfig.iconPosition", + "type": "CompoundType", + "tags": [], + "label": "iconPosition", + "description": [], + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.IconPosition", + "text": "IconPosition" + }, + " | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.ExtendedYConfig.textVisibility", + "type": "CompoundType", + "tags": [], + "label": "textVisibility", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.LabelsOrientationConfig", + "type": "Interface", + "tags": [], + "label": "LabelsOrientationConfig", + "description": [], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "expressionXY", + "id": "def-common.LabelsOrientationConfig.x", + "type": "number", + "tags": [], + "label": "x", + "description": [], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.LabelsOrientationConfig.yLeft", + "type": "number", + "tags": [], + "label": "yLeft", + "description": [], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.LabelsOrientationConfig.yRight", + "type": "number", + "tags": [], + "label": "yRight", + "description": [], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.LegendConfig", + "type": "Interface", + "tags": [], + "label": "LegendConfig", + "description": [], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "expressionXY", + "id": "def-common.LegendConfig.isVisible", + "type": "boolean", + "tags": [], + "label": "isVisible", + "description": [ + "\nFlag whether the legend should be shown. If there is just a single series, it will be hidden" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.LegendConfig.position", + "type": "CompoundType", + "tags": [], + "label": "position", + "description": [ "\nPosition of the legend relative to the chart" ], "signature": [ @@ -601,8 +804,7 @@ "\nHorizontal Alignment of the legend when it is set inside chart" ], "signature": [ - "HorizontalAlignment", - " | undefined" + "\"left\" | \"right\" | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -617,8 +819,7 @@ "\nVertical Alignment of the legend when it is set inside chart" ], "signature": [ - "VerticalAlignment", - " | undefined" + "\"top\" | \"bottom\" | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -671,74 +872,21 @@ { "parentPluginId": "expressionXY", "id": "def-common.LegendConfig.legendSize", - "type": "number", + "type": "CompoundType", "tags": [], "label": "legendSize", "description": [ "\nExact legend width (vertical) or height (horizontal)\nLimited to max of 70% of the chart container dimension Vertical legends limited to min of 30% of computed width" ], "signature": [ - "number | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.LensMultiTable", - "type": "Interface", - "tags": [], - "label": "LensMultiTable", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.LensMultiTable.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"lens_multitable\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.LensMultiTable.tables", - "type": "Object", - "tags": [], - "label": "tables", - "description": [], - "signature": [ - "{ [x: string]: ", { - "pluginId": "expressions", + "pluginId": "visualizations", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "docId": "kibVisualizationsPluginApi", + "section": "def-common.LegendSize", + "text": "LegendSize" }, - "; }" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.LensMultiTable.dateRange", - "type": "Object", - "tags": [], - "label": "dateRange", - "description": [], - "signature": [ - "{ fromDate: Date; toDate: Date; } | undefined" + " | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -763,6 +911,9 @@ "tags": [], "label": "layerId", "description": [], + "signature": [ + "string | undefined" + ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, @@ -804,13 +955,33 @@ "pluginId": "expressionXY", "scope": "common", "docId": "kibExpressionXYPluginApi", - "section": "def-common.YConfigResult", - "text": "YConfigResult" + "section": "def-common.ExtendedYConfigResult", + "text": "ExtendedYConfigResult" }, "[] | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.ReferenceLineLayerArgs.table", + "type": "Object", + "tags": [], + "label": "table", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + " | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false } ], "initialIsOpen": false @@ -845,10 +1016,20 @@ { "parentPluginId": "expressionXY", "id": "def-common.ValidLayer.xAccessor", - "type": "string", + "type": "CompoundType", "tags": [], "label": "xAccessor", "description": [], + "signature": [ + "string | ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.ExpressionValueVisDimension", + "text": "ExpressionValueVisDimension" + } + ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false } @@ -862,35 +1043,26 @@ "tags": [], "label": "XYArgs", "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false, - "children": [ + "signature": [ { - "parentPluginId": "expressionXY", - "id": "def-common.XYArgs.title", - "type": "string", - "tags": [], - "label": "title", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.XYArgs", + "text": "XYArgs" }, + " extends ", { - "parentPluginId": "expressionXY", - "id": "def-common.XYArgs.description", - "type": "string", - "tags": [], - "label": "description", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.DataLayerArgs", + "text": "DataLayerArgs" + } + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "children": [ { "parentPluginId": "expressionXY", "id": "def-common.XYArgs.xTitle", @@ -963,53 +1135,46 @@ }, { "parentPluginId": "expressionXY", - "id": "def-common.XYArgs.legend", + "id": "def-common.XYArgs.yLeftScale", "type": "CompoundType", "tags": [], - "label": "legend", + "label": "yLeftScale", "description": [], "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LegendConfig", - "text": "LegendConfig" - }, - " & { type: \"legendConfig\"; }" + "\"time\" | \"log\" | \"sqrt\" | \"linear\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "expressionXY", - "id": "def-common.XYArgs.valueLabels", + "id": "def-common.XYArgs.yRightScale", "type": "CompoundType", "tags": [], - "label": "valueLabels", + "label": "yRightScale", "description": [], "signature": [ - "\"hide\" | \"inside\" | \"outside\"" + "\"time\" | \"log\" | \"sqrt\" | \"linear\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "expressionXY", - "id": "def-common.XYArgs.layers", - "type": "Array", + "id": "def-common.XYArgs.legend", + "type": "CompoundType", "tags": [], - "label": "layers", + "label": "legend", "description": [], "signature": [ { "pluginId": "expressionXY", "scope": "common", "docId": "kibExpressionXYPluginApi", - "section": "def-common.XYLayerConfigResult", - "text": "XYLayerConfigResult" + "section": "def-common.LegendConfig", + "text": "LegendConfig" }, - "[]" + " & { type: \"legendConfig\"; }" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -1047,6 +1212,47 @@ "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, + { + "parentPluginId": "expressionXY", + "id": "def-common.XYArgs.valueLabels", + "type": "CompoundType", + "tags": [], + "label": "valueLabels", + "description": [], + "signature": [ + "\"show\" | \"hide\"" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.XYArgs.referenceLines", + "type": "Array", + "tags": [], + "label": "referenceLines", + "description": [], + "signature": [ + "ReferenceLineConfigResult", + "[]" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.XYArgs.annotationLayers", + "type": "Array", + "tags": [], + "label": "annotationLayers", + "description": [], + "signature": [ + "AnnotationLayerConfigResult", + "[]" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, { "parentPluginId": "expressionXY", "id": "def-common.XYArgs.fittingFunction", @@ -1218,6 +1424,87 @@ ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.XYArgs.addTimeMarker", + "type": "CompoundType", + "tags": [], + "label": "addTimeMarker", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.XYArgs.markSizeRatio", + "type": "number", + "tags": [], + "label": "markSizeRatio", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.XYArgs.minTimeBarInterval", + "type": "string", + "tags": [], + "label": "minTimeBarInterval", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.XYArgs.splitRowAccessor", + "type": "CompoundType", + "tags": [], + "label": "splitRowAccessor", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.ExpressionValueVisDimension", + "text": "ExpressionValueVisDimension" + }, + " | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.XYArgs.splitColumnAccessor", + "type": "CompoundType", + "tags": [], + "label": "splitColumnAccessor", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.ExpressionValueVisDimension", + "text": "ExpressionValueVisDimension" + }, + " | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false } ], "initialIsOpen": false @@ -1232,25 +1519,6 @@ "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", "deprecated": false, "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.XYChartProps.data", - "type": "Object", - "tags": [], - "label": "data", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LensMultiTable", - "text": "LensMultiTable" - } - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", - "deprecated": false - }, { "parentPluginId": "expressionXY", "id": "def-common.XYChartProps.args", @@ -1259,13 +1527,7 @@ "label": "args", "description": [], "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.XYArgs", - "text": "XYArgs" - } + "XYProps" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", "deprecated": false @@ -1383,105 +1645,6 @@ ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.YConfig.icon", - "type": "string", - "tags": [], - "label": "icon", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.YConfig.lineWidth", - "type": "number", - "tags": [], - "label": "lineWidth", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.YConfig.lineStyle", - "type": "CompoundType", - "tags": [], - "label": "lineStyle", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LineStyle", - "text": "LineStyle" - }, - " | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.YConfig.fill", - "type": "CompoundType", - "tags": [], - "label": "fill", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.FillStyle", - "text": "FillStyle" - }, - " | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.YConfig.iconPosition", - "type": "CompoundType", - "tags": [], - "label": "iconPosition", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.IconPosition", - "text": "IconPosition" - }, - " | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.YConfig.textVisibility", - "type": "CompoundType", - "tags": [], - "label": "textVisibility", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false } ], "initialIsOpen": false @@ -1491,20 +1654,13 @@ "misc": [ { "parentPluginId": "expressionXY", - "id": "def-common.AnnotationLayerConfigResult", + "id": "def-common.AvailableReferenceLineIcon", "type": "Type", "tags": [], - "label": "AnnotationLayerConfigResult", + "label": "AvailableReferenceLineIcon", "description": [], "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AnnotationLayerArgs", - "text": "AnnotationLayerArgs" - }, - " & { type: \"annotationLayer\"; layerType: \"annotations\"; }" + "\"alert\" | \"asterisk\" | \"bell\" | \"bolt\" | \"bug\" | \"editorComment\" | \"empty\" | \"flag\" | \"heart\" | \"mapMarker\" | \"pinFilled\" | \"starEmpty\" | \"tag\" | \"circle\" | \"triangle\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, @@ -1568,20 +1724,15 @@ }, { "parentPluginId": "expressionXY", - "id": "def-common.DataLayerConfigResult", + "id": "def-common.CommonXYAnnotationLayerConfig", "type": "Type", "tags": [], - "label": "DataLayerConfigResult", + "label": "CommonXYAnnotationLayerConfig", "description": [], "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.DataLayerArgs", - "text": "DataLayerArgs" - }, - " & { type: \"dataLayer\"; layerType: \"data\"; }" + "AnnotationLayerConfig", + " | ", + "ExtendedAnnotationLayerConfig" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, @@ -1589,13 +1740,21 @@ }, { "parentPluginId": "expressionXY", - "id": "def-common.EndValue", + "id": "def-common.CommonXYDataLayerConfig", "type": "Type", "tags": [], - "label": "EndValue", + "label": "CommonXYDataLayerConfig", "description": [], "signature": [ - "\"None\" | \"Zero\" | \"Nearest\"" + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.DataLayerConfig", + "text": "DataLayerConfig" + }, + " | ", + "ExtendedDataLayerConfig" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, @@ -1603,13 +1762,27 @@ }, { "parentPluginId": "expressionXY", - "id": "def-common.FillStyle", + "id": "def-common.CommonXYDataLayerConfigResult", "type": "Type", "tags": [], - "label": "FillStyle", + "label": "CommonXYDataLayerConfigResult", "description": [], "signature": [ - "\"above\" | \"below\" | \"none\"" + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.DataLayerConfigResult", + "text": "DataLayerConfigResult" + }, + " | ", + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.ExtendedDataLayerConfigResult", + "text": "ExtendedDataLayerConfigResult" + } ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, @@ -1617,7 +1790,207 @@ }, { "parentPluginId": "expressionXY", - "id": "def-common.FittingFunction", + "id": "def-common.CommonXYLayerConfig", + "type": "Type", + "tags": [], + "label": "CommonXYLayerConfig", + "description": [], + "signature": [ + "XYLayerConfig", + " | ", + "XYExtendedLayerConfig" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.CommonXYReferenceLineLayerConfig", + "type": "Type", + "tags": [], + "label": "CommonXYReferenceLineLayerConfig", + "description": [], + "signature": [ + "ReferenceLineConfig", + " | ", + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.ReferenceLineLayerConfig", + "text": "ReferenceLineLayerConfig" + } + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.CommonXYReferenceLineLayerConfigResult", + "type": "Type", + "tags": [], + "label": "CommonXYReferenceLineLayerConfigResult", + "description": [], + "signature": [ + "ReferenceLineConfigResult", + " | ", + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.ReferenceLineLayerConfigResult", + "text": "ReferenceLineLayerConfigResult" + } + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.DataLayerConfig", + "type": "Type", + "tags": [], + "label": "DataLayerConfig", + "description": [], + "signature": [ + "Omit<", + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.DataLayerArgs", + "text": "DataLayerArgs" + }, + ", \"palette\"> & { type: \"dataLayer\"; layerType: \"data\"; palette: ", + "PaletteOutput", + "<{ [key: string]: unknown; }>; table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + "; } & ", + "WithLayerId" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.DataLayerConfigResult", + "type": "Type", + "tags": [], + "label": "DataLayerConfigResult", + "description": [], + "signature": [ + "Omit<", + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.DataLayerArgs", + "text": "DataLayerArgs" + }, + ", \"palette\"> & { type: \"dataLayer\"; layerType: \"data\"; palette: ", + "PaletteOutput", + "<{ [key: string]: unknown; }>; table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + "; }" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.EndValue", + "type": "Type", + "tags": [], + "label": "EndValue", + "description": [], + "signature": [ + "\"None\" | \"Zero\" | \"Nearest\"" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.ExtendedDataLayerConfigResult", + "type": "Type", + "tags": [], + "label": "ExtendedDataLayerConfigResult", + "description": [], + "signature": [ + "Omit<", + "ExtendedDataLayerArgs", + ", \"palette\"> & { type: \"extendedDataLayer\"; layerType: \"data\"; palette: ", + "PaletteOutput", + "<{ [key: string]: unknown; }>; table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + "; }" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.ExtendedYConfigResult", + "type": "Type", + "tags": [], + "label": "ExtendedYConfigResult", + "description": [], + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.ExtendedYConfig", + "text": "ExtendedYConfig" + }, + " & { type: \"extendedYConfig\"; }" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.FillStyle", + "type": "Type", + "tags": [], + "label": "FillStyle", + "description": [], + "signature": [ + "\"above\" | \"below\" | \"none\"" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "expressionXY", + "id": "def-common.FittingFunction", "type": "Type", "tags": [], "label": "FittingFunction", @@ -1762,6 +2135,36 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "expressionXY", + "id": "def-common.ReferenceLineLayerConfig", + "type": "Type", + "tags": [], + "label": "ReferenceLineLayerConfig", + "description": [], + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.ReferenceLineLayerArgs", + "text": "ReferenceLineLayerArgs" + }, + " & { type: \"referenceLineLayer\"; layerType: \"referenceLine\"; table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + "; } & ", + "WithLayerId" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "expressionXY", "id": "def-common.ReferenceLineLayerConfigResult", @@ -1777,7 +2180,15 @@ "section": "def-common.ReferenceLineLayerArgs", "text": "ReferenceLineLayerArgs" }, - " & { type: \"referenceLineLayer\"; layerType: \"referenceLine\"; }" + " & { type: \"referenceLineLayer\"; layerType: \"referenceLine\"; table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + "; }" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, @@ -1826,7 +2237,7 @@ "label": "ValueLabelMode", "description": [], "signature": [ - "\"hide\" | \"inside\" | \"outside\"" + "\"show\" | \"hide\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, @@ -1862,35 +2273,29 @@ }, { "parentPluginId": "expressionXY", - "id": "def-common.XYLayerArgs", + "id": "def-common.XYExtendedLayerConfigResult", "type": "Type", "tags": [], - "label": "XYLayerArgs", + "label": "XYExtendedLayerConfigResult", "description": [], "signature": [ { "pluginId": "expressionXY", "scope": "common", "docId": "kibExpressionXYPluginApi", - "section": "def-common.DataLayerArgs", - "text": "DataLayerArgs" + "section": "def-common.ExtendedDataLayerConfigResult", + "text": "ExtendedDataLayerConfigResult" }, " | ", { "pluginId": "expressionXY", "scope": "common", "docId": "kibExpressionXYPluginApi", - "section": "def-common.ReferenceLineLayerArgs", - "text": "ReferenceLineLayerArgs" + "section": "def-common.ReferenceLineLayerConfigResult", + "text": "ReferenceLineLayerConfigResult" }, " | ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AnnotationLayerArgs", - "text": "AnnotationLayerArgs" - } + "ExtendedAnnotationLayerConfigResult" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, @@ -1898,35 +2303,29 @@ }, { "parentPluginId": "expressionXY", - "id": "def-common.XYLayerConfigResult", + "id": "def-common.XYLayerArgs", "type": "Type", "tags": [], - "label": "XYLayerConfigResult", + "label": "XYLayerArgs", "description": [], "signature": [ { "pluginId": "expressionXY", "scope": "common", "docId": "kibExpressionXYPluginApi", - "section": "def-common.DataLayerConfigResult", - "text": "DataLayerConfigResult" + "section": "def-common.DataLayerArgs", + "text": "DataLayerArgs" }, " | ", { "pluginId": "expressionXY", "scope": "common", "docId": "kibExpressionXYPluginApi", - "section": "def-common.ReferenceLineLayerConfigResult", - "text": "ReferenceLineLayerConfigResult" + "section": "def-common.AnnotationLayerArgs", + "text": "AnnotationLayerArgs" }, " | ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AnnotationLayerConfigResult", - "text": "AnnotationLayerConfigResult" - } + "ReferenceLineArgs" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, @@ -1946,27 +2345,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "expressionXY", - "id": "def-common.YConfigResult", - "type": "Type", - "tags": [], - "label": "YConfigResult", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.YConfig", - "text": "YConfig" - }, - " & { type: \"yConfig\"; }" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "expressionXY", "id": "def-common.YScaleType", @@ -1982,4619 +2360,6 @@ "initialIsOpen": false } ], - "objects": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction", - "type": "Object", - "tags": [], - "label": "axisExtentConfigFunction", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "\"axisExtentConfig\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.aliases", - "type": "Array", - "tags": [], - "label": "aliases", - "description": [], - "signature": [ - "never[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"axisExtentConfig\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.inputTypes", - "type": "Array", - "tags": [], - "label": "inputTypes", - "description": [], - "signature": [ - "\"null\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.args", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.args.mode", - "type": "Object", - "tags": [], - "label": "mode", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.args.mode.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.args.mode.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"custom\" | \"full\" | \"dataBounds\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.args.mode.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.args.lowerBound", - "type": "Object", - "tags": [], - "label": "lowerBound", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.args.lowerBound.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"number\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.args.lowerBound.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.args.upperBound", - "type": "Object", - "tags": [], - "label": "upperBound", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.args.upperBound.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"number\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.args.upperBound.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.fn", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "(input: null, args: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AxisExtentConfig", - "text": "AxisExtentConfig" - }, - ") => { mode: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AxisExtentMode", - "text": "AxisExtentMode" - }, - "; lowerBound?: number | undefined; upperBound?: number | undefined; type: \"axisExtentConfig\"; }" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.fn.$1", - "type": "Uncategorized", - "tags": [], - "label": "input", - "description": [], - "signature": [ - "null" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisExtentConfigFunction.fn.$2", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AxisExtentConfig", - "text": "AxisExtentConfig" - } - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_extent_config.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction", - "type": "Object", - "tags": [], - "label": "axisTitlesVisibilityConfigFunction", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "\"axisTitlesVisibilityConfig\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.aliases", - "type": "Array", - "tags": [], - "label": "aliases", - "description": [], - "signature": [ - "never[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"axisTitlesVisibilityConfig\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.inputTypes", - "type": "Array", - "tags": [], - "label": "inputTypes", - "description": [], - "signature": [ - "\"null\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.args", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.args.x", - "type": "Object", - "tags": [], - "label": "x", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.args.x.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.args.x.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.args.yLeft", - "type": "Object", - "tags": [], - "label": "yLeft", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.args.yLeft.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.args.yLeft.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.args.yRight", - "type": "Object", - "tags": [], - "label": "yRight", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.args.yRight.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.args.yRight.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.fn", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "(inputn: null, args: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AxesSettingsConfig", - "text": "AxesSettingsConfig" - }, - ") => { x: boolean; yLeft: boolean; yRight: boolean; type: \"axisTitlesVisibilityConfig\"; }" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.fn.$1", - "type": "Uncategorized", - "tags": [], - "label": "inputn", - "description": [], - "signature": [ - "null" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.axisTitlesVisibilityConfigFunction.fn.$2", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AxesSettingsConfig", - "text": "AxesSettingsConfig" - } - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/axis_titles_visibility_config.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction", - "type": "Object", - "tags": [], - "label": "dataLayerConfigFunction", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "\"dataLayer\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.aliases", - "type": "Array", - "tags": [], - "label": "aliases", - "description": [], - "signature": [ - "never[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"dataLayer\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.inputTypes", - "type": "Array", - "tags": [], - "label": "inputTypes", - "description": [], - "signature": [ - "\"null\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.hide", - "type": "Object", - "tags": [], - "label": "hide", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.hide.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.hide.default", - "type": "boolean", - "tags": [], - "label": "default", - "description": [], - "signature": [ - "false" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.hide.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.layerId", - "type": "Object", - "tags": [], - "label": "layerId", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.layerId.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.layerId.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.xAccessor", - "type": "Object", - "tags": [], - "label": "xAccessor", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.xAccessor.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.xAccessor.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.seriesType", - "type": "Object", - "tags": [], - "label": "seriesType", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.seriesType.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.seriesType.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"area\" | \"line\" | \"bar\" | \"bar_stacked\" | \"area_stacked\" | \"bar_horizontal\" | \"bar_percentage_stacked\" | \"bar_horizontal_stacked\" | \"area_percentage_stacked\" | \"bar_horizontal_percentage_stacked\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.seriesType.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.xScaleType", - "type": "Object", - "tags": [], - "label": "xScaleType", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.xScaleType.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"time\" | \"linear\" | \"ordinal\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.xScaleType.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.xScaleType.default", - "type": "string", - "tags": [], - "label": "default", - "description": [], - "signature": [ - "\"ordinal\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.isHistogram", - "type": "Object", - "tags": [], - "label": "isHistogram", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.isHistogram.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.isHistogram.default", - "type": "boolean", - "tags": [], - "label": "default", - "description": [], - "signature": [ - "false" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.isHistogram.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.yScaleType", - "type": "Object", - "tags": [], - "label": "yScaleType", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.yScaleType.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"time\" | \"log\" | \"sqrt\" | \"linear\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.yScaleType.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.yScaleType.default", - "type": "string", - "tags": [], - "label": "default", - "description": [], - "signature": [ - "\"linear\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.splitAccessor", - "type": "Object", - "tags": [], - "label": "splitAccessor", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.splitAccessor.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.splitAccessor.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.accessors", - "type": "Object", - "tags": [], - "label": "accessors", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.accessors.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.accessors.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.accessors.multi", - "type": "boolean", - "tags": [], - "label": "multi", - "description": [], - "signature": [ - "true" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.yConfig", - "type": "Object", - "tags": [], - "label": "yConfig", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.yConfig.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"yConfig\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.yConfig.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.yConfig.multi", - "type": "boolean", - "tags": [], - "label": "multi", - "description": [], - "signature": [ - "true" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.columnToLabel", - "type": "Object", - "tags": [], - "label": "columnToLabel", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.columnToLabel.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.columnToLabel.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.palette", - "type": "Object", - "tags": [], - "label": "palette", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.palette.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "(\"system_palette\" | \"palette\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.palette.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.args.palette.default", - "type": "string", - "tags": [], - "label": "default", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.fn", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "(input: null, args: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.DataLayerArgs", - "text": "DataLayerArgs" - }, - ") => { layerType: \"data\"; layerId: string; accessors: string[]; seriesType: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.SeriesType", - "text": "SeriesType" - }, - "; xAccessor?: string | undefined; hide?: boolean | undefined; splitAccessor?: string | undefined; columnToLabel?: string | undefined; yScaleType: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.YScaleType", - "text": "YScaleType" - }, - "; xScaleType: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.XScaleType", - "text": "XScaleType" - }, - "; isHistogram: boolean; palette: ", - "PaletteOutput", - "<{ [key: string]: unknown; }>; yConfig?: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.YConfigResult", - "text": "YConfigResult" - }, - "[] | undefined; type: \"dataLayer\"; }" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.fn.$1", - "type": "Uncategorized", - "tags": [], - "label": "input", - "description": [], - "signature": [ - "null" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.dataLayerConfigFunction.fn.$2", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.DataLayerArgs", - "text": "DataLayerArgs" - } - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/data_layer_config.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction", - "type": "Object", - "tags": [], - "label": "gridlinesConfigFunction", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "\"gridlinesConfig\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.aliases", - "type": "Array", - "tags": [], - "label": "aliases", - "description": [], - "signature": [ - "never[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"gridlinesConfig\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.inputTypes", - "type": "Array", - "tags": [], - "label": "inputTypes", - "description": [], - "signature": [ - "\"null\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.args", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.args.x", - "type": "Object", - "tags": [], - "label": "x", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.args.x.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.args.x.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.args.yLeft", - "type": "Object", - "tags": [], - "label": "yLeft", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.args.yLeft.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.args.yLeft.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.args.yRight", - "type": "Object", - "tags": [], - "label": "yRight", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.args.yRight.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.args.yRight.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.fn", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "(input: null, args: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AxesSettingsConfig", - "text": "AxesSettingsConfig" - }, - ") => { x: boolean; yLeft: boolean; yRight: boolean; type: \"gridlinesConfig\"; }" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.fn.$1", - "type": "Uncategorized", - "tags": [], - "label": "input", - "description": [], - "signature": [ - "null" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.gridlinesConfigFunction.fn.$2", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AxesSettingsConfig", - "text": "AxesSettingsConfig" - } - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/grid_lines_config.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction", - "type": "Object", - "tags": [], - "label": "labelsOrientationConfigFunction", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "\"labelsOrientationConfig\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.aliases", - "type": "Array", - "tags": [], - "label": "aliases", - "description": [], - "signature": [ - "never[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"labelsOrientationConfig\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.inputTypes", - "type": "Array", - "tags": [], - "label": "inputTypes", - "description": [], - "signature": [ - "\"null\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.args", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.args.x", - "type": "Object", - "tags": [], - "label": "x", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.args.x.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"number\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.args.x.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "number[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.args.x.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.args.yLeft", - "type": "Object", - "tags": [], - "label": "yLeft", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.args.yLeft.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"number\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.args.yLeft.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "number[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.args.yLeft.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.args.yRight", - "type": "Object", - "tags": [], - "label": "yRight", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.args.yRight.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"number\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.args.yRight.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "number[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.args.yRight.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.fn", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "(input: null, args: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LabelsOrientationConfig", - "text": "LabelsOrientationConfig" - }, - ") => { x: number; yLeft: number; yRight: number; type: \"labelsOrientationConfig\"; }" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.fn.$1", - "type": "Uncategorized", - "tags": [], - "label": "input", - "description": [], - "signature": [ - "null" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.labelsOrientationConfigFunction.fn.$2", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LabelsOrientationConfig", - "text": "LabelsOrientationConfig" - } - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/labels_orientation_config.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction", - "type": "Object", - "tags": [], - "label": "legendConfigFunction", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "\"legendConfig\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.aliases", - "type": "Array", - "tags": [], - "label": "aliases", - "description": [], - "signature": [ - "never[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"legendConfig\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.inputTypes", - "type": "Array", - "tags": [], - "label": "inputTypes", - "description": [], - "signature": [ - "\"null\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.isVisible", - "type": "Object", - "tags": [], - "label": "isVisible", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.isVisible.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.isVisible.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.position", - "type": "Object", - "tags": [], - "label": "position", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.position.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.position.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"top\" | \"bottom\" | \"left\" | \"right\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.position.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.showSingleSeries", - "type": "Object", - "tags": [], - "label": "showSingleSeries", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.showSingleSeries.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.showSingleSeries.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.isInside", - "type": "Object", - "tags": [], - "label": "isInside", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.isInside.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.isInside.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.horizontalAlignment", - "type": "Object", - "tags": [], - "label": "horizontalAlignment", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.horizontalAlignment.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.horizontalAlignment.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"left\" | \"right\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.horizontalAlignment.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.verticalAlignment", - "type": "Object", - "tags": [], - "label": "verticalAlignment", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.verticalAlignment.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.verticalAlignment.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"top\" | \"bottom\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.verticalAlignment.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.floatingColumns", - "type": "Object", - "tags": [], - "label": "floatingColumns", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.floatingColumns.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"number\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.floatingColumns.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.maxLines", - "type": "Object", - "tags": [], - "label": "maxLines", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.maxLines.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"number\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.maxLines.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.shouldTruncate", - "type": "Object", - "tags": [], - "label": "shouldTruncate", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.shouldTruncate.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.shouldTruncate.default", - "type": "boolean", - "tags": [], - "label": "default", - "description": [], - "signature": [ - "true" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.shouldTruncate.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.legendSize", - "type": "Object", - "tags": [], - "label": "legendSize", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.legendSize.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"number\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.args.legendSize.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.fn", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "(input: null, args: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LegendConfig", - "text": "LegendConfig" - }, - ") => { isVisible: boolean; position: ", - "Position", - "; showSingleSeries?: boolean | undefined; isInside?: boolean | undefined; horizontalAlignment?: ", - "HorizontalAlignment", - " | undefined; verticalAlignment?: ", - "VerticalAlignment", - " | undefined; floatingColumns?: number | undefined; maxLines?: number | undefined; shouldTruncate?: boolean | undefined; legendSize?: number | undefined; type: \"legendConfig\"; }" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.fn.$1", - "type": "Uncategorized", - "tags": [], - "label": "input", - "description": [], - "signature": [ - "null" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.legendConfigFunction.fn.$2", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LegendConfig", - "text": "LegendConfig" - } - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/legend_config.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction", - "type": "Object", - "tags": [], - "label": "referenceLineLayerConfigFunction", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "\"referenceLineLayer\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.aliases", - "type": "Array", - "tags": [], - "label": "aliases", - "description": [], - "signature": [ - "never[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"referenceLineLayer\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.inputTypes", - "type": "Array", - "tags": [], - "label": "inputTypes", - "description": [], - "signature": [ - "\"null\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args.layerId", - "type": "Object", - "tags": [], - "label": "layerId", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args.layerId.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args.layerId.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args.accessors", - "type": "Object", - "tags": [], - "label": "accessors", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args.accessors.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args.accessors.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args.accessors.multi", - "type": "boolean", - "tags": [], - "label": "multi", - "description": [], - "signature": [ - "true" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args.yConfig", - "type": "Object", - "tags": [], - "label": "yConfig", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args.yConfig.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"yConfig\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args.yConfig.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args.yConfig.multi", - "type": "boolean", - "tags": [], - "label": "multi", - "description": [], - "signature": [ - "true" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args.columnToLabel", - "type": "Object", - "tags": [], - "label": "columnToLabel", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args.columnToLabel.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.args.columnToLabel.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.fn", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "(input: null, args: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.ReferenceLineLayerArgs", - "text": "ReferenceLineLayerArgs" - }, - ") => { layerType: \"referenceLine\"; layerId: string; accessors: string[]; columnToLabel?: string | undefined; yConfig?: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.YConfigResult", - "text": "YConfigResult" - }, - "[] | undefined; type: \"referenceLineLayer\"; }" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.fn.$1", - "type": "Uncategorized", - "tags": [], - "label": "input", - "description": [], - "signature": [ - "null" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.referenceLineLayerConfigFunction.fn.$2", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.ReferenceLineLayerArgs", - "text": "ReferenceLineLayerArgs" - } - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/reference_line_layer_config.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction", - "type": "Object", - "tags": [], - "label": "tickLabelsConfigFunction", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "\"tickLabelsConfig\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.aliases", - "type": "Array", - "tags": [], - "label": "aliases", - "description": [], - "signature": [ - "never[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"tickLabelsConfig\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.inputTypes", - "type": "Array", - "tags": [], - "label": "inputTypes", - "description": [], - "signature": [ - "\"null\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.args", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.args.x", - "type": "Object", - "tags": [], - "label": "x", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.args.x.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.args.x.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.args.yLeft", - "type": "Object", - "tags": [], - "label": "yLeft", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.args.yLeft.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.args.yLeft.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.args.yRight", - "type": "Object", - "tags": [], - "label": "yRight", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.args.yRight.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.args.yRight.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.fn", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "(input: null, args: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AxesSettingsConfig", - "text": "AxesSettingsConfig" - }, - ") => { x: boolean; yLeft: boolean; yRight: boolean; type: \"tickLabelsConfig\"; }" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.fn.$1", - "type": "Uncategorized", - "tags": [], - "label": "input", - "description": [], - "signature": [ - "null" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.tickLabelsConfigFunction.fn.$2", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AxesSettingsConfig", - "text": "AxesSettingsConfig" - } - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/tick_labels_config.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction", - "type": "Object", - "tags": [], - "label": "xyVisFunction", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "\"xyVis\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"render\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.inputTypes", - "type": "Array", - "tags": [], - "label": "inputTypes", - "description": [], - "signature": [ - "\"lens_multitable\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.title", - "type": "Object", - "tags": [], - "label": "title", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.title.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.title.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.description", - "type": "Object", - "tags": [], - "label": "description", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.description.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.description.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.xTitle", - "type": "Object", - "tags": [], - "label": "xTitle", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.xTitle.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.xTitle.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.yTitle", - "type": "Object", - "tags": [], - "label": "yTitle", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.yTitle.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.yTitle.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.yRightTitle", - "type": "Object", - "tags": [], - "label": "yRightTitle", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.yRightTitle.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.yRightTitle.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.yLeftExtent", - "type": "Object", - "tags": [], - "label": "yLeftExtent", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.yLeftExtent.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"axisExtentConfig\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.yLeftExtent.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.yRightExtent", - "type": "Object", - "tags": [], - "label": "yRightExtent", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.yRightExtent.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"axisExtentConfig\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.yRightExtent.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.legend", - "type": "Object", - "tags": [], - "label": "legend", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.legend.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"legendConfig\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.legend.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.fittingFunction", - "type": "Object", - "tags": [], - "label": "fittingFunction", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.fittingFunction.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.fittingFunction.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"None\" | \"Zero\" | \"Linear\" | \"Carry\" | \"Lookahead\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.fittingFunction.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.endValue", - "type": "Object", - "tags": [], - "label": "endValue", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.endValue.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.endValue.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"None\" | \"Zero\" | \"Nearest\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.endValue.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.emphasizeFitting", - "type": "Object", - "tags": [], - "label": "emphasizeFitting", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.emphasizeFitting.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.emphasizeFitting.default", - "type": "boolean", - "tags": [], - "label": "default", - "description": [], - "signature": [ - "false" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.emphasizeFitting.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.valueLabels", - "type": "Object", - "tags": [], - "label": "valueLabels", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.valueLabels.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.valueLabels.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"hide\" | \"inside\" | \"outside\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.valueLabels.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.tickLabelsVisibilitySettings", - "type": "Object", - "tags": [], - "label": "tickLabelsVisibilitySettings", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.tickLabelsVisibilitySettings.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"tickLabelsConfig\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.tickLabelsVisibilitySettings.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.labelsOrientation", - "type": "Object", - "tags": [], - "label": "labelsOrientation", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.labelsOrientation.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"labelsOrientationConfig\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.labelsOrientation.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.gridlinesVisibilitySettings", - "type": "Object", - "tags": [], - "label": "gridlinesVisibilitySettings", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.gridlinesVisibilitySettings.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"gridlinesConfig\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.gridlinesVisibilitySettings.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.axisTitlesVisibilitySettings", - "type": "Object", - "tags": [], - "label": "axisTitlesVisibilitySettings", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.axisTitlesVisibilitySettings.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"axisTitlesVisibilityConfig\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.axisTitlesVisibilitySettings.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.layers", - "type": "Object", - "tags": [], - "label": "layers", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.layers.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "(\"dataLayer\" | \"referenceLineLayer\" | \"annotationLayer\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.layers.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.layers.multi", - "type": "boolean", - "tags": [], - "label": "multi", - "description": [], - "signature": [ - "true" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.curveType", - "type": "Object", - "tags": [], - "label": "curveType", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.curveType.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.curveType.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"LINEAR\" | \"CURVE_MONOTONE_X\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.curveType.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.fillOpacity", - "type": "Object", - "tags": [], - "label": "fillOpacity", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.fillOpacity.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"number\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.fillOpacity.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.hideEndzones", - "type": "Object", - "tags": [], - "label": "hideEndzones", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.hideEndzones.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.hideEndzones.default", - "type": "boolean", - "tags": [], - "label": "default", - "description": [], - "signature": [ - "false" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.hideEndzones.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.valuesInLegend", - "type": "Object", - "tags": [], - "label": "valuesInLegend", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.valuesInLegend.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.valuesInLegend.default", - "type": "boolean", - "tags": [], - "label": "default", - "description": [], - "signature": [ - "false" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.valuesInLegend.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.ariaLabel", - "type": "Object", - "tags": [], - "label": "ariaLabel", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.ariaLabel.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.ariaLabel.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.args.ariaLabel.required", - "type": "boolean", - "tags": [], - "label": "required", - "description": [], - "signature": [ - "false" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.fn", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "(data: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LensMultiTable", - "text": "LensMultiTable" - }, - ", args: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.XYArgs", - "text": "XYArgs" - }, - ", handlers: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableRecord", - ">) => { type: \"render\"; as: \"xyVis\"; value: { data: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LensMultiTable", - "text": "LensMultiTable" - }, - "; args: { ariaLabel: string; title?: string | undefined; description?: string | undefined; xTitle: string; yTitle: string; yRightTitle: string; yLeftExtent: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AxisExtentConfigResult", - "text": "AxisExtentConfigResult" - }, - "; yRightExtent: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AxisExtentConfigResult", - "text": "AxisExtentConfigResult" - }, - "; legend: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LegendConfigResult", - "text": "LegendConfigResult" - }, - "; valueLabels: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.ValueLabelMode", - "text": "ValueLabelMode" - }, - "; layers: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.XYLayerConfigResult", - "text": "XYLayerConfigResult" - }, - "[]; endValue?: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.EndValue", - "text": "EndValue" - }, - " | undefined; emphasizeFitting?: boolean | undefined; fittingFunction?: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.FittingFunction", - "text": "FittingFunction" - }, - " | undefined; axisTitlesVisibilitySettings?: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.AxisTitlesVisibilityConfigResult", - "text": "AxisTitlesVisibilityConfigResult" - }, - " | undefined; tickLabelsVisibilitySettings?: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.TickLabelsConfigResult", - "text": "TickLabelsConfigResult" - }, - " | undefined; gridlinesVisibilitySettings?: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.GridlinesConfigResult", - "text": "GridlinesConfigResult" - }, - " | undefined; labelsOrientation?: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LabelsOrientationConfigResult", - "text": "LabelsOrientationConfigResult" - }, - " | undefined; curveType?: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.XYCurveType", - "text": "XYCurveType" - }, - " | undefined; fillOpacity?: number | undefined; hideEndzones?: boolean | undefined; valuesInLegend?: boolean | undefined; }; }; }" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.fn.$1", - "type": "Object", - "tags": [], - "label": "data", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LensMultiTable", - "text": "LensMultiTable" - } - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.fn.$2", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.XYArgs", - "text": "XYArgs" - } - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.xyVisFunction.fn.$3", - "type": "Object", - "tags": [], - "label": "handlers", - "description": [], - "signature": [ - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.ExecutionContext", - "text": "ExecutionContext" - }, - "<", - { - "pluginId": "inspector", - "scope": "common", - "docId": "kibInspectorPluginApi", - "section": "def-common.Adapters", - "text": "Adapters" - }, - ", ", - "SerializableRecord", - ">" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/xy_vis.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction", - "type": "Object", - "tags": [], - "label": "yAxisConfigFunction", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "\"yConfig\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.aliases", - "type": "Array", - "tags": [], - "label": "aliases", - "description": [], - "signature": [ - "never[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"yConfig\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.inputTypes", - "type": "Array", - "tags": [], - "label": "inputTypes", - "description": [], - "signature": [ - "\"null\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.forAccessor", - "type": "Object", - "tags": [], - "label": "forAccessor", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.forAccessor.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.forAccessor.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.axisMode", - "type": "Object", - "tags": [], - "label": "axisMode", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.axisMode.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.axisMode.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"bottom\" | \"left\" | \"right\" | \"auto\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.axisMode.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.color", - "type": "Object", - "tags": [], - "label": "color", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.color.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.color.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.lineStyle", - "type": "Object", - "tags": [], - "label": "lineStyle", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.lineStyle.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.lineStyle.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"solid\" | \"dashed\" | \"dotted\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.lineStyle.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.lineWidth", - "type": "Object", - "tags": [], - "label": "lineWidth", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.lineWidth.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"number\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.lineWidth.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.icon", - "type": "Object", - "tags": [], - "label": "icon", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.icon.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.icon.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.iconPosition", - "type": "Object", - "tags": [], - "label": "iconPosition", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.iconPosition.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.iconPosition.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"above\" | \"below\" | \"left\" | \"right\" | \"auto\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.iconPosition.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.textVisibility", - "type": "Object", - "tags": [], - "label": "textVisibility", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.textVisibility.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"boolean\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.textVisibility.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.fill", - "type": "Object", - "tags": [], - "label": "fill", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.fill.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [], - "signature": [ - "\"string\"[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.fill.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "(\"above\" | \"below\" | \"none\")[]" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.args.fill.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false - } - ] - } - ] - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.fn", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "(input: null, args: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.YConfig", - "text": "YConfig" - }, - ") => { forAccessor: string; axisMode?: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.YAxisMode", - "text": "YAxisMode" - }, - " | undefined; color?: string | undefined; icon?: string | undefined; lineWidth?: number | undefined; lineStyle?: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LineStyle", - "text": "LineStyle" - }, - " | undefined; fill?: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.FillStyle", - "text": "FillStyle" - }, - " | undefined; iconPosition?: ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.IconPosition", - "text": "IconPosition" - }, - " | undefined; textVisibility?: boolean | undefined; type: \"yConfig\"; }" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.fn.$1", - "type": "Uncategorized", - "tags": [], - "label": "input", - "description": [], - "signature": [ - "null" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "expressionXY", - "id": "def-common.yAxisConfigFunction.fn.$2", - "type": "Object", - "tags": [], - "label": "args", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.YConfig", - "text": "YConfig" - } - ], - "path": "src/plugins/chart_expressions/expression_xy/common/expression_functions/y_axis_config.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ] + "objects": [] } } \ No newline at end of file diff --git a/api_docs/expression_x_y.mdx b/api_docs/expression_x_y.mdx index 90fa5545dffd1..82084906cd0b2 100644 --- a/api_docs/expression_x_y.mdx +++ b/api_docs/expression_x_y.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionXY title: "expressionXY" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressionXY plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 473 | 0 | 463 | 0 | +| 143 | 0 | 133 | 14 | ## Client @@ -32,12 +32,6 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) ## Common -### Objects - - -### Functions - - ### Interfaces diff --git a/api_docs/expressions.devdocs.json b/api_docs/expressions.devdocs.json index 193a9d90ba337..4650ac90f934e 100644 --- a/api_docs/expressions.devdocs.json +++ b/api_docs/expressions.devdocs.json @@ -2140,6 +2140,18 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionFunction.deprecated", + "type": "boolean", + "tags": [], + "label": "deprecated", + "description": [ + "\nDeprecation flag." + ], + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunction.telemetry", @@ -2547,6 +2559,16 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionFunctionParameter.deprecated", + "type": "boolean", + "tags": [], + "label": "deprecated", + "description": [], + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionParameter.multi", @@ -3506,7 +3528,7 @@ "id": "def-public.ExpressionRenderHandler.Unnamed.$2", "type": "Object", "tags": [], - "label": "{\n onRenderError,\n renderMode,\n syncColors,\n interactive,\n hasCompatibleActions = async () => false,\n }", + "label": "{\n onRenderError,\n renderMode,\n syncColors,\n syncTooltips,\n interactive,\n hasCompatibleActions = async () => false,\n }", "description": [], "signature": [ "ExpressionRenderHandlerParams" @@ -6090,18 +6112,18 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - "[] | FunctionArgs[K] | ", + " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - " | ", + "[] | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", @@ -6168,18 +6190,18 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - "[] | FunctionArgs[K] | ", + " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - " | ", + "[] | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", @@ -6715,6 +6737,23 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "expressions", + "id": "def-public.ExecutionContext.isSyncTooltipsEnabled", + "type": "Function", + "tags": [], + "label": "isSyncTooltipsEnabled", + "description": [ + "\nReturns the state (true|false) of the sync tooltips across panels switch." + ], + "signature": [ + "(() => boolean) | undefined" + ], + "path": "src/plugins/expressions/common/execution/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "expressions", "id": "def-public.ExecutionContext.getExecutionContext", @@ -7672,6 +7711,21 @@ "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-public.ExpressionFunctionDefinition.deprecated", + "type": "CompoundType", + "tags": [], + "label": "deprecated", + "description": [ + "\nThe flag to mark the function as deprecated." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-public.ExpressionFunctionDefinition.disabled", @@ -10046,6 +10100,19 @@ "path": "src/plugins/expressions/public/types/index.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-public.IExpressionLoaderParams.syncTooltips", + "type": "CompoundType", + "tags": [], + "label": "syncTooltips", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/expressions/public/types/index.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-public.IExpressionLoaderParams.hasCompatibleActions", @@ -10375,6 +10442,21 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "expressions", + "id": "def-public.IInterpreterRenderHandlers.isSyncTooltipsEnabled", + "type": "Function", + "tags": [], + "label": "isSyncTooltipsEnabled", + "description": [], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "expressions", "id": "def-public.IInterpreterRenderHandlers.uiState", @@ -14286,6 +14368,18 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-server.ExpressionFunction.deprecated", + "type": "boolean", + "tags": [], + "label": "deprecated", + "description": [ + "\nDeprecation flag." + ], + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunction.telemetry", @@ -14693,6 +14787,16 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-server.ExpressionFunctionParameter.deprecated", + "type": "boolean", + "tags": [], + "label": "deprecated", + "description": [], + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionParameter.multi", @@ -16429,18 +16533,18 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - "[] | FunctionArgs[K] | ", + " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - " | ", + "[] | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", @@ -16507,18 +16611,18 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - "[] | FunctionArgs[K] | ", + " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - " | ", + "[] | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", @@ -17093,6 +17197,23 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "expressions", + "id": "def-server.ExecutionContext.isSyncTooltipsEnabled", + "type": "Function", + "tags": [], + "label": "isSyncTooltipsEnabled", + "description": [ + "\nReturns the state (true|false) of the sync tooltips across panels switch." + ], + "signature": [ + "(() => boolean) | undefined" + ], + "path": "src/plugins/expressions/common/execution/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "expressions", "id": "def-server.ExecutionContext.getExecutionContext", @@ -18021,6 +18142,21 @@ "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-server.ExpressionFunctionDefinition.deprecated", + "type": "CompoundType", + "tags": [], + "label": "deprecated", + "description": [ + "\nThe flag to mark the function as deprecated." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-server.ExpressionFunctionDefinition.disabled", @@ -19528,6 +19664,21 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "expressions", + "id": "def-server.IInterpreterRenderHandlers.isSyncTooltipsEnabled", + "type": "Function", + "tags": [], + "label": "isSyncTooltipsEnabled", + "description": [], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "expressions", "id": "def-server.IInterpreterRenderHandlers.uiState", @@ -22804,6 +22955,18 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionFunction.deprecated", + "type": "boolean", + "tags": [], + "label": "deprecated", + "description": [ + "\nDeprecation flag." + ], + "path": "src/plugins/expressions/common/expression_functions/expression_function.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunction.telemetry", @@ -23211,6 +23374,16 @@ "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionFunctionParameter.deprecated", + "type": "boolean", + "tags": [], + "label": "deprecated", + "description": [], + "path": "src/plugins/expressions/common/expression_functions/expression_function_parameter.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionParameter.multi", @@ -26066,18 +26239,18 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - "[] | FunctionArgs[K] | ", + " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - " | ", + "[] | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", @@ -26144,18 +26317,18 @@ "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpression", - "text": "ExpressionAstExpression" + "section": "def-common.ExpressionAstExpressionBuilder", + "text": "ExpressionAstExpressionBuilder" }, - "[] | FunctionArgs[K] | ", + " | ", { "pluginId": "expressions", "scope": "common", "docId": "kibExpressionsPluginApi", - "section": "def-common.ExpressionAstExpressionBuilder", - "text": "ExpressionAstExpressionBuilder" + "section": "def-common.ExpressionAstExpression", + "text": "ExpressionAstExpression" }, - " | ", + "[] | FunctionArgs[K] | ", { "pluginId": "expressions", "scope": "common", @@ -28121,6 +28294,23 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "expressions", + "id": "def-common.ExecutionContext.isSyncTooltipsEnabled", + "type": "Function", + "tags": [], + "label": "isSyncTooltipsEnabled", + "description": [ + "\nReturns the state (true|false) of the sync tooltips across panels switch." + ], + "signature": [ + "(() => boolean) | undefined" + ], + "path": "src/plugins/expressions/common/execution/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "expressions", "id": "def-common.ExecutionContext.getExecutionContext", @@ -29657,6 +29847,19 @@ "path": "src/plugins/expressions/common/service/expressions_services.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionExecutionParams.syncTooltips", + "type": "CompoundType", + "tags": [], + "label": "syncTooltips", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/expressions/common/service/expressions_services.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-common.ExpressionExecutionParams.inspectorAdapters", @@ -29760,6 +29963,21 @@ "path": "src/plugins/expressions/common/expression_functions/types.ts", "deprecated": false }, + { + "parentPluginId": "expressions", + "id": "def-common.ExpressionFunctionDefinition.deprecated", + "type": "CompoundType", + "tags": [], + "label": "deprecated", + "description": [ + "\nThe flag to mark the function as deprecated." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/expressions/common/expression_functions/types.ts", + "deprecated": false + }, { "parentPluginId": "expressions", "id": "def-common.ExpressionFunctionDefinition.disabled", @@ -32575,6 +32793,21 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "expressions", + "id": "def-common.IInterpreterRenderHandlers.isSyncTooltipsEnabled", + "type": "Function", + "tags": [], + "label": "isSyncTooltipsEnabled", + "description": [], + "signature": [ + "() => boolean" + ], + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "expressions", "id": "def-common.IInterpreterRenderHandlers.uiState", @@ -40462,6 +40695,20 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "expressions", + "id": "def-common.PointSeriesColumnNames", + "type": "Object", + "tags": [], + "label": "PointSeriesColumnNames", + "description": [], + "signature": [ + "{ readonly X: \"x\"; readonly Y: \"y\"; readonly COLOR: \"color\"; readonly SIZE: \"size\"; readonly TEXT: \"text\"; }" + ], + "path": "src/plugins/expressions/common/expression_types/specs/pointseries.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "expressions", "id": "def-common.pureSelectors", diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index 48f344a1fc219..589244ab069cc 100644 --- a/api_docs/expressions.mdx +++ b/api_docs/expressions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressions title: "expressions" image: https://source.unsplash.com/400x175/?github summary: API docs for the expressions plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 2158 | 17 | 1713 | 5 | +| 2176 | 17 | 1722 | 5 | ## Client diff --git a/api_docs/features.devdocs.json b/api_docs/features.devdocs.json index c0459cd78c0a6..9f5f3763eec92 100644 --- a/api_docs/features.devdocs.json +++ b/api_docs/features.devdocs.json @@ -320,15 +320,15 @@ "references": [ { "plugin": "security", - "path": "x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts" + "path": "x-pack/plugins/security/server/lib/role_utils.ts" }, { "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts" + "path": "x-pack/plugins/security/server/lib/role_utils.ts" }, { "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts" + "path": "x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts" }, { "plugin": "security", @@ -1554,15 +1554,15 @@ "references": [ { "plugin": "security", - "path": "x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts" + "path": "x-pack/plugins/security/server/lib/role_utils.ts" }, { "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts" + "path": "x-pack/plugins/security/server/lib/role_utils.ts" }, { "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts" + "path": "x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts" }, { "plugin": "security", @@ -3254,15 +3254,15 @@ "references": [ { "plugin": "security", - "path": "x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts" + "path": "x-pack/plugins/security/server/lib/role_utils.ts" }, { "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts" + "path": "x-pack/plugins/security/server/lib/role_utils.ts" }, { "plugin": "security", - "path": "x-pack/plugins/security/server/routes/authorization/roles/model/put_payload.ts" + "path": "x-pack/plugins/security/server/authorization/roles/elasticsearch_role.ts" }, { "plugin": "security", diff --git a/api_docs/features.mdx b/api_docs/features.mdx index 27dc3a6e8652a..5b2e5c980f209 100644 --- a/api_docs/features.mdx +++ b/api_docs/features.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/features title: "features" image: https://source.unsplash.com/400x175/?github summary: API docs for the features plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/field_formats.devdocs.json b/api_docs/field_formats.devdocs.json index fbe312ee376af..c95d19bc0e365 100644 --- a/api_docs/field_formats.devdocs.json +++ b/api_docs/field_formats.devdocs.json @@ -485,7 +485,7 @@ "label": "textConvert", "description": [], "signature": [ - "(val: string | number) => any" + "(val: string | number, options?: { timezone?: string | undefined; } | undefined) => any" ], "path": "src/plugins/field_formats/server/lib/converters/date_server.ts", "deprecated": false, @@ -503,6 +503,31 @@ "path": "src/plugins/field_formats/server/lib/converters/date_server.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "fieldFormats", + "id": "def-server.DateFormat.textConvert.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "src/plugins/field_formats/server/lib/converters/date_server.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fieldFormats", + "id": "def-server.DateFormat.textConvert.$2.timezone", + "type": "string", + "tags": [], + "label": "timezone", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/field_formats/server/lib/converters/date_server.ts", + "deprecated": false + } + ] } ], "returnComment": [] @@ -533,7 +558,7 @@ "label": "textConvert", "description": [], "signature": [ - "(val: string | number) => any" + "(val: string | number, options?: { timezone?: string | undefined; } | undefined) => any" ], "path": "src/plugins/field_formats/server/lib/converters/date_nanos_server.ts", "deprecated": false, @@ -551,6 +576,31 @@ "path": "src/plugins/field_formats/server/lib/converters/date_nanos_server.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "fieldFormats", + "id": "def-server.DateNanosFormatServer.textConvert.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "src/plugins/field_formats/server/lib/converters/date_nanos_server.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fieldFormats", + "id": "def-server.DateNanosFormatServer.textConvert.$2.timezone", + "type": "string", + "tags": [], + "label": "timezone", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/field_formats/server/lib/converters/date_nanos_server.ts", + "deprecated": false + } + ] } ], "returnComment": [] diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index c425ca2c5924c..d41029a5f0ff3 100644 --- a/api_docs/field_formats.mdx +++ b/api_docs/field_formats.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fieldFormats title: "fieldFormats" image: https://source.unsplash.com/400x175/?github summary: API docs for the fieldFormats plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 286 | 6 | 247 | 3 | +| 290 | 6 | 251 | 3 | ## Client diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx index 670175e6463d6..909343c10aae3 100644 --- a/api_docs/file_upload.mdx +++ b/api_docs/file_upload.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fileUpload title: "fileUpload" image: https://source.unsplash.com/400x175/?github summary: API docs for the fileUpload plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/fleet.devdocs.json b/api_docs/fleet.devdocs.json index 530b55d549f63..32ba33ff902a6 100644 --- a/api_docs/fleet.devdocs.json +++ b/api_docs/fleet.devdocs.json @@ -2062,7 +2062,7 @@ "tags": [], "label": "integration_policy_upgrade", "description": [ - "// Upgrades happen on the same edit form, just with a flag set. Separate page record here\n// allows us to set different breadcrumbds for upgrades when needed." + "// Upgrades happen on the same edit form, just with a flag set. Separate page record here\n// allows us to set different breadcrumbs for upgrades when needed." ], "signature": [ "({ packagePolicyId }: ", @@ -2159,7 +2159,7 @@ "label": "add_integration_to_policy", "description": [], "signature": [ - "({ pkgkey, integration, agentPolicyId }: ", + "({ pkgkey, integration, agentPolicyId, useMultiPageLayout }: ", "DynamicPagePathValues", ") => [string, string]" ], @@ -2171,7 +2171,7 @@ "id": "def-public.pagePathGetters.add_integration_to_policy.$1", "type": "Object", "tags": [], - "label": "{ pkgkey, integration, agentPolicyId }", + "label": "{ pkgkey, integration, agentPolicyId, useMultiPageLayout }", "description": [], "signature": [ "DynamicPagePathValues" @@ -8467,6 +8467,22 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.getExperimentalAllowedValues", + "type": "Function", + "tags": [], + "label": "getExperimentalAllowedValues", + "description": [], + "signature": [ + "() => string[]" + ], + "path": "x-pack/plugins/fleet/common/experimental_features.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.getMaxPackageName", @@ -8728,6 +8744,37 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.isValidExperimentalValue", + "type": "Function", + "tags": [], + "label": "isValidExperimentalValue", + "description": [], + "signature": [ + "(value: string) => boolean" + ], + "path": "x-pack/plugins/fleet/common/experimental_features.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.isValidExperimentalValue.$1", + "type": "string", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/common/experimental_features.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.isValidNamespace", @@ -8995,6 +9042,41 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.parseExperimentalConfigValue", + "type": "Function", + "tags": [ + "throws" + ], + "label": "parseExperimentalConfigValue", + "description": [ + "\nParses the string value used in `xpack.fleet.enableExperimental` kibana configuration,\nwhich should be a string of values delimited by a comma (`,`)\n" + ], + "signature": [ + "(configValue: string[]) => Readonly<{ createPackagePolicyMultiPageLayout: boolean; }>" + ], + "path": "x-pack/plugins/fleet/common/experimental_features.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.parseExperimentalConfigValue.$1", + "type": "Array", + "tags": [], + "label": "configValue", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/fleet/common/experimental_features.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.splitPkgKey", @@ -9419,7 +9501,7 @@ "label": "type", "description": [], "signature": [ - "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\"" + "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\" | \"CANCEL\"" ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false @@ -9460,16 +9542,6 @@ "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentAction.agent_id", - "type": "string", - "tags": [], - "label": "agent_id", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, { "parentPluginId": "fleet", "id": "def-common.AgentAction.created_at", @@ -9637,123 +9709,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentPolicyAction", - "type": "Interface", - "tags": [], - "label": "AgentPolicyAction", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentPolicyAction", - "text": "AgentPolicyAction" - }, - " extends ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewAgentAction", - "text": "NewAgentAction" - } - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.AgentPolicyAction.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentPolicyAction.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentPolicyAction.data", - "type": "Object", - "tags": [], - "label": "data", - "description": [], - "signature": [ - "{ policy: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicy", - "text": "FullAgentPolicy" - }, - "; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentPolicyAction.policy_id", - "type": "string", - "tags": [], - "label": "policy_id", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentPolicyAction.policy_revision", - "type": "number", - "tags": [], - "label": "policy_revision", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentPolicyAction.created_at", - "type": "string", - "tags": [], - "label": "created_at", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentPolicyAction.ack_data", - "type": "Any", - "tags": [], - "label": "ack_data", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "fleet", "id": "def-common.AgentSOAttributes", @@ -10397,6 +10352,79 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.CurrentUpgrade", + "type": "Interface", + "tags": [], + "label": "CurrentUpgrade", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.CurrentUpgrade.actionId", + "type": "string", + "tags": [], + "label": "actionId", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.CurrentUpgrade.complete", + "type": "boolean", + "tags": [], + "label": "complete", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.CurrentUpgrade.nbAgents", + "type": "number", + "tags": [], + "label": "nbAgents", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.CurrentUpgrade.nbAgentsAck", + "type": "number", + "tags": [], + "label": "nbAgentsAck", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.CurrentUpgrade.version", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.CurrentUpgrade.startTime", + "type": "string", + "tags": [], + "label": "startTime", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.DataStream", @@ -10965,19 +10993,6 @@ "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, - { - "parentPluginId": "fleet", - "id": "def-common.EpmPackageAdditions.removable", - "type": "CompoundType", - "tags": [], - "label": "removable", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, { "parentPluginId": "fleet", "id": "def-common.EpmPackageAdditions.notice", @@ -11224,6 +11239,19 @@ "path": "x-pack/plugins/fleet/common/types/index.ts", "deprecated": false }, + { + "parentPluginId": "fleet", + "id": "def-common.FleetConfigType.enableExperimental", + "type": "Array", + "tags": [], + "label": "enableExperimental", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/index.ts", + "deprecated": false + }, { "parentPluginId": "fleet", "id": "def-common.FleetConfigType.developer", @@ -11622,6 +11650,21 @@ ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FleetServerAgent.tags", + "type": "Array", + "tags": [], + "label": "tags", + "description": [ + "\nA list of tags used for organizing/filtering agents" + ], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false } ], "initialIsOpen": false @@ -11758,6 +11801,36 @@ "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false }, + { + "parentPluginId": "fleet", + "id": "def-common.FleetServerAgentAction.start_time", + "type": "string", + "tags": [], + "label": "start_time", + "description": [ + "\nDate when the agent should execute that agent. This field could be altered by Fleet server for progressive rollout of the action." + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FleetServerAgentAction.minimum_execution_duration", + "type": "number", + "tags": [], + "label": "minimum_execution_duration", + "description": [ + "\nMinimun execution duration in seconds, used for progressive rollout of the action." + ], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, { "parentPluginId": "fleet", "id": "def-common.FleetServerAgentAction.data", @@ -12793,22 +12866,55 @@ }, { "parentPluginId": "fleet", - "id": "def-common.GetCategoriesResponse.response", + "id": "def-common.GetCategoriesResponse.response", + "type": "Array", + "tags": [], + "label": "response", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.CategorySummaryList", + "text": "CategorySummaryList" + }, + " | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.GetCurrentUpgradesResponse", + "type": "Interface", + "tags": [], + "label": "GetCurrentUpgradesResponse", + "description": [], + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.GetCurrentUpgradesResponse.items", "type": "Array", "tags": [], - "label": "response", + "label": "items", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.CategorySummaryList", - "text": "CategorySummaryList" + "section": "def-common.CurrentUpgrade", + "text": "CurrentUpgrade" }, - " | undefined" + "[]" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", "deprecated": false } ], @@ -14058,7 +14164,7 @@ "label": "install_status", "description": [], "signature": [ - "\"installed\" | \"installing\" | \"install_failed\" | \"installed_bundled\"" + "\"installed\" | \"installing\" | \"install_failed\"" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false @@ -14650,7 +14756,7 @@ "label": "type", "description": [], "signature": [ - "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\"" + "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\" | \"CANCEL\"" ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false @@ -14668,6 +14774,19 @@ "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false }, + { + "parentPluginId": "fleet", + "id": "def-common.NewAgentAction.ack_data", + "type": "Any", + "tags": [], + "label": "ack_data", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, { "parentPluginId": "fleet", "id": "def-common.NewAgentAction.sent_at", @@ -14680,6 +14799,84 @@ ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.NewAgentAction.agents", + "type": "Array", + "tags": [], + "label": "agents", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.NewAgentAction.created_at", + "type": "string", + "tags": [], + "label": "created_at", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.NewAgentAction.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.NewAgentAction.expiration", + "type": "string", + "tags": [], + "label": "expiration", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.NewAgentAction.start_time", + "type": "string", + "tags": [], + "label": "start_time", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.NewAgentAction.minimum_execution_duration", + "type": "number", + "tags": [], + "label": "minimum_execution_duration", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false } ], "initialIsOpen": false @@ -16291,7 +16488,7 @@ "label": "body", "description": [], "signature": [ - "{ agents: string | string[]; source_uri?: string | undefined; version: string; }" + "{ agents: string | string[]; source_uri?: string | undefined; version: string; rollout_duration_seconds?: number | undefined; start_time?: string | undefined; }" ], "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", "deprecated": false @@ -16444,7 +16641,7 @@ "label": "body", "description": [], "signature": [ - "{ action: ", + "{ action: Omit<", { "pluginId": "fleet", "scope": "common", @@ -16452,7 +16649,7 @@ "section": "def-common.NewAgentAction", "text": "NewAgentAction" }, - "; }" + ", \"agents\">; }" ], "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", "deprecated": false @@ -17648,7 +17845,7 @@ "label": "[RegistryVarsEntryKeys.type]", "description": [], "signature": [ - "\"string\" | \"text\" | \"integer\" | \"yaml\" | \"bool\" | \"password\"" + "\"string\" | \"text\" | \"integer\" | \"yaml\" | \"password\" | \"bool\"" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false @@ -18640,20 +18837,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentActionSOAttributes", - "type": "Type", - "tags": [], - "label": "AgentActionSOAttributes", - "description": [], - "signature": [ - "CommonAgentActionSOAttributes & { agent_id: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "fleet", "id": "def-common.AgentActionType", @@ -18662,7 +18845,7 @@ "label": "AgentActionType", "description": [], "signature": [ - "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\"" + "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\" | \"CANCEL\"" ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false, @@ -18682,20 +18865,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentPolicyActionSOAttributes", - "type": "Type", - "tags": [], - "label": "AgentPolicyActionSOAttributes", - "description": [], - "signature": [ - "CommonAgentActionSOAttributes & { policy_id: string; policy_revision: number; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "fleet", "id": "def-common.AgentPolicySOAttributes", @@ -18712,7 +18881,7 @@ "section": "def-common.ValueOf", "text": "ValueOf" }, - "<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; description?: string | undefined; name: string; namespace: string; updated_at: string; updated_by: string; is_default?: boolean | undefined; is_default_fleet_server?: boolean | undefined; has_fleet_server?: boolean | undefined; is_managed: boolean; monitoring_enabled?: (\"metrics\" | \"logs\")[] | undefined; unenroll_timeout?: number | undefined; is_preconfigured?: boolean | undefined; data_output_id?: string | null | undefined; monitoring_output_id?: string | null | undefined; package_policies: string[] | ", + "<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; description?: string | undefined; name: string; updated_at: string; namespace: string; updated_by: string; is_default?: boolean | undefined; is_default_fleet_server?: boolean | undefined; has_fleet_server?: boolean | undefined; is_managed: boolean; monitoring_enabled?: (\"metrics\" | \"logs\")[] | undefined; unenroll_timeout?: number | undefined; is_preconfigured?: boolean | undefined; data_output_id?: string | null | undefined; monitoring_output_id?: string | null | undefined; package_policies: string[] | ", { "pluginId": "fleet", "scope": "common", @@ -19032,34 +19201,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "fleet", - "id": "def-common.BaseAgentActionSOAttributes", - "type": "Type", - "tags": [], - "label": "BaseAgentActionSOAttributes", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentActionSOAttributes", - "text": "AgentActionSOAttributes" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentPolicyActionSOAttributes", - "text": "AgentPolicyActionSOAttributes" - } - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "fleet", "id": "def-common.CategoryId", @@ -19351,7 +19492,7 @@ "label": "EpmPackageInstallStatus", "description": [], "signature": [ - "\"installed\" | \"installing\" | \"install_failed\" | \"installed_bundled\"" + "\"installed\" | \"installing\" | \"install_failed\"" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, @@ -19381,6 +19522,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.ExperimentalFeatures", + "type": "Type", + "tags": [], + "label": "ExperimentalFeatures", + "description": [], + "signature": [ + "{ readonly createPackagePolicyMultiPageLayout: boolean; }" + ], + "path": "x-pack/plugins/fleet/common/experimental_features.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.FLEET_APM_PACKAGE", @@ -19395,6 +19550,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.FLEET_CLOUD_SECURITY_POSTURE_PACKAGE", + "type": "string", + "tags": [], + "label": "FLEET_CLOUD_SECURITY_POSTURE_PACKAGE", + "description": [], + "signature": [ + "\"cloud_security_posture\"" + ], + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.FLEET_ELASTIC_AGENT_DETAILS_DASHBOARD_ID", @@ -19846,14 +20015,6 @@ "section": "def-common.InstallFailed", "text": "InstallFailed" }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.InstalledBundled", - "text": "InstalledBundled" - }, "" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -19896,21 +20057,7 @@ "label": "InstallationStatus", "description": [], "signature": [ - "{ readonly Installed: \"installed\"; readonly Installing: \"installing\"; readonly InstallFailed: \"install_failed\"; readonly NotInstalled: \"not_installed\"; readonly InstalledBundled: \"installed_bundled\"; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstalledBundled", - "type": "Type", - "tags": [], - "label": "InstalledBundled", - "description": [], - "signature": [ - "T & { status: \"installed_bundled\"; }" + "{ readonly Installed: \"installed\"; readonly Installing: \"installing\"; readonly InstallFailed: \"install_failed\"; readonly NotInstalled: \"not_installed\"; }" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, @@ -20222,6 +20369,14 @@ "section": "def-common.KibanaAssetParts", "text": "KibanaAssetParts" }, + "[]; osquery_saved_query: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" + }, "[]; }" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -20615,7 +20770,7 @@ "section": "def-common.PackagePolicyPackage", "text": "PackagePolicyPackage" }, - " | undefined; description?: string | undefined; name: string; enabled: boolean; namespace: string; updated_at: string; created_at: string; created_by: string; updated_by: string; inputs: ", + " | undefined; description?: string | undefined; name: string; enabled: boolean; updated_at: string; namespace: string; created_at: string; created_by: string; updated_by: string; inputs: ", { "pluginId": "fleet", "scope": "common", @@ -20720,14 +20875,6 @@ "section": "def-common.PackageList", "text": "PackageList" }, - "; installed_bundled: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageList", - "text": "PackageList" - }, "; }" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", @@ -20992,7 +21139,7 @@ "label": "RegistryVarType", "description": [], "signature": [ - "\"string\" | \"text\" | \"integer\" | \"yaml\" | \"bool\" | \"password\"" + "\"string\" | \"text\" | \"integer\" | \"yaml\" | \"password\" | \"bool\"" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, @@ -21382,6 +21529,16 @@ "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false }, + { + "parentPluginId": "fleet", + "id": "def-common.AGENT_API_ROUTES.CANCEL_ACTIONS_PATTERN", + "type": "string", + "tags": [], + "label": "CANCEL_ACTIONS_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, { "parentPluginId": "fleet", "id": "def-common.AGENT_API_ROUTES.UNENROLL_PATTERN", @@ -21473,6 +21630,16 @@ "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AGENT_API_ROUTES.CURRENT_UPGRADES_PATTERN", + "type": "string", + "tags": [], + "label": "CURRENT_UPGRADES_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false } ], "initialIsOpen": false @@ -22041,6 +22208,51 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getCurrentUpgradesPath", + "type": "Function", + "tags": [], + "label": "getCurrentUpgradesPath", + "description": [], + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getCancelActionPath", + "type": "Function", + "tags": [], + "label": "getCancelActionPath", + "description": [], + "signature": [ + "(actionId: string) => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getCancelActionPath.$1", + "type": "string", + "tags": [], + "label": "actionId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "fleet", "id": "def-common.agentRouteService.getListPath", @@ -22152,6 +22364,22 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-common.allowedExperimentalValues", + "type": "Object", + "tags": [], + "label": "allowedExperimentalValues", + "description": [ + "\nA list of allowed values that can be used in `xpack.fleet.enableExperimental`.\nThis object is then used to validate and parse the value entered." + ], + "signature": [ + "{ readonly createPackagePolicyMultiPageLayout: boolean; }" + ], + "path": "x-pack/plugins/fleet/common/experimental_features.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-common.APP_API_ROUTES", @@ -23096,7 +23324,7 @@ "label": "installationStatuses", "description": [], "signature": [ - "{ readonly Installed: \"installed\"; readonly Installing: \"installing\"; readonly InstallFailed: \"install_failed\"; readonly NotInstalled: \"not_installed\"; readonly InstalledBundled: \"installed_bundled\"; }" + "{ readonly Installed: \"installed\"; readonly Installing: \"installing\"; readonly InstallFailed: \"install_failed\"; readonly NotInstalled: \"not_installed\"; }" ], "path": "x-pack/plugins/fleet/common/constants/epm.ts", "deprecated": false, diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index 221ed6ae0e6e0..bf494b554b132 100644 --- a/api_docs/fleet.mdx +++ b/api_docs/fleet.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fleet title: "fleet" image: https://source.unsplash.com/400x175/?github summary: API docs for the fleet plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 1385 | 8 | 1268 | 10 | +| 1404 | 8 | 1282 | 10 | ## Client diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index 31f9aa31263a9..498822856f7b2 100644 --- a/api_docs/global_search.mdx +++ b/api_docs/global_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/globalSearch title: "globalSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the globalSearch plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/home.devdocs.json b/api_docs/home.devdocs.json index 516a1e6965511..587747c8fcfc9 100644 --- a/api_docs/home.devdocs.json +++ b/api_docs/home.devdocs.json @@ -1361,6 +1361,21 @@ ], "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "deprecated": false + }, + { + "parentPluginId": "home", + "id": "def-server.AppLinkData.order", + "type": "number", + "tags": [], + "label": "order", + "description": [ + "\nIndex of the links (ascending order, smallest will be displayed first).\nUsed for ordering in the dropdown.\n" + ], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", + "deprecated": false } ], "initialIsOpen": false diff --git a/api_docs/home.mdx b/api_docs/home.mdx index 2f65dcfe6a656..8bcc950a5fed8 100644 --- a/api_docs/home.mdx +++ b/api_docs/home.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/home title: "home" image: https://source.unsplash.com/400x175/?github summary: API docs for the home plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 140 | 0 | 102 | 0 | +| 141 | 0 | 102 | 0 | ## Client diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx index 3b508d1e26456..61200651e1703 100644 --- a/api_docs/index_lifecycle_management.mdx +++ b/api_docs/index_lifecycle_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement title: "indexLifecycleManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the indexLifecycleManagement plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx index 521963fb92b77..8ba811f087533 100644 --- a/api_docs/index_management.mdx +++ b/api_docs/index_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexManagement title: "indexManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the indexManagement plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/infra.devdocs.json b/api_docs/infra.devdocs.json index 958899c4c8def..89e54f8f5adbc 100644 --- a/api_docs/infra.devdocs.json +++ b/api_docs/infra.devdocs.json @@ -294,7 +294,145 @@ ], "initialIsOpen": false } - ] + ], + "start": { + "parentPluginId": "infra", + "id": "def-public.InfraClientStartExports", + "type": "Interface", + "tags": [], + "label": "InfraClientStartExports", + "description": [], + "path": "x-pack/plugins/infra/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "infra", + "id": "def-public.InfraClientStartExports.logViews", + "type": "Object", + "tags": [], + "label": "logViews", + "description": [], + "signature": [ + "LogViewsServiceStart" + ], + "path": "x-pack/plugins/infra/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "infra", + "id": "def-public.InfraClientStartExports.ContainerMetricsTable", + "type": "Function", + "tags": [], + "label": "ContainerMetricsTable", + "description": [], + "signature": [ + "(props: ", + "UseNodeMetricsTableOptions", + " & Partial<", + "SourceProviderProps", + ">) => JSX.Element" + ], + "path": "x-pack/plugins/infra/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "infra", + "id": "def-public.InfraClientStartExports.ContainerMetricsTable.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "UseNodeMetricsTableOptions", + " & Partial<", + "SourceProviderProps", + ">" + ], + "path": "x-pack/plugins/infra/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "infra", + "id": "def-public.InfraClientStartExports.HostMetricsTable", + "type": "Function", + "tags": [], + "label": "HostMetricsTable", + "description": [], + "signature": [ + "(props: ", + "UseNodeMetricsTableOptions", + " & Partial<", + "SourceProviderProps", + ">) => JSX.Element" + ], + "path": "x-pack/plugins/infra/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "infra", + "id": "def-public.InfraClientStartExports.HostMetricsTable.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "UseNodeMetricsTableOptions", + " & Partial<", + "SourceProviderProps", + ">" + ], + "path": "x-pack/plugins/infra/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "infra", + "id": "def-public.InfraClientStartExports.PodMetricsTable", + "type": "Function", + "tags": [], + "label": "PodMetricsTable", + "description": [], + "signature": [ + "(props: ", + "UseNodeMetricsTableOptions", + " & Partial<", + "SourceProviderProps", + ">) => JSX.Element" + ], + "path": "x-pack/plugins/infra/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "infra", + "id": "def-public.InfraClientStartExports.PodMetricsTable.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "UseNodeMetricsTableOptions", + " & Partial<", + "SourceProviderProps", + ">" + ], + "path": "x-pack/plugins/infra/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "lifecycle": "start", + "initialIsOpen": true + } }, "server": { "classes": [], @@ -468,6 +606,64 @@ ], "path": "x-pack/plugins/infra/server/types.ts", "deprecated": false + }, + { + "parentPluginId": "infra", + "id": "def-server.InfraPluginStart.getMetricIndices", + "type": "Function", + "tags": [], + "label": "getMetricIndices", + "description": [], + "signature": [ + "(savedObjectsClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + }, + ", sourceId?: string | undefined) => Promise" + ], + "path": "x-pack/plugins/infra/server/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "infra", + "id": "def-server.InfraPluginStart.getMetricIndices.$1", + "type": "Object", + "tags": [], + "label": "savedObjectsClient", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + } + ], + "path": "x-pack/plugins/infra/server/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "infra", + "id": "def-server.InfraPluginStart.getMetricIndices.$2", + "type": "string", + "tags": [], + "label": "sourceId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/infra/server/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] } ], "lifecycle": "start", diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index 599b5bd6cfcab..1df9391a1c7c3 100644 --- a/api_docs/infra.mdx +++ b/api_docs/infra.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/infra title: "infra" image: https://source.unsplash.com/400x175/?github summary: API docs for the infra plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,10 +18,13 @@ Contact [Logs and Metrics UI](https://github.com/orgs/elastic/teams/logs-metrics | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 31 | 0 | 28 | 5 | +| 42 | 0 | 39 | 8 | ## Client +### Start + + ### Objects diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index fff575d6b0e7c..67465c5389b79 100644 --- a/api_docs/inspector.mdx +++ b/api_docs/inspector.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/inspector title: "inspector" image: https://source.unsplash.com/400x175/?github summary: API docs for the inspector plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/interactive_setup.mdx b/api_docs/interactive_setup.mdx index 869fe720402e9..e35bf90f17105 100644 --- a/api_docs/interactive_setup.mdx +++ b/api_docs/interactive_setup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/interactiveSetup title: "interactiveSetup" image: https://source.unsplash.com/400x175/?github summary: API docs for the interactiveSetup plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ace.devdocs.json b/api_docs/kbn_ace.devdocs.json index 074835365da89..e61625f00b6ae 100644 --- a/api_docs/kbn_ace.devdocs.json +++ b/api_docs/kbn_ace.devdocs.json @@ -9,11 +9,19 @@ "objects": [] }, "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/ace", - "id": "def-server.addToRules", + "id": "def-common.addToRules", "type": "Function", "tags": [], "label": "addToRules", @@ -26,7 +34,7 @@ "children": [ { "parentPluginId": "@kbn/ace", - "id": "def-server.addToRules.$1", + "id": "def-common.addToRules.$1", "type": "Any", "tags": [], "label": "otherRules", @@ -40,7 +48,7 @@ }, { "parentPluginId": "@kbn/ace", - "id": "def-server.addToRules.$2", + "id": "def-common.addToRules.$2", "type": "Any", "tags": [], "label": "embedUnder", @@ -58,7 +66,7 @@ }, { "parentPluginId": "@kbn/ace", - "id": "def-server.ElasticsearchSqlHighlightRules", + "id": "def-common.ElasticsearchSqlHighlightRules", "type": "Function", "tags": [], "label": "ElasticsearchSqlHighlightRules", @@ -74,7 +82,7 @@ }, { "parentPluginId": "@kbn/ace", - "id": "def-server.installXJsonMode", + "id": "def-common.installXJsonMode", "type": "Function", "tags": [], "label": "installXJsonMode", @@ -89,7 +97,7 @@ "children": [ { "parentPluginId": "@kbn/ace", - "id": "def-server.installXJsonMode.$1", + "id": "def-common.installXJsonMode.$1", "type": "Object", "tags": [], "label": "editor", @@ -107,7 +115,7 @@ }, { "parentPluginId": "@kbn/ace", - "id": "def-server.ScriptHighlightRules", + "id": "def-common.ScriptHighlightRules", "type": "Function", "tags": [], "label": "ScriptHighlightRules", @@ -120,7 +128,7 @@ "children": [ { "parentPluginId": "@kbn/ace", - "id": "def-server.ScriptHighlightRules.$1", + "id": "def-common.ScriptHighlightRules.$1", "type": "Any", "tags": [], "label": "this", @@ -138,7 +146,7 @@ }, { "parentPluginId": "@kbn/ace", - "id": "def-server.XJsonHighlightRules", + "id": "def-common.XJsonHighlightRules", "type": "Function", "tags": [], "label": "XJsonHighlightRules", @@ -151,7 +159,7 @@ "children": [ { "parentPluginId": "@kbn/ace", - "id": "def-server.XJsonHighlightRules.$1", + "id": "def-common.XJsonHighlightRules.$1", "type": "Any", "tags": [], "label": "this", @@ -173,7 +181,7 @@ "misc": [ { "parentPluginId": "@kbn/ace", - "id": "def-server.XJsonMode", + "id": "def-common.XJsonMode", "type": "Any", "tags": [], "label": "XJsonMode", @@ -187,13 +195,5 @@ } ], "objects": [] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] } } \ No newline at end of file diff --git a/api_docs/kbn_ace.mdx b/api_docs/kbn_ace.mdx index b937c8289d677..e00ced9559448 100644 --- a/api_docs/kbn_ace.mdx +++ b/api_docs/kbn_ace.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ace title: "@kbn/ace" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ace plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -20,11 +20,11 @@ Contact [Owner missing] for questions regarding this plugin. |-------------------|-----------|------------------------|-----------------| | 11 | 5 | 11 | 0 | -## Server +## Common ### Functions - + ### Consts, variables and types - + diff --git a/api_docs/kbn_aiops_utils.devdocs.json b/api_docs/kbn_aiops_utils.devdocs.json new file mode 100644 index 0000000000000..a81c6d0146764 --- /dev/null +++ b/api_docs/kbn_aiops_utils.devdocs.json @@ -0,0 +1,540 @@ +{ + "id": "@kbn/aiops-utils", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.streamFactory", + "type": "Function", + "tags": [], + "label": "streamFactory", + "description": [ + "\nOverload to set up a string based response stream with support\nfor gzip compression depending on provided request headers.\n" + ], + "signature": [ + "(headers: Headers) => StreamFactoryReturnType" + ], + "path": "packages/kbn-aiops-utils/src/lib/stream_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.streamFactory.$1", + "type": "Object", + "tags": [], + "label": "headers", + "description": [ + "- Request headers." + ], + "signature": [ + "Headers" + ], + "path": "packages/kbn-aiops-utils/src/lib/stream_factory.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "An object with stream attributes and methods." + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.streamFactory", + "type": "Function", + "tags": [], + "label": "streamFactory", + "description": [ + "\nSets up a response stream with support for gzip compression depending on provided\nrequest headers. Any non-string data pushed to the stream will be stream as NDJSON.\n" + ], + "signature": [ + "(headers: Headers) => StreamFactoryReturnType" + ], + "path": "packages/kbn-aiops-utils/src/lib/stream_factory.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.streamFactory.$1", + "type": "Object", + "tags": [], + "label": "headers", + "description": [ + "- Request headers." + ], + "signature": [ + "Headers" + ], + "path": "packages/kbn-aiops-utils/src/lib/stream_factory.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "An object with stream attributes and methods." + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream", + "type": "Function", + "tags": [], + "label": "useFetchStream", + "description": [], + "signature": [ + "(endpoint: `${BasePath}${I[\"endpoint\"]}`, body: I[\"body\"]) => UseFetchStreamReturnType>" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$1", + "type": "Uncategorized", + "tags": [], + "label": "endpoint", + "description": [], + "signature": [ + "`${BasePath}${I[\"endpoint\"]}`" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$2", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [], + "signature": [ + "I[\"body\"]" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream", + "type": "Function", + "tags": [], + "label": "useFetchStream", + "description": [], + "signature": [ + "(endpoint: `${BasePath}${I[\"endpoint\"]}`, body: I[\"body\"], options: { reducer: I[\"reducer\"]; initialState: React.ReducerState; }) => UseFetchStreamReturnType, React.ReducerAction>" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$1", + "type": "Uncategorized", + "tags": [], + "label": "endpoint", + "description": [], + "signature": [ + "`${BasePath}${I[\"endpoint\"]}`" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$2", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [], + "signature": [ + "I[\"body\"]" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$3.reducer", + "type": "Function", + "tags": [], + "label": "reducer", + "description": [], + "signature": [ + "I[\"reducer\"]" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$3.reducer.$1", + "type": "Uncategorized", + "tags": [], + "label": "prevState", + "description": [], + "signature": [ + "S" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$3.reducer.$2", + "type": "Uncategorized", + "tags": [], + "label": "action", + "description": [], + "signature": [ + "A" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$3.initialState", + "type": "Uncategorized", + "tags": [], + "label": "initialState", + "description": [], + "signature": [ + "I[\"reducer\"] extends React.Reducer ? S : never" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream", + "type": "Function", + "tags": [], + "label": "useFetchStream", + "description": [ + "\nCustom hook to receive streaming data.\n" + ], + "signature": [ + "(endpoint: `${BasePath}${I[\"endpoint\"]}`, body: I[\"body\"], options: { reducer: I[\"reducer\"]; initialState: React.ReducerState; } | undefined) => UseFetchStreamReturnType, React.ReducerAction>" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$1", + "type": "Uncategorized", + "tags": [], + "label": "endpoint", + "description": [ + "- API endpoint including Kibana base path." + ], + "signature": [ + "`${BasePath}${I[\"endpoint\"]}`" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$2", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "- API request body." + ], + "signature": [ + "I[\"body\"]" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$3.reducer", + "type": "Function", + "tags": [], + "label": "reducer", + "description": [], + "signature": [ + "I[\"reducer\"]" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$3.reducer.$1", + "type": "Uncategorized", + "tags": [], + "label": "prevState", + "description": [], + "signature": [ + "S" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$3.reducer.$2", + "type": "Uncategorized", + "tags": [], + "label": "action", + "description": [], + "signature": [ + "A" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.useFetchStream.$3.initialState", + "type": "Uncategorized", + "tags": [], + "label": "initialState", + "description": [], + "signature": [ + "I[\"reducer\"] extends React.Reducer ? S : never" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [ + "An object with streaming data and methods act on the stream." + ], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.UseFetchStreamCustomReducerParams", + "type": "Interface", + "tags": [], + "label": "UseFetchStreamCustomReducerParams", + "description": [ + "\nCustom hook type definition of the base params for an NDJSON stream with custom reducer." + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.UseFetchStreamCustomReducerParams.endpoint", + "type": "string", + "tags": [], + "label": "endpoint", + "description": [], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.UseFetchStreamCustomReducerParams.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [], + "signature": [ + "object" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.UseFetchStreamCustomReducerParams.reducer", + "type": "Function", + "tags": [], + "label": "reducer", + "description": [], + "signature": [ + "(prevState: any, action: any) => any" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.UseFetchStreamCustomReducerParams.reducer.$1", + "type": "Uncategorized", + "tags": [], + "label": "prevState", + "description": [], + "signature": [ + "S" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.UseFetchStreamCustomReducerParams.reducer.$2", + "type": "Uncategorized", + "tags": [], + "label": "action", + "description": [], + "signature": [ + "A" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.UseFetchStreamParamsDefault", + "type": "Interface", + "tags": [], + "label": "UseFetchStreamParamsDefault", + "description": [ + "\nCustom hook type definition of the base params for a string base stream without a custom reducer." + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.UseFetchStreamParamsDefault.endpoint", + "type": "string", + "tags": [], + "label": "endpoint", + "description": [], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.UseFetchStreamParamsDefault.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [], + "signature": [ + "object" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.UseFetchStreamParamsDefault.reducer", + "type": "Function", + "tags": [], + "label": "reducer", + "description": [], + "signature": [ + "(prevState: string, action: StringReducerPayload) => string" + ], + "path": "packages/kbn-aiops-utils/src/lib/use_fetch_stream.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.UseFetchStreamParamsDefault.reducer.$1", + "type": "Uncategorized", + "tags": [], + "label": "prevState", + "description": [], + "signature": [ + "S" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/aiops-utils", + "id": "def-common.UseFetchStreamParamsDefault.reducer.$2", + "type": "Uncategorized", + "tags": [], + "label": "action", + "description": [], + "signature": [ + "A" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_aiops_utils.mdx b/api_docs/kbn_aiops_utils.mdx new file mode 100644 index 0000000000000..699e608a4fe40 --- /dev/null +++ b/api_docs/kbn_aiops_utils.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnAiopsUtilsPluginApi +slug: /kibana-dev-docs/api/kbn-aiops-utils +title: "@kbn/aiops-utils" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/aiops-utils plugin +date: 2022-05-24 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 35 | 0 | 18 | 0 | + +## Common + +### Functions + + +### Interfaces + + diff --git a/api_docs/kbn_alerts.mdx b/api_docs/kbn_alerts.mdx index 09fb9c17c487d..27a0f6fe1647d 100644 --- a/api_docs/kbn_alerts.mdx +++ b/api_docs/kbn_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-alerts title: "@kbn/alerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/alerts plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx index 045b97520eb11..d1f6dd0176827 100644 --- a/api_docs/kbn_analytics.mdx +++ b/api_docs/kbn_analytics.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics title: "@kbn/analytics" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_analytics_client.devdocs.json b/api_docs/kbn_analytics_client.devdocs.json index b2111b6f6fbfd..6a8f5e77dedd2 100644 --- a/api_docs/kbn_analytics_client.devdocs.json +++ b/api_docs/kbn_analytics_client.devdocs.json @@ -9,11 +9,19 @@ "objects": [] }, "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.createAnalytics", + "id": "def-common.createAnalytics", "type": "Function", "tags": [], "label": "createAnalytics", @@ -24,17 +32,17 @@ "(initContext: ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.AnalyticsClientInitContext", + "section": "def-common.AnalyticsClientInitContext", "text": "AnalyticsClientInitContext" }, ") => ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.IAnalyticsClient", + "section": "def-common.IAnalyticsClient", "text": "IAnalyticsClient" } ], @@ -43,7 +51,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.createAnalytics.$1", + "id": "def-common.createAnalytics.$1", "type": "Object", "tags": [], "label": "initContext", @@ -53,9 +61,9 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.AnalyticsClientInitContext", + "section": "def-common.AnalyticsClientInitContext", "text": "AnalyticsClientInitContext" } ], @@ -71,7 +79,7 @@ "interfaces": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.AnalyticsClientInitContext", + "id": "def-common.AnalyticsClientInitContext", "type": "Interface", "tags": [], "label": "AnalyticsClientInitContext", @@ -83,7 +91,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.AnalyticsClientInitContext.isDev", + "id": "def-common.AnalyticsClientInitContext.isDev", "type": "boolean", "tags": [], "label": "isDev", @@ -95,7 +103,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.AnalyticsClientInitContext.sendTo", + "id": "def-common.AnalyticsClientInitContext.sendTo", "type": "CompoundType", "tags": [], "label": "sendTo", @@ -110,7 +118,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.AnalyticsClientInitContext.logger", + "id": "def-common.AnalyticsClientInitContext.logger", "type": "Object", "tags": [], "label": "logger", @@ -128,7 +136,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.ContextProviderOpts", + "id": "def-common.ContextProviderOpts", "type": "Interface", "tags": [], "label": "ContextProviderOpts", @@ -138,9 +146,9 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.ContextProviderOpts", + "section": "def-common.ContextProviderOpts", "text": "ContextProviderOpts" }, "" @@ -150,7 +158,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.ContextProviderOpts.name", + "id": "def-common.ContextProviderOpts.name", "type": "string", "tags": [], "label": "name", @@ -162,7 +170,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.ContextProviderOpts.context$", + "id": "def-common.ContextProviderOpts.context$", "type": "Object", "tags": [], "label": "context$", @@ -178,7 +186,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.ContextProviderOpts.schema", + "id": "def-common.ContextProviderOpts.schema", "type": "Object", "tags": [], "label": "schema", @@ -189,9 +197,9 @@ "{ [Key in keyof Required]: ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaValue", + "section": "def-common.SchemaValue", "text": "SchemaValue" }, "; }" @@ -204,7 +212,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.Event", + "id": "def-common.Event", "type": "Interface", "tags": [], "label": "Event", @@ -216,7 +224,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.Event.timestamp", + "id": "def-common.Event.timestamp", "type": "string", "tags": [], "label": "timestamp", @@ -228,7 +236,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.Event.event_type", + "id": "def-common.Event.event_type", "type": "string", "tags": [], "label": "event_type", @@ -240,7 +248,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.Event.properties", + "id": "def-common.Event.properties", "type": "Object", "tags": [], "label": "properties", @@ -255,7 +263,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.Event.context", + "id": "def-common.Event.context", "type": "Object", "tags": [], "label": "context", @@ -265,9 +273,9 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.EventContext", + "section": "def-common.EventContext", "text": "EventContext" } ], @@ -279,7 +287,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.EventContext", + "id": "def-common.EventContext", "type": "Interface", "tags": [], "label": "EventContext", @@ -291,7 +299,52 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.EventContext.userId", + "id": "def-common.EventContext.cluster_uuid", + "type": "string", + "tags": [], + "label": "cluster_uuid", + "description": [ + "\nThe UUID of the cluster" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/analytics/client/src/events/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-client", + "id": "def-common.EventContext.cluster_name", + "type": "string", + "tags": [], + "label": "cluster_name", + "description": [ + "\nThe name of the cluster." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/analytics/client/src/events/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-client", + "id": "def-common.EventContext.license_id", + "type": "string", + "tags": [], + "label": "license_id", + "description": [ + "\nThe license ID." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/analytics/client/src/events/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-client", + "id": "def-common.EventContext.userId", "type": "string", "tags": [], "label": "userId", @@ -306,7 +359,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.EventContext.cloudId", + "id": "def-common.EventContext.cloudId", "type": "string", "tags": [], "label": "cloudId", @@ -321,7 +374,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.EventContext.version", + "id": "def-common.EventContext.version", "type": "string", "tags": [], "label": "version", @@ -336,7 +389,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.EventContext.pageName", + "id": "def-common.EventContext.pageName", "type": "string", "tags": [], "label": "pageName", @@ -351,7 +404,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.EventContext.applicationId", + "id": "def-common.EventContext.applicationId", "type": "string", "tags": [], "label": "applicationId", @@ -366,7 +419,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.EventContext.entityId", + "id": "def-common.EventContext.entityId", "type": "string", "tags": [], "label": "entityId", @@ -381,11 +434,13 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.EventContext.Unnamed", + "id": "def-common.EventContext.Unnamed", "type": "IndexSignature", "tags": [], "label": "[key: string]: unknown", - "description": [], + "description": [ + "\nAdditional keys are allowed." + ], "signature": [ "[key: string]: unknown" ], @@ -397,7 +452,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.EventTypeOpts", + "id": "def-common.EventTypeOpts", "type": "Interface", "tags": [], "label": "EventTypeOpts", @@ -407,9 +462,9 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.EventTypeOpts", + "section": "def-common.EventTypeOpts", "text": "EventTypeOpts" }, "" @@ -419,7 +474,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.EventTypeOpts.eventType", + "id": "def-common.EventTypeOpts.eventType", "type": "string", "tags": [], "label": "eventType", @@ -431,7 +486,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.EventTypeOpts.schema", + "id": "def-common.EventTypeOpts.schema", "type": "Object", "tags": [], "label": "schema", @@ -442,9 +497,9 @@ "{ [Key in keyof Required]: ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaValue", + "section": "def-common.SchemaValue", "text": "SchemaValue" }, "; }" @@ -457,7 +512,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient", + "id": "def-common.IAnalyticsClient", "type": "Interface", "tags": [], "label": "IAnalyticsClient", @@ -469,7 +524,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.reportEvent", + "id": "def-common.IAnalyticsClient.reportEvent", "type": "Function", "tags": [], "label": "reportEvent", @@ -484,7 +539,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.reportEvent.$1", + "id": "def-common.IAnalyticsClient.reportEvent.$1", "type": "string", "tags": [], "label": "eventType", @@ -500,7 +555,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.reportEvent.$2", + "id": "def-common.IAnalyticsClient.reportEvent.$2", "type": "Uncategorized", "tags": [], "label": "eventData", @@ -519,7 +574,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.registerEventType", + "id": "def-common.IAnalyticsClient.registerEventType", "type": "Function", "tags": [], "label": "registerEventType", @@ -530,9 +585,9 @@ "(eventTypeOps: ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.EventTypeOpts", + "section": "def-common.EventTypeOpts", "text": "EventTypeOpts" }, ") => void" @@ -542,17 +597,19 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.registerEventType.$1", + "id": "def-common.IAnalyticsClient.registerEventType.$1", "type": "Object", "tags": [], "label": "eventTypeOps", - "description": [], + "description": [ + "The definition of the event type {@link EventTypeOpts }." + ], "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.EventTypeOpts", + "section": "def-common.EventTypeOpts", "text": "EventTypeOpts" }, "" @@ -566,7 +623,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.registerShipper", + "id": "def-common.IAnalyticsClient.registerShipper", "type": "Function", "tags": [], "label": "registerShipper", @@ -577,25 +634,25 @@ "(Shipper: ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.ShipperClassConstructor", + "section": "def-common.ShipperClassConstructor", "text": "ShipperClassConstructor" }, ", shipperConfig: ShipperConfig, opts?: ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.RegisterShipperOpts", + "section": "def-common.RegisterShipperOpts", "text": "RegisterShipperOpts" }, " | undefined) => void" @@ -605,7 +662,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.registerShipper.$1", + "id": "def-common.IAnalyticsClient.registerShipper.$1", "type": "Object", "tags": [], "label": "Shipper", @@ -615,9 +672,9 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.ShipperClassConstructor", + "section": "def-common.ShipperClassConstructor", "text": "ShipperClassConstructor" }, "" @@ -628,7 +685,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.registerShipper.$2", + "id": "def-common.IAnalyticsClient.registerShipper.$2", "type": "Uncategorized", "tags": [], "label": "shipperConfig", @@ -644,7 +701,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.registerShipper.$3", + "id": "def-common.IAnalyticsClient.registerShipper.$3", "type": "Object", "tags": [], "label": "opts", @@ -654,9 +711,9 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.RegisterShipperOpts", + "section": "def-common.RegisterShipperOpts", "text": "RegisterShipperOpts" }, " | undefined" @@ -670,7 +727,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.optIn", + "id": "def-common.IAnalyticsClient.optIn", "type": "Function", "tags": [], "label": "optIn", @@ -681,9 +738,9 @@ "(optInConfig: ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.OptInConfig", + "section": "def-common.OptInConfig", "text": "OptInConfig" }, ") => void" @@ -693,7 +750,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.optIn.$1", + "id": "def-common.IAnalyticsClient.optIn.$1", "type": "Object", "tags": [], "label": "optInConfig", @@ -703,9 +760,9 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.OptInConfig", + "section": "def-common.OptInConfig", "text": "OptInConfig" } ], @@ -718,7 +775,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.registerContextProvider", + "id": "def-common.IAnalyticsClient.registerContextProvider", "type": "Function", "tags": [], "label": "registerContextProvider", @@ -729,9 +786,9 @@ "(contextProviderOpts: ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.ContextProviderOpts", + "section": "def-common.ContextProviderOpts", "text": "ContextProviderOpts" }, ") => void" @@ -741,7 +798,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.registerContextProvider.$1", + "id": "def-common.IAnalyticsClient.registerContextProvider.$1", "type": "Object", "tags": [], "label": "contextProviderOpts", @@ -751,9 +808,9 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.ContextProviderOpts", + "section": "def-common.ContextProviderOpts", "text": "ContextProviderOpts" }, "" @@ -767,7 +824,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.removeContextProvider", + "id": "def-common.IAnalyticsClient.removeContextProvider", "type": "Function", "tags": [], "label": "removeContextProvider", @@ -782,7 +839,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.removeContextProvider.$1", + "id": "def-common.IAnalyticsClient.removeContextProvider.$1", "type": "string", "tags": [], "label": "contextProviderName", @@ -801,7 +858,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IAnalyticsClient.telemetryCounter$", + "id": "def-common.IAnalyticsClient.telemetryCounter$", "type": "Object", "tags": [], "label": "telemetryCounter$", @@ -813,22 +870,39 @@ "<", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.TelemetryCounter", + "section": "def-common.TelemetryCounter", "text": "TelemetryCounter" }, ">" ], "path": "packages/analytics/client/src/analytics_client/types.ts", "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-client", + "id": "def-common.IAnalyticsClient.shutdown", + "type": "Function", + "tags": [], + "label": "shutdown", + "description": [ + "\nStops the client." + ], + "signature": [ + "() => void" + ], + "path": "packages/analytics/client/src/analytics_client/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IShipper", + "id": "def-common.IShipper", "type": "Interface", "tags": [], "label": "IShipper", @@ -840,7 +914,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IShipper.reportEvents", + "id": "def-common.IShipper.reportEvents", "type": "Function", "tags": [], "label": "reportEvents", @@ -851,9 +925,9 @@ "(events: ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.Event", + "section": "def-common.Event", "text": "Event" }, "[]) => void" @@ -863,7 +937,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IShipper.reportEvents.$1", + "id": "def-common.IShipper.reportEvents.$1", "type": "Array", "tags": [], "label": "events", @@ -873,9 +947,9 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.Event", + "section": "def-common.Event", "text": "Event" }, "[]" @@ -889,7 +963,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IShipper.optIn", + "id": "def-common.IShipper.optIn", "type": "Function", "tags": [], "label": "optIn", @@ -904,7 +978,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IShipper.optIn.$1", + "id": "def-common.IShipper.optIn.$1", "type": "boolean", "tags": [], "label": "isOptedIn", @@ -923,7 +997,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IShipper.extendContext", + "id": "def-common.IShipper.extendContext", "type": "Function", "tags": [], "label": "extendContext", @@ -934,9 +1008,9 @@ "((newContext: ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.EventContext", + "section": "def-common.EventContext", "text": "EventContext" }, ") => void) | undefined" @@ -946,17 +1020,19 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IShipper.extendContext.$1", + "id": "def-common.IShipper.extendContext.$1", "type": "Object", "tags": [], "label": "newContext", - "description": [], + "description": [ + "The full new context to set {@link EventContext }" + ], "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.EventContext", + "section": "def-common.EventContext", "text": "EventContext" } ], @@ -969,7 +1045,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.IShipper.telemetryCounter$", + "id": "def-common.IShipper.telemetryCounter$", "type": "Object", "tags": [], "label": "telemetryCounter$", @@ -981,22 +1057,39 @@ "<", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.TelemetryCounter", + "section": "def-common.TelemetryCounter", "text": "TelemetryCounter" }, "> | undefined" ], "path": "packages/analytics/client/src/shippers/types.ts", "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-client", + "id": "def-common.IShipper.shutdown", + "type": "Function", + "tags": [], + "label": "shutdown", + "description": [ + "\nShutdown the shipper." + ], + "signature": [ + "() => void" + ], + "path": "packages/analytics/client/src/shippers/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.OptInConfig", + "id": "def-common.OptInConfig", "type": "Interface", "tags": [], "label": "OptInConfig", @@ -1008,7 +1101,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.OptInConfig.global", + "id": "def-common.OptInConfig.global", "type": "Object", "tags": [], "label": "global", @@ -1018,9 +1111,9 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.OptInConfigPerType", + "section": "def-common.OptInConfigPerType", "text": "OptInConfigPerType" } ], @@ -1029,7 +1122,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.OptInConfig.event_types", + "id": "def-common.OptInConfig.event_types", "type": "Object", "tags": [], "label": "event_types", @@ -1040,9 +1133,9 @@ "Record | undefined" @@ -1055,7 +1148,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.OptInConfigPerType", + "id": "def-common.OptInConfigPerType", "type": "Interface", "tags": [], "label": "OptInConfigPerType", @@ -1067,7 +1160,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.OptInConfigPerType.enabled", + "id": "def-common.OptInConfigPerType.enabled", "type": "boolean", "tags": [], "label": "enabled", @@ -1079,7 +1172,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.OptInConfigPerType.shippers", + "id": "def-common.OptInConfigPerType.shippers", "type": "Object", "tags": [], "label": "shippers", @@ -1097,7 +1190,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.RegisterShipperOpts", + "id": "def-common.RegisterShipperOpts", "type": "Interface", "tags": [], "label": "RegisterShipperOpts", @@ -1111,7 +1204,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.SchemaArray", + "id": "def-common.SchemaArray", "type": "Interface", "tags": [], "label": "SchemaArray", @@ -1121,17 +1214,17 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaArray", + "section": "def-common.SchemaArray", "text": "SchemaArray" }, " extends ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaMeta", + "section": "def-common.SchemaMeta", "text": "SchemaMeta" }, "" @@ -1141,7 +1234,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.SchemaArray.type", + "id": "def-common.SchemaArray.type", "type": "string", "tags": [], "label": "type", @@ -1154,7 +1247,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.SchemaArray.items", + "id": "def-common.SchemaArray.items", "type": "CompoundType", "tags": [], "label": "items", @@ -1163,57 +1256,65 @@ "{ type: \"pass_through\"; _meta: { description: string; } & ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaMetaOptional", + "section": "def-common.SchemaMetaOptional", "text": "SchemaMetaOptional" }, "; } | (unknown extends Value ? ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaArray", + "section": "def-common.SchemaArray", "text": "SchemaArray" }, " | ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaObject", + "section": "def-common.SchemaObject", "text": "SchemaObject" }, " | ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaChildValue", + "section": "def-common.SchemaChildValue", "text": "SchemaChildValue" }, - " : NonNullable extends (infer U)[] ? ", + " : NonNullable extends (infer U)[] | readonly (infer U)[] ? ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaArray", + "section": "def-common.SchemaArray", "text": "SchemaArray" }, - " : NonNullable extends object ? ", + " : NonNullable extends Date ? ", + { + "pluginId": "@kbn/analytics-client", + "scope": "common", + "docId": "kibKbnAnalyticsClientPluginApi", + "section": "def-common.SchemaChildValue", + "text": "SchemaChildValue" + }, + " : NonNullable extends object ? ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaObject", + "section": "def-common.SchemaObject", "text": "SchemaObject" }, " : ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaChildValue", + "section": "def-common.SchemaChildValue", "text": "SchemaChildValue" }, ")" @@ -1226,7 +1327,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.SchemaChildValue", + "id": "def-common.SchemaChildValue", "type": "Interface", "tags": [], "label": "SchemaChildValue", @@ -1234,9 +1335,9 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaChildValue", + "section": "def-common.SchemaChildValue", "text": "SchemaChildValue" }, "" @@ -1246,34 +1347,34 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.SchemaChildValue.type", + "id": "def-common.SchemaChildValue.type", "type": "Uncategorized", "tags": [], "label": "type", "description": [], "signature": [ - "NonNullable extends string ? ", + "NonNullable extends string | Date ? ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.AllowedSchemaStringTypes", + "section": "def-common.AllowedSchemaStringTypes", "text": "AllowedSchemaStringTypes" }, " : NonNullable extends number ? ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.AllowedSchemaNumberTypes", + "section": "def-common.AllowedSchemaNumberTypes", "text": "AllowedSchemaNumberTypes" }, " : NonNullable extends boolean ? \"boolean\" : ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.AllowedSchemaTypes", + "section": "def-common.AllowedSchemaTypes", "text": "AllowedSchemaTypes" } ], @@ -1282,7 +1383,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.SchemaChildValue._meta", + "id": "def-common.SchemaChildValue._meta", "type": "CompoundType", "tags": [], "label": "_meta", @@ -1291,9 +1392,9 @@ "{ description: string; } & ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaMetaOptional", + "section": "def-common.SchemaMetaOptional", "text": "SchemaMetaOptional" }, "" @@ -1306,7 +1407,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.SchemaMeta", + "id": "def-common.SchemaMeta", "type": "Interface", "tags": [], "label": "SchemaMeta", @@ -1316,9 +1417,9 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaMeta", + "section": "def-common.SchemaMeta", "text": "SchemaMeta" }, "" @@ -1328,7 +1429,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.SchemaMeta._meta", + "id": "def-common.SchemaMeta._meta", "type": "CompoundType", "tags": [], "label": "_meta", @@ -1337,9 +1438,9 @@ "({ description?: string | undefined; } & ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaMetaOptional", + "section": "def-common.SchemaMetaOptional", "text": "SchemaMetaOptional" }, ") | undefined" @@ -1352,7 +1453,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.SchemaObject", + "id": "def-common.SchemaObject", "type": "Interface", "tags": [], "label": "SchemaObject", @@ -1362,17 +1463,17 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaObject", + "section": "def-common.SchemaObject", "text": "SchemaObject" }, " extends ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaMeta", + "section": "def-common.SchemaMeta", "text": "SchemaMeta" }, "" @@ -1382,7 +1483,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.SchemaObject.properties", + "id": "def-common.SchemaObject.properties", "type": "Object", "tags": [], "label": "properties", @@ -1391,9 +1492,9 @@ "{ [Key in keyof Required]: ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaValue", + "section": "def-common.SchemaValue", "text": "SchemaValue" }, "; }" @@ -1406,7 +1507,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.ShipperClassConstructor", + "id": "def-common.ShipperClassConstructor", "type": "Interface", "tags": [], "label": "ShipperClassConstructor", @@ -1416,9 +1517,9 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.ShipperClassConstructor", + "section": "def-common.ShipperClassConstructor", "text": "ShipperClassConstructor" }, "" @@ -1428,7 +1529,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.ShipperClassConstructor.shipperName", + "id": "def-common.ShipperClassConstructor.shipperName", "type": "string", "tags": [], "label": "shipperName", @@ -1440,10 +1541,10 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.ShipperClassConstructor.Unnamed", - "type": "Any", + "id": "def-common.ShipperClassConstructor.new", + "type": "Function", "tags": [], - "label": "Unnamed", + "label": "new", "description": [ "\nThe constructor" ], @@ -1451,14 +1552,55 @@ "any" ], "path": "packages/analytics/client/src/analytics_client/types.ts", - "deprecated": false + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-client", + "id": "def-common.ShipperClassConstructor.new.$1", + "type": "Uncategorized", + "tags": [], + "label": "config", + "description": [ + "The shipper's custom config" + ], + "signature": [ + "Config" + ], + "path": "packages/analytics/client/src/analytics_client/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/analytics-client", + "id": "def-common.ShipperClassConstructor.new.$2", + "type": "Object", + "tags": [], + "label": "initContext", + "description": [ + "Common context {@link AnalyticsClientInitContext }" + ], + "signature": [ + { + "pluginId": "@kbn/analytics-client", + "scope": "common", + "docId": "kibKbnAnalyticsClientPluginApi", + "section": "def-common.AnalyticsClientInitContext", + "text": "AnalyticsClientInitContext" + } + ], + "path": "packages/analytics/client/src/analytics_client/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.TelemetryCounter", + "id": "def-common.TelemetryCounter", "type": "Interface", "tags": [], "label": "TelemetryCounter", @@ -1470,7 +1612,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.TelemetryCounter.type", + "id": "def-common.TelemetryCounter.type", "type": "Enum", "tags": [], "label": "type", @@ -1480,9 +1622,9 @@ "signature": [ { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.TelemetryCounterType", + "section": "def-common.TelemetryCounterType", "text": "TelemetryCounterType" } ], @@ -1491,7 +1633,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.TelemetryCounter.source", + "id": "def-common.TelemetryCounter.source", "type": "string", "tags": [], "label": "source", @@ -1503,7 +1645,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.TelemetryCounter.event_type", + "id": "def-common.TelemetryCounter.event_type", "type": "string", "tags": [], "label": "event_type", @@ -1515,7 +1657,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.TelemetryCounter.code", + "id": "def-common.TelemetryCounter.code", "type": "string", "tags": [], "label": "code", @@ -1527,7 +1669,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.TelemetryCounter.count", + "id": "def-common.TelemetryCounter.count", "type": "number", "tags": [], "label": "count", @@ -1544,7 +1686,7 @@ "enums": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.TelemetryCounterType", + "id": "def-common.TelemetryCounterType", "type": "Enum", "tags": [], "label": "TelemetryCounterType", @@ -1559,7 +1701,7 @@ "misc": [ { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.AllowedSchemaBooleanTypes", + "id": "def-common.AllowedSchemaBooleanTypes", "type": "Type", "tags": [], "label": "AllowedSchemaBooleanTypes", @@ -1575,7 +1717,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.AllowedSchemaNumberTypes", + "id": "def-common.AllowedSchemaNumberTypes", "type": "Type", "tags": [], "label": "AllowedSchemaNumberTypes", @@ -1591,7 +1733,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.AllowedSchemaStringTypes", + "id": "def-common.AllowedSchemaStringTypes", "type": "Type", "tags": [], "label": "AllowedSchemaStringTypes", @@ -1607,7 +1749,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.AllowedSchemaTypes", + "id": "def-common.AllowedSchemaTypes", "type": "Type", "tags": [], "label": "AllowedSchemaTypes", @@ -1623,7 +1765,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.EventType", + "id": "def-common.EventType", "type": "Type", "tags": [], "label": "EventType", @@ -1639,7 +1781,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.PossibleSchemaTypes", + "id": "def-common.PossibleSchemaTypes", "type": "Type", "tags": [], "label": "PossibleSchemaTypes", @@ -1647,28 +1789,28 @@ "\nHelper to ensure the declared types match the schema types" ], "signature": [ - "Value extends string ? ", + "Value extends string | Date ? ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.AllowedSchemaStringTypes", + "section": "def-common.AllowedSchemaStringTypes", "text": "AllowedSchemaStringTypes" }, " : Value extends number ? ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.AllowedSchemaNumberTypes", + "section": "def-common.AllowedSchemaNumberTypes", "text": "AllowedSchemaNumberTypes" }, " : Value extends boolean ? \"boolean\" : ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.AllowedSchemaTypes", + "section": "def-common.AllowedSchemaTypes", "text": "AllowedSchemaTypes" } ], @@ -1678,7 +1820,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.RootSchema", + "id": "def-common.RootSchema", "type": "Type", "tags": [], "label": "RootSchema", @@ -1689,9 +1831,9 @@ "{ [Key in keyof Required]: ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaValue", + "section": "def-common.SchemaValue", "text": "SchemaValue" }, "; }" @@ -1702,7 +1844,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.SchemaMetaOptional", + "id": "def-common.SchemaMetaOptional", "type": "Type", "tags": [], "label": "SchemaMetaOptional", @@ -1718,7 +1860,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.SchemaValue", + "id": "def-common.SchemaValue", "type": "Type", "tags": [], "label": "SchemaValue", @@ -1729,57 +1871,65 @@ "{ type: \"pass_through\"; _meta: { description: string; } & ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaMetaOptional", + "section": "def-common.SchemaMetaOptional", "text": "SchemaMetaOptional" }, "; } | (unknown extends Value ? ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaArray", + "section": "def-common.SchemaArray", "text": "SchemaArray" }, " | ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaObject", + "section": "def-common.SchemaObject", "text": "SchemaObject" }, " | ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaChildValue", + "section": "def-common.SchemaChildValue", "text": "SchemaChildValue" }, - " : NonNullable extends (infer U)[] ? ", + " : NonNullable extends (infer U)[] | readonly (infer U)[] ? ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaArray", + "section": "def-common.SchemaArray", "text": "SchemaArray" }, - " : NonNullable extends object ? ", + " : NonNullable extends Date ? ", + { + "pluginId": "@kbn/analytics-client", + "scope": "common", + "docId": "kibKbnAnalyticsClientPluginApi", + "section": "def-common.SchemaChildValue", + "text": "SchemaChildValue" + }, + " : NonNullable extends object ? ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaObject", + "section": "def-common.SchemaObject", "text": "SchemaObject" }, " : ", { "pluginId": "@kbn/analytics-client", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsClientPluginApi", - "section": "def-server.SchemaChildValue", + "section": "def-common.SchemaChildValue", "text": "SchemaChildValue" }, ")" @@ -1790,7 +1940,7 @@ }, { "parentPluginId": "@kbn/analytics-client", - "id": "def-server.ShipperName", + "id": "def-common.ShipperName", "type": "Type", "tags": [], "label": "ShipperName", @@ -1806,13 +1956,5 @@ } ], "objects": [] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] } } \ No newline at end of file diff --git a/api_docs/kbn_analytics_client.mdx b/api_docs/kbn_analytics_client.mdx index e51ae9a874e9f..4b4c5efe2f703 100644 --- a/api_docs/kbn_analytics_client.mdx +++ b/api_docs/kbn_analytics_client.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client title: "@kbn/analytics-client" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-client plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,19 +18,19 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 88 | 1 | 10 | 0 | +| 95 | 0 | 7 | 0 | -## Server +## Common ### Functions - + ### Interfaces - + ### Enums - + ### Consts, variables and types - + diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.devdocs.json b/api_docs/kbn_analytics_shippers_elastic_v3_browser.devdocs.json new file mode 100644 index 0000000000000..8728f86815d4a --- /dev/null +++ b/api_docs/kbn_analytics_shippers_elastic_v3_browser.devdocs.json @@ -0,0 +1,302 @@ +{ + "id": "@kbn/analytics-shippers-elastic-v3-browser", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3BrowserShipper", + "type": "Class", + "tags": [], + "label": "ElasticV3BrowserShipper", + "description": [], + "signature": [ + { + "pluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "scope": "common", + "docId": "kibKbnAnalyticsShippersElasticV3BrowserPluginApi", + "section": "def-common.ElasticV3BrowserShipper", + "text": "ElasticV3BrowserShipper" + }, + " implements ", + "IShipper" + ], + "path": "packages/analytics/shippers/elastic_v3/browser/src/browser_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3BrowserShipper.shipperName", + "type": "string", + "tags": [], + "label": "shipperName", + "description": [], + "path": "packages/analytics/shippers/elastic_v3/browser/src/browser_shipper.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3BrowserShipper.telemetryCounter$", + "type": "Object", + "tags": [], + "label": "telemetryCounter$", + "description": [], + "signature": [ + "Subject", + "<", + "TelemetryCounter", + ">" + ], + "path": "packages/analytics/shippers/elastic_v3/browser/src/browser_shipper.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3BrowserShipper.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/analytics/shippers/elastic_v3/browser/src/browser_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3BrowserShipper.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "ElasticV3ShipperOptions" + ], + "path": "packages/analytics/shippers/elastic_v3/browser/src/browser_shipper.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3BrowserShipper.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "initContext", + "description": [], + "signature": [ + "AnalyticsClientInitContext" + ], + "path": "packages/analytics/shippers/elastic_v3/browser/src/browser_shipper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3BrowserShipper.extendContext", + "type": "Function", + "tags": [], + "label": "extendContext", + "description": [], + "signature": [ + "(newContext: ", + "EventContext", + ") => void" + ], + "path": "packages/analytics/shippers/elastic_v3/browser/src/browser_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3BrowserShipper.extendContext.$1", + "type": "Object", + "tags": [], + "label": "newContext", + "description": [], + "signature": [ + "EventContext" + ], + "path": "packages/analytics/shippers/elastic_v3/browser/src/browser_shipper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3BrowserShipper.optIn", + "type": "Function", + "tags": [], + "label": "optIn", + "description": [], + "signature": [ + "(isOptedIn: boolean) => void" + ], + "path": "packages/analytics/shippers/elastic_v3/browser/src/browser_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3BrowserShipper.optIn.$1", + "type": "boolean", + "tags": [], + "label": "isOptedIn", + "description": [], + "signature": [ + "boolean" + ], + "path": "packages/analytics/shippers/elastic_v3/browser/src/browser_shipper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3BrowserShipper.reportEvents", + "type": "Function", + "tags": [], + "label": "reportEvents", + "description": [], + "signature": [ + "(events: ", + "Event", + "[]) => void" + ], + "path": "packages/analytics/shippers/elastic_v3/browser/src/browser_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3BrowserShipper.reportEvents.$1", + "type": "Array", + "tags": [], + "label": "events", + "description": [], + "signature": [ + "Event", + "[]" + ], + "path": "packages/analytics/shippers/elastic_v3/browser/src/browser_shipper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3BrowserShipper.shutdown", + "type": "Function", + "tags": [], + "label": "shutdown", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/analytics/shippers/elastic_v3/browser/src/browser_shipper.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3ShipperOptions", + "type": "Interface", + "tags": [], + "label": "ElasticV3ShipperOptions", + "description": [ + "\r\nOptions for the Elastic V3 shipper" + ], + "path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3ShipperOptions.channelName", + "type": "string", + "tags": [], + "label": "channelName", + "description": [ + "\r\nThe name of the channel to stream all the events to." + ], + "path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3ShipperOptions.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\r\nThe product's version." + ], + "path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3ShipperOptions.sendTo", + "type": "CompoundType", + "tags": [], + "label": "sendTo", + "description": [ + "\r\nProvide it to override the Analytics client's default configuration." + ], + "signature": [ + "\"staging\" | \"production\" | undefined" + ], + "path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-browser", + "id": "def-common.ElasticV3ShipperOptions.debug", + "type": "CompoundType", + "tags": [], + "label": "debug", + "description": [ + "\r\nShould show debug information about the requests it makes to the V3 API." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx new file mode 100644 index 0000000000000..b9d3b815f5365 --- /dev/null +++ b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnAnalyticsShippersElasticV3BrowserPluginApi +slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-browser +title: "@kbn/analytics-shippers-elastic-v3-browser" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin +date: 2022-05-24 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnAnalyticsShippersElasticV3BrowserObj from './kbn_analytics_shippers_elastic_v3_browser.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 18 | 0 | 13 | 0 | + +## Common + +### Classes + + +### Interfaces + + diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_common.devdocs.json b/api_docs/kbn_analytics_shippers_elastic_v3_common.devdocs.json new file mode 100644 index 0000000000000..cae7144976799 --- /dev/null +++ b/api_docs/kbn_analytics_shippers_elastic_v3_common.devdocs.json @@ -0,0 +1,375 @@ +{ + "id": "@kbn/analytics-shippers-elastic-v3-common", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.ErrorWithCode", + "type": "Class", + "tags": [], + "label": "ErrorWithCode", + "description": [], + "signature": [ + { + "pluginId": "@kbn/analytics-shippers-elastic-v3-common", + "scope": "common", + "docId": "kibKbnAnalyticsShippersElasticV3CommonPluginApi", + "section": "def-common.ErrorWithCode", + "text": "ErrorWithCode" + }, + " extends Error" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/error_with_code.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.ErrorWithCode.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/error_with_code.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.ErrorWithCode.Unnamed.$1", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "signature": [ + "string" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/error_with_code.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.ErrorWithCode.Unnamed.$2", + "type": "string", + "tags": [], + "label": "code", + "description": [], + "signature": [ + "string" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/error_with_code.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.buildHeaders", + "type": "Function", + "tags": [], + "label": "buildHeaders", + "description": [], + "signature": [ + "(clusterUuid: string, version: string, licenseId: string | undefined) => { 'x-elastic-license-id'?: string | undefined; 'content-type': string; 'x-elastic-cluster-id': string; 'x-elastic-stack-version': string; }" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/build_headers.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.buildHeaders.$1", + "type": "string", + "tags": [], + "label": "clusterUuid", + "description": [], + "signature": [ + "string" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/build_headers.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.buildHeaders.$2", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "string" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/build_headers.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.buildHeaders.$3", + "type": "string", + "tags": [], + "label": "licenseId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/build_headers.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.buildUrl", + "type": "Function", + "tags": [], + "label": "buildUrl", + "description": [ + "\nBuilds the URL for the V3 API." + ], + "signature": [ + "({\n sendTo,\n channelName,\n}: { sendTo: \"staging\" | \"production\"; channelName: string; }) => string" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/build_url.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.buildUrl.$1", + "type": "Object", + "tags": [], + "label": "{\n sendTo,\n channelName,\n}", + "description": [], + "path": "packages/analytics/shippers/elastic_v3/common/src/build_url.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.buildUrl.$1.sendTo", + "type": "CompoundType", + "tags": [], + "label": "sendTo", + "description": [], + "signature": [ + "\"staging\" | \"production\"" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/build_url.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.buildUrl.$1.channelName", + "type": "string", + "tags": [], + "label": "channelName", + "description": [], + "path": "packages/analytics/shippers/elastic_v3/common/src/build_url.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.createTelemetryCounterHelper", + "type": "Function", + "tags": [], + "label": "createTelemetryCounterHelper", + "description": [ + "\nCreates a telemetry counter helper to make it easier to generate them" + ], + "signature": [ + "(telemetryCounter$: ", + "Subject", + "<", + "TelemetryCounter", + ">, source: string) => (events: ", + "Event", + "[], { type, code, error }?: { type?: ", + "TelemetryCounterType", + " | undefined; code?: string | undefined; error?: Error | undefined; }) => void" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/report_telemetry_counters.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.createTelemetryCounterHelper.$1", + "type": "Object", + "tags": [], + "label": "telemetryCounter$", + "description": [ + "The observable that will be used to emit the telemetry counters" + ], + "signature": [ + "Subject", + "<", + "TelemetryCounter", + ">" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/report_telemetry_counters.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.createTelemetryCounterHelper.$2", + "type": "string", + "tags": [], + "label": "source", + "description": [ + "The name of the shipper that is sending the events." + ], + "signature": [ + "string" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/report_telemetry_counters.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.eventsToNDJSON", + "type": "Function", + "tags": [], + "label": "eventsToNDJSON", + "description": [], + "signature": [ + "(events: ", + "Event", + "[]) => string" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/events_to_ndjson.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.eventsToNDJSON.$1", + "type": "Array", + "tags": [], + "label": "events", + "description": [], + "signature": [ + "Event", + "[]" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/events_to_ndjson.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.ElasticV3ShipperOptions", + "type": "Interface", + "tags": [], + "label": "ElasticV3ShipperOptions", + "description": [ + "\nOptions for the Elastic V3 shipper" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.ElasticV3ShipperOptions.channelName", + "type": "string", + "tags": [], + "label": "channelName", + "description": [ + "\nThe name of the channel to stream all the events to." + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.ElasticV3ShipperOptions.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nThe product's version." + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.ElasticV3ShipperOptions.sendTo", + "type": "CompoundType", + "tags": [], + "label": "sendTo", + "description": [ + "\nProvide it to override the Analytics client's default configuration." + ], + "signature": [ + "\"staging\" | \"production\" | undefined" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-common", + "id": "def-common.ElasticV3ShipperOptions.debug", + "type": "CompoundType", + "tags": [], + "label": "debug", + "description": [ + "\nShould show debug information about the requests it makes to the V3 API." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/analytics/shippers/elastic_v3/common/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx new file mode 100644 index 0000000000000..9e099e103115d --- /dev/null +++ b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx @@ -0,0 +1,33 @@ +--- +id: kibKbnAnalyticsShippersElasticV3CommonPluginApi +slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-common +title: "@kbn/analytics-shippers-elastic-v3-common" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin +date: 2022-05-24 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnAnalyticsShippersElasticV3CommonObj from './kbn_analytics_shippers_elastic_v3_common.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 22 | 0 | 13 | 0 | + +## Common + +### Functions + + +### Classes + + +### Interfaces + + diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_server.devdocs.json b/api_docs/kbn_analytics_shippers_elastic_v3_server.devdocs.json new file mode 100644 index 0000000000000..a0ca93e38501b --- /dev/null +++ b/api_docs/kbn_analytics_shippers_elastic_v3_server.devdocs.json @@ -0,0 +1,302 @@ +{ + "id": "@kbn/analytics-shippers-elastic-v3-server", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ServerShipper", + "type": "Class", + "tags": [], + "label": "ElasticV3ServerShipper", + "description": [], + "signature": [ + { + "pluginId": "@kbn/analytics-shippers-elastic-v3-server", + "scope": "server", + "docId": "kibKbnAnalyticsShippersElasticV3ServerPluginApi", + "section": "def-server.ElasticV3ServerShipper", + "text": "ElasticV3ServerShipper" + }, + " implements ", + "IShipper" + ], + "path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ServerShipper.shipperName", + "type": "string", + "tags": [], + "label": "shipperName", + "description": [], + "path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ServerShipper.telemetryCounter$", + "type": "Object", + "tags": [], + "label": "telemetryCounter$", + "description": [], + "signature": [ + "Subject", + "<", + "TelemetryCounter", + ">" + ], + "path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ServerShipper.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ServerShipper.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "ElasticV3ShipperOptions" + ], + "path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ServerShipper.Unnamed.$2", + "type": "Object", + "tags": [], + "label": "initContext", + "description": [], + "signature": [ + "AnalyticsClientInitContext" + ], + "path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ServerShipper.extendContext", + "type": "Function", + "tags": [], + "label": "extendContext", + "description": [], + "signature": [ + "(newContext: ", + "EventContext", + ") => void" + ], + "path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ServerShipper.extendContext.$1", + "type": "Object", + "tags": [], + "label": "newContext", + "description": [], + "signature": [ + "EventContext" + ], + "path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ServerShipper.optIn", + "type": "Function", + "tags": [], + "label": "optIn", + "description": [], + "signature": [ + "(isOptedIn: boolean) => void" + ], + "path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ServerShipper.optIn.$1", + "type": "boolean", + "tags": [], + "label": "isOptedIn", + "description": [], + "signature": [ + "boolean" + ], + "path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ServerShipper.reportEvents", + "type": "Function", + "tags": [], + "label": "reportEvents", + "description": [], + "signature": [ + "(events: ", + "Event", + "[]) => void" + ], + "path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ServerShipper.reportEvents.$1", + "type": "Array", + "tags": [], + "label": "events", + "description": [], + "signature": [ + "Event", + "[]" + ], + "path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ServerShipper.shutdown", + "type": "Function", + "tags": [], + "label": "shutdown", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/analytics/shippers/elastic_v3/server/src/server_shipper.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ShipperOptions", + "type": "Interface", + "tags": [], + "label": "ElasticV3ShipperOptions", + "description": [ + "\r\nOptions for the Elastic V3 shipper" + ], + "path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ShipperOptions.channelName", + "type": "string", + "tags": [], + "label": "channelName", + "description": [ + "\r\nThe name of the channel to stream all the events to." + ], + "path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ShipperOptions.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\r\nThe product's version." + ], + "path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ShipperOptions.sendTo", + "type": "CompoundType", + "tags": [], + "label": "sendTo", + "description": [ + "\r\nProvide it to override the Analytics client's default configuration." + ], + "signature": [ + "\"staging\" | \"production\" | undefined" + ], + "path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-elastic-v3-server", + "id": "def-server.ElasticV3ShipperOptions.debug", + "type": "CompoundType", + "tags": [], + "label": "debug", + "description": [ + "\r\nShould show debug information about the requests it makes to the V3 API." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__analytics-shippers-elastic-v3-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx new file mode 100644 index 0000000000000..ab07342c4fe90 --- /dev/null +++ b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnAnalyticsShippersElasticV3ServerPluginApi +slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-server +title: "@kbn/analytics-shippers-elastic-v3-server" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin +date: 2022-05-24 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnAnalyticsShippersElasticV3ServerObj from './kbn_analytics_shippers_elastic_v3_server.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 18 | 0 | 13 | 0 | + +## Server + +### Classes + + +### Interfaces + + diff --git a/api_docs/kbn_analytics_shippers_fullstory.devdocs.json b/api_docs/kbn_analytics_shippers_fullstory.devdocs.json index 3f79e43e3a09c..7fcf744c07806 100644 --- a/api_docs/kbn_analytics_shippers_fullstory.devdocs.json +++ b/api_docs/kbn_analytics_shippers_fullstory.devdocs.json @@ -9,20 +9,30 @@ "objects": [] }, "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { "classes": [ { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStoryShipper", + "id": "def-common.FullStoryShipper", "type": "Class", "tags": [], "label": "FullStoryShipper", - "description": [], + "description": [ + "\nFullStory shipper." + ], "signature": [ { "pluginId": "@kbn/analytics-shippers-fullstory", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsShippersFullstoryPluginApi", - "section": "def-server.FullStoryShipper", + "section": "def-common.FullStoryShipper", "text": "FullStoryShipper" }, " implements ", @@ -33,21 +43,25 @@ "children": [ { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStoryShipper.shipperName", + "id": "def-common.FullStoryShipper.shipperName", "type": "string", "tags": [], "label": "shipperName", - "description": [], + "description": [ + "Shipper's unique name" + ], "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", "deprecated": false }, { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStoryShipper.Unnamed", + "id": "def-common.FullStoryShipper.Unnamed", "type": "Function", "tags": [], "label": "Constructor", - "description": [], + "description": [ + "\nCreates a new instance of the FullStoryShipper." + ], "signature": [ "any" ], @@ -56,18 +70,20 @@ "children": [ { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStoryShipper.Unnamed.$1", + "id": "def-common.FullStoryShipper.Unnamed.$1", "type": "Object", "tags": [], "label": "config", - "description": [], + "description": [ + "{@link FullStoryShipperConfig }" + ], "signature": [ { "pluginId": "@kbn/analytics-shippers-fullstory", - "scope": "server", + "scope": "common", "docId": "kibKbnAnalyticsShippersFullstoryPluginApi", - "section": "def-server.FullStorySnippetConfig", - "text": "FullStorySnippetConfig" + "section": "def-common.FullStoryShipperConfig", + "text": "FullStoryShipperConfig" } ], "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", @@ -76,11 +92,13 @@ }, { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStoryShipper.Unnamed.$2", + "id": "def-common.FullStoryShipper.Unnamed.$2", "type": "Object", "tags": [], "label": "initContext", - "description": [], + "description": [ + "{@link AnalyticsClientInitContext }" + ], "signature": [ "AnalyticsClientInitContext" ], @@ -93,11 +111,15 @@ }, { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStoryShipper.extendContext", + "id": "def-common.FullStoryShipper.extendContext", "type": "Function", - "tags": [], + "tags": [ + "inheritDoc" + ], "label": "extendContext", - "description": [], + "description": [ + "\n{@inheritDoc IShipper.extendContext}" + ], "signature": [ "(newContext: ", "EventContext", @@ -108,7 +130,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStoryShipper.extendContext.$1", + "id": "def-common.FullStoryShipper.extendContext.$1", "type": "Object", "tags": [], "label": "newContext", @@ -125,11 +147,15 @@ }, { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStoryShipper.optIn", + "id": "def-common.FullStoryShipper.optIn", "type": "Function", - "tags": [], + "tags": [ + "inheritDoc" + ], "label": "optIn", - "description": [], + "description": [ + "\n{@inheritDoc IShipper.optIn}" + ], "signature": [ "(isOptedIn: boolean) => void" ], @@ -138,7 +164,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStoryShipper.optIn.$1", + "id": "def-common.FullStoryShipper.optIn.$1", "type": "boolean", "tags": [], "label": "isOptedIn", @@ -155,11 +181,15 @@ }, { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStoryShipper.reportEvents", + "id": "def-common.FullStoryShipper.reportEvents", "type": "Function", - "tags": [], + "tags": [ + "inheritDoc" + ], "label": "reportEvents", - "description": [], + "description": [ + "\n{@inheritDoc IShipper.reportEvents}" + ], "signature": [ "(events: ", "Event", @@ -170,7 +200,7 @@ "children": [ { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStoryShipper.reportEvents.$1", + "id": "def-common.FullStoryShipper.reportEvents.$1", "type": "Array", "tags": [], "label": "events", @@ -185,6 +215,21 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-common.FullStoryShipper.shutdown", + "type": "Function", + "tags": [], + "label": "shutdown", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -194,17 +239,66 @@ "interfaces": [ { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStorySnippetConfig", + "id": "def-common.FullStoryShipperConfig", + "type": "Interface", + "tags": [], + "label": "FullStoryShipperConfig", + "description": [ + "\nFullStory shipper configuration." + ], + "signature": [ + { + "pluginId": "@kbn/analytics-shippers-fullstory", + "scope": "common", + "docId": "kibKbnAnalyticsShippersFullstoryPluginApi", + "section": "def-common.FullStoryShipperConfig", + "text": "FullStoryShipperConfig" + }, + " extends ", + { + "pluginId": "@kbn/analytics-shippers-fullstory", + "scope": "common", + "docId": "kibKbnAnalyticsShippersFullstoryPluginApi", + "section": "def-common.FullStorySnippetConfig", + "text": "FullStorySnippetConfig" + } + ], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-common.FullStoryShipperConfig.eventTypesAllowlist", + "type": "Array", + "tags": [], + "label": "eventTypesAllowlist", + "description": [ + "\nFullStory's custom events rate limit is very aggressive.\nIf this setting is provided, it'll only send the event types specified in this list." + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/analytics-shippers-fullstory", + "id": "def-common.FullStorySnippetConfig", "type": "Interface", "tags": [], "label": "FullStorySnippetConfig", - "description": [], + "description": [ + "\nFullStory basic configuration." + ], "path": "packages/analytics/shippers/fullstory/src/load_snippet.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStorySnippetConfig.fullStoryOrgId", + "id": "def-common.FullStorySnippetConfig.fullStoryOrgId", "type": "string", "tags": [], "label": "fullStoryOrgId", @@ -216,7 +310,7 @@ }, { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStorySnippetConfig.host", + "id": "def-common.FullStorySnippetConfig.host", "type": "string", "tags": [], "label": "host", @@ -231,7 +325,7 @@ }, { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStorySnippetConfig.scriptUrl", + "id": "def-common.FullStorySnippetConfig.scriptUrl", "type": "string", "tags": [], "label": "scriptUrl", @@ -246,7 +340,7 @@ }, { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStorySnippetConfig.debug", + "id": "def-common.FullStorySnippetConfig.debug", "type": "CompoundType", "tags": [], "label": "debug", @@ -261,7 +355,7 @@ }, { "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStorySnippetConfig.namespace", + "id": "def-common.FullStorySnippetConfig.namespace", "type": "string", "tags": [], "label": "namespace", @@ -279,35 +373,6 @@ } ], "enums": [], - "misc": [ - { - "parentPluginId": "@kbn/analytics-shippers-fullstory", - "id": "def-server.FullStoryShipperConfig", - "type": "Type", - "tags": [], - "label": "FullStoryShipperConfig", - "description": [], - "signature": [ - { - "pluginId": "@kbn/analytics-shippers-fullstory", - "scope": "server", - "docId": "kibKbnAnalyticsShippersFullstoryPluginApi", - "section": "def-server.FullStorySnippetConfig", - "text": "FullStorySnippetConfig" - } - ], - "path": "packages/analytics/shippers/fullstory/src/fullstory_shipper.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], "misc": [], "objects": [] } diff --git a/api_docs/kbn_analytics_shippers_fullstory.mdx b/api_docs/kbn_analytics_shippers_fullstory.mdx index 326388928255e..494f04c7c43b2 100644 --- a/api_docs/kbn_analytics_shippers_fullstory.mdx +++ b/api_docs/kbn_analytics_shippers_fullstory.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory title: "@kbn/analytics-shippers-fullstory" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/analytics-shippers-fullstory plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,16 +18,13 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 18 | 0 | 13 | 0 | +| 20 | 0 | 4 | 0 | -## Server +## Common ### Classes - + ### Interfaces - - -### Consts, variables and types - + diff --git a/api_docs/kbn_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index 5e544916f7581..be9d9e7d05c2b 100644 --- a/api_docs/kbn_apm_config_loader.mdx +++ b/api_docs/kbn_apm_config_loader.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader title: "@kbn/apm-config-loader" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-config-loader plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx index 6b8bd73db26cd..9dd20f183b9a3 100644 --- a/api_docs/kbn_apm_utils.mdx +++ b/api_docs/kbn_apm_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils title: "@kbn/apm-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-utils plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_axe_config.mdx b/api_docs/kbn_axe_config.mdx index 91196a5c6fff9..e65bbf192fd7f 100644 --- a/api_docs/kbn_axe_config.mdx +++ b/api_docs/kbn_axe_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config title: "@kbn/axe-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/axe-config plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_bazel_packages.mdx b/api_docs/kbn_bazel_packages.mdx index a6dbbd7872270..d92763dd2d556 100644 --- a/api_docs/kbn_bazel_packages.mdx +++ b/api_docs/kbn_bazel_packages.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-packages title: "@kbn/bazel-packages" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/bazel-packages plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-packages'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_bazel_runner.mdx b/api_docs/kbn_bazel_runner.mdx index e26e06d6d8241..d9968b151fef0 100644 --- a/api_docs/kbn_bazel_runner.mdx +++ b/api_docs/kbn_bazel_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-runner title: "@kbn/bazel-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/bazel-runner plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-runner'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ci_stats_client.devdocs.json b/api_docs/kbn_ci_stats_client.devdocs.json deleted file mode 100644 index bc6b6ba628f44..0000000000000 --- a/api_docs/kbn_ci_stats_client.devdocs.json +++ /dev/null @@ -1,158 +0,0 @@ -{ - "id": "@kbn/ci-stats-client", - "client": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] - }, - "server": { - "classes": [ - { - "parentPluginId": "@kbn/ci-stats-client", - "id": "def-server.CiStatsClient", - "type": "Class", - "tags": [], - "label": "CiStatsClient", - "description": [], - "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/ci-stats-client", - "id": "def-server.CiStatsClient.fromEnv", - "type": "Function", - "tags": [], - "label": "fromEnv", - "description": [ - "\nCreate a CiStatsReporter by inspecting the ENV for the necessary config" - ], - "signature": [ - "(log: ", - "ToolingLog", - ") => ", - { - "pluginId": "@kbn/ci-stats-client", - "scope": "server", - "docId": "kibKbnCiStatsClientPluginApi", - "section": "def-server.CiStatsClient", - "text": "CiStatsClient" - } - ], - "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/ci-stats-client", - "id": "def-server.CiStatsClient.fromEnv.$1", - "type": "Object", - "tags": [], - "label": "log", - "description": [], - "signature": [ - "ToolingLog" - ], - "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/ci-stats-client", - "id": "def-server.CiStatsClient.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/ci-stats-client", - "id": "def-server.CiStatsClient.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "Config", - " | undefined" - ], - "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/ci-stats-client", - "id": "def-server.CiStatsClient.isEnabled", - "type": "Function", - "tags": [], - "label": "isEnabled", - "description": [], - "signature": [ - "() => boolean" - ], - "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/ci-stats-client", - "id": "def-server.CiStatsClient.getLatestTestGroupStats", - "type": "Function", - "tags": [], - "label": "getLatestTestGroupStats", - "description": [], - "signature": [ - "(options: LatestTestGroupStatsOptions) => Promise" - ], - "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/ci-stats-client", - "id": "def-server.CiStatsClient.getLatestTestGroupStats.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "LatestTestGroupStatsOptions" - ], - "path": "packages/kbn-ci-stats-client/src/ci_stats_client.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] - } -} \ No newline at end of file diff --git a/api_docs/kbn_ci_stats_core.mdx b/api_docs/kbn_ci_stats_core.mdx index a309e10212e64..3debd9472a83d 100644 --- a/api_docs/kbn_ci_stats_core.mdx +++ b/api_docs/kbn_ci_stats_core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core title: "@kbn/ci-stats-core" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-core plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ci_stats_reporter.devdocs.json b/api_docs/kbn_ci_stats_reporter.devdocs.json index f579d304c08db..7c0232b6d81dd 100644 --- a/api_docs/kbn_ci_stats_reporter.devdocs.json +++ b/api_docs/kbn_ci_stats_reporter.devdocs.json @@ -282,7 +282,7 @@ "section": "def-server.CiStatsReportTestsOptions", "text": "CiStatsReportTestsOptions" }, - ") => Promise" + ") => Promise" ], "path": "packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts", "deprecated": false, @@ -577,6 +577,21 @@ "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", "deprecated": false }, + { + "parentPluginId": "@kbn/ci-stats-reporter", + "id": "def-server.CiStatsTestGroupInfo.result", + "type": "CompoundType", + "tags": [], + "label": "result", + "description": [ + "\nOverall result of this test group" + ], + "signature": [ + "\"fail\" | \"pass\" | \"skip\"" + ], + "path": "packages/kbn-ci-stats-reporter/src/ci_stats_test_group_types.ts", + "deprecated": false + }, { "parentPluginId": "@kbn/ci-stats-reporter", "id": "def-server.CiStatsTestGroupInfo.meta", diff --git a/api_docs/kbn_ci_stats_reporter.mdx b/api_docs/kbn_ci_stats_reporter.mdx index 0cc182de00726..eb8fe1ea645f2 100644 --- a/api_docs/kbn_ci_stats_reporter.mdx +++ b/api_docs/kbn_ci_stats_reporter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter title: "@kbn/ci-stats-reporter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-reporter plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 59 | 0 | 15 | 0 | +| 60 | 0 | 15 | 0 | ## Server diff --git a/api_docs/kbn_cli_dev_mode.mdx b/api_docs/kbn_cli_dev_mode.mdx index 5f3a928f804bc..475736d3d94b5 100644 --- a/api_docs/kbn_cli_dev_mode.mdx +++ b/api_docs/kbn_cli_dev_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode title: "@kbn/cli-dev-mode" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/cli-dev-mode plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx index 6138cd2a95837..0dab3fa913136 100644 --- a/api_docs/kbn_coloring.mdx +++ b/api_docs/kbn_coloring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-coloring title: "@kbn/coloring" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/coloring plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_config.devdocs.json b/api_docs/kbn_config.devdocs.json index f87e73f517cbe..fd6d8be1ae176 100644 --- a/api_docs/kbn_config.devdocs.json +++ b/api_docs/kbn_config.devdocs.json @@ -254,6 +254,21 @@ ], "path": "packages/kbn-config/src/deprecation/types.ts", "deprecated": false + }, + { + "parentPluginId": "@kbn/config", + "id": "def-server.ConfigDeprecationContext.docLinks", + "type": "Object", + "tags": [], + "label": "docLinks", + "description": [ + "Allow direct access to the doc links from the deprecation handler" + ], + "signature": [ + "DocLinks" + ], + "path": "packages/kbn-config/src/deprecation/types.ts", + "deprecated": false } ], "initialIsOpen": false diff --git a/api_docs/kbn_config.mdx b/api_docs/kbn_config.mdx index 1ce3218bfedb3..d54225307c088 100644 --- a/api_docs/kbn_config.mdx +++ b/api_docs/kbn_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config title: "@kbn/config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 64 | 0 | 44 | 2 | +| 65 | 0 | 44 | 2 | ## Server diff --git a/api_docs/kbn_config_schema.mdx b/api_docs/kbn_config_schema.mdx index 784035631256b..3ef3259547b39 100644 --- a/api_docs/kbn_config_schema.mdx +++ b/api_docs/kbn_config_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema title: "@kbn/config-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config-schema plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_crypto.mdx b/api_docs/kbn_crypto.mdx index f044e9213163c..718cf77fefe1c 100644 --- a/api_docs/kbn_crypto.mdx +++ b/api_docs/kbn_crypto.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-crypto title: "@kbn/crypto" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/crypto plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx index 782b942ba952b..ded8431106421 100644 --- a/api_docs/kbn_datemath.mdx +++ b/api_docs/kbn_datemath.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-datemath title: "@kbn/datemath" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/datemath plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_dev_cli_errors.devdocs.json b/api_docs/kbn_dev_cli_errors.devdocs.json new file mode 100644 index 0000000000000..df3e10099f15f --- /dev/null +++ b/api_docs/kbn_dev_cli_errors.devdocs.json @@ -0,0 +1,166 @@ +{ + "id": "@kbn/dev-cli-errors", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/dev-cli-errors", + "id": "def-server.combineErrors", + "type": "Function", + "tags": [], + "label": "combineErrors", + "description": [], + "signature": [ + "(errors: (Error | FailError)[]) => Error" + ], + "path": "packages/kbn-dev-cli-errors/src/dev_cli_errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-errors", + "id": "def-server.combineErrors.$1", + "type": "Array", + "tags": [], + "label": "errors", + "description": [], + "signature": [ + "(Error | FailError)[]" + ], + "path": "packages/kbn-dev-cli-errors/src/dev_cli_errors.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-cli-errors", + "id": "def-server.createFailError", + "type": "Function", + "tags": [], + "label": "createFailError", + "description": [], + "signature": [ + "(reason: string, options: FailErrorOptions) => FailError" + ], + "path": "packages/kbn-dev-cli-errors/src/dev_cli_errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-errors", + "id": "def-server.createFailError.$1", + "type": "string", + "tags": [], + "label": "reason", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-dev-cli-errors/src/dev_cli_errors.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/dev-cli-errors", + "id": "def-server.createFailError.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "FailErrorOptions" + ], + "path": "packages/kbn-dev-cli-errors/src/dev_cli_errors.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-cli-errors", + "id": "def-server.createFlagError", + "type": "Function", + "tags": [], + "label": "createFlagError", + "description": [], + "signature": [ + "(reason: string) => FailError" + ], + "path": "packages/kbn-dev-cli-errors/src/dev_cli_errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-errors", + "id": "def-server.createFlagError.$1", + "type": "string", + "tags": [], + "label": "reason", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-dev-cli-errors/src/dev_cli_errors.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-cli-errors", + "id": "def-server.isFailError", + "type": "Function", + "tags": [], + "label": "isFailError", + "description": [], + "signature": [ + "(error: any) => boolean" + ], + "path": "packages/kbn-dev-cli-errors/src/dev_cli_errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-errors", + "id": "def-server.isFailError.$1", + "type": "Any", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-dev-cli-errors/src/dev_cli_errors.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_ci_stats_client.mdx b/api_docs/kbn_dev_cli_errors.mdx similarity index 52% rename from api_docs/kbn_ci_stats_client.mdx rename to api_docs/kbn_dev_cli_errors.mdx index 7e081672825d1..7d2e623535ba2 100644 --- a/api_docs/kbn_ci_stats_client.mdx +++ b/api_docs/kbn_dev_cli_errors.mdx @@ -1,14 +1,14 @@ --- -id: kibKbnCiStatsClientPluginApi -slug: /kibana-dev-docs/api/kbn-ci-stats-client -title: "@kbn/ci-stats-client" +id: kibKbnDevCliErrorsPluginApi +slug: /kibana-dev-docs/api/kbn-dev-cli-errors +title: "@kbn/dev-cli-errors" image: https://source.unsplash.com/400x175/?github -summary: API docs for the @kbn/ci-stats-client plugin -date: 2022-04-26 -tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-client'] +summary: API docs for the @kbn/dev-cli-errors plugin +date: 2022-05-24 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-errors'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- -import kbnCiStatsClientObj from './kbn_ci_stats_client.devdocs.json'; +import kbnDevCliErrorsObj from './kbn_dev_cli_errors.devdocs.json'; @@ -18,10 +18,10 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 8 | 0 | 7 | 0 | +| 9 | 1 | 9 | 0 | ## Server -### Classes - +### Functions + diff --git a/api_docs/kbn_dev_cli_runner.devdocs.json b/api_docs/kbn_dev_cli_runner.devdocs.json new file mode 100644 index 0000000000000..f3523e04e5a20 --- /dev/null +++ b/api_docs/kbn_dev_cli_runner.devdocs.json @@ -0,0 +1,1163 @@ +{ + "id": "@kbn/dev-cli-runner", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunWithCommands", + "type": "Class", + "tags": [], + "label": "RunWithCommands", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunWithCommands", + "text": "RunWithCommands" + }, + "" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunWithCommands.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunWithCommands.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunWithCommandsOptions", + "text": "RunWithCommandsOptions" + }, + "" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunWithCommands.Unnamed.$2", + "type": "Array", + "tags": [], + "label": "commands", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.Command", + "text": "Command" + }, + "[]" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunWithCommands.command", + "type": "Function", + "tags": [], + "label": "command", + "description": [], + "signature": [ + "(options: ", + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.Command", + "text": "Command" + }, + ") => ", + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunWithCommands", + "text": "RunWithCommands" + }, + "" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunWithCommands.command.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.Command", + "text": "Command" + }, + "" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunWithCommands.execute", + "type": "Function", + "tags": [], + "label": "execute", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.getFlags", + "type": "Function", + "tags": [], + "label": "getFlags", + "description": [], + "signature": [ + "(argv: string[], flagOptions: ", + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" + }, + " | undefined, defaultLogLevel: string) => ", + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.Flags", + "text": "Flags" + } + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.getFlags.$1", + "type": "Array", + "tags": [], + "label": "argv", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.getFlags.$2", + "type": "Object", + "tags": [], + "label": "flagOptions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" + }, + " | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.getFlags.$3", + "type": "string", + "tags": [], + "label": "defaultLogLevel", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.mergeFlagOptions", + "type": "Function", + "tags": [], + "label": "mergeFlagOptions", + "description": [], + "signature": [ + "(global: ", + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" + }, + ", local: ", + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" + }, + ") => ", + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" + } + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.mergeFlagOptions.$1", + "type": "Object", + "tags": [], + "label": "global", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" + } + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.mergeFlagOptions.$2", + "type": "Object", + "tags": [], + "label": "local", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" + } + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.run", + "type": "Function", + "tags": [], + "label": "run", + "description": [], + "signature": [ + "(fn: ", + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunFn", + "text": "RunFn" + }, + ", options: ", + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunOptions", + "text": "RunOptions" + }, + ") => Promise" + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.run.$1", + "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunFn", + "text": "RunFn" + } + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.run.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunOptions", + "text": "RunOptions" + } + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Command", + "type": "Interface", + "tags": [], + "label": "Command", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.Command", + "text": "Command" + }, + "" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Command.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Command.run", + "type": "Function", + "tags": [], + "label": "run", + "description": [], + "signature": [ + "(context: ", + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunContext", + "text": "RunContext" + }, + " & T) => void | Promise" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Command.run.$1", + "type": "CompoundType", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunContext", + "text": "RunContext" + }, + " & T" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Command.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Command.usage", + "type": "string", + "tags": [], + "label": "usage", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Command.flags", + "type": "Object", + "tags": [], + "label": "flags", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" + }, + " | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.FlagOptions", + "type": "Interface", + "tags": [], + "label": "FlagOptions", + "description": [], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.FlagOptions.allowUnexpected", + "type": "CompoundType", + "tags": [], + "label": "allowUnexpected", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.FlagOptions.guessTypesForUnexpectedFlags", + "type": "CompoundType", + "tags": [], + "label": "guessTypesForUnexpectedFlags", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.FlagOptions.help", + "type": "string", + "tags": [], + "label": "help", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.FlagOptions.alias", + "type": "Object", + "tags": [], + "label": "alias", + "description": [], + "signature": [ + "{ [key: string]: string | string[]; } | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.FlagOptions.boolean", + "type": "Array", + "tags": [], + "label": "boolean", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.FlagOptions.string", + "type": "Array", + "tags": [], + "label": "string", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.FlagOptions.default", + "type": "Object", + "tags": [], + "label": "default", + "description": [], + "signature": [ + "{ [key: string]: any; } | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Flags", + "type": "Interface", + "tags": [], + "label": "Flags", + "description": [], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Flags.verbose", + "type": "boolean", + "tags": [], + "label": "verbose", + "description": [], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Flags.quiet", + "type": "boolean", + "tags": [], + "label": "quiet", + "description": [], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Flags.silent", + "type": "boolean", + "tags": [], + "label": "silent", + "description": [], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Flags.debug", + "type": "boolean", + "tags": [], + "label": "debug", + "description": [], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Flags.help", + "type": "boolean", + "tags": [], + "label": "help", + "description": [], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Flags._", + "type": "Array", + "tags": [], + "label": "_", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Flags.unexpected", + "type": "Array", + "tags": [], + "label": "unexpected", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.Flags.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: string | boolean | string[] | undefined", + "description": [], + "signature": [ + "[key: string]: string | boolean | string[] | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/flags.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunContext", + "type": "Interface", + "tags": [], + "label": "RunContext", + "description": [], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunContext.log", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "ToolingLog" + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunContext.flags", + "type": "Object", + "tags": [], + "label": "flags", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.Flags", + "text": "Flags" + } + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunContext.procRunner", + "type": "Object", + "tags": [], + "label": "procRunner", + "description": [], + "signature": [ + "ProcRunner" + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunContext.statsMeta", + "type": "Object", + "tags": [], + "label": "statsMeta", + "description": [], + "signature": [ + "Map" + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunContext.addCleanupTask", + "type": "Function", + "tags": [], + "label": "addCleanupTask", + "description": [], + "signature": [ + "(task: ", + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.CleanupTask", + "text": "CleanupTask" + }, + ") => void" + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunContext.addCleanupTask.$1", + "type": "Function", + "tags": [], + "label": "task", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.CleanupTask", + "text": "CleanupTask" + } + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunOptions", + "type": "Interface", + "tags": [], + "label": "RunOptions", + "description": [], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunOptions.usage", + "type": "string", + "tags": [], + "label": "usage", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunOptions.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunOptions.log", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "{ defaultLevel?: \"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunOptions.flags", + "type": "Object", + "tags": [], + "label": "flags", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" + }, + " | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunWithCommandsOptions", + "type": "Interface", + "tags": [], + "label": "RunWithCommandsOptions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunWithCommandsOptions", + "text": "RunWithCommandsOptions" + }, + "" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunWithCommandsOptions.log", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "{ defaultLevel?: \"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunWithCommandsOptions.description", + "type": "string", + "tags": [], + "label": "description", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunWithCommandsOptions.usage", + "type": "string", + "tags": [], + "label": "usage", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunWithCommandsOptions.globalFlags", + "type": "Object", + "tags": [], + "label": "globalFlags", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.FlagOptions", + "text": "FlagOptions" + }, + " | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunWithCommandsOptions.extendContext", + "type": "Function", + "tags": [], + "label": "extendContext", + "description": [], + "signature": [ + "((context: ", + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunContext", + "text": "RunContext" + }, + ") => T | Promise) | undefined" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunWithCommandsOptions.extendContext.$1", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunContext", + "text": "RunContext" + } + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.CleanupTask", + "type": "Type", + "tags": [], + "label": "CleanupTask", + "description": [ + "\nA function which will be called when the CLI is torn-down which should\nquickly cleanup whatever it needs." + ], + "signature": [ + "() => void" + ], + "path": "packages/kbn-dev-cli-runner/src/cleanup.ts", + "deprecated": false, + "returnComment": [], + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.CommandRunFn", + "type": "Type", + "tags": [], + "label": "CommandRunFn", + "description": [], + "signature": [ + "(context: ", + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunContext", + "text": "RunContext" + }, + " & T) => void | Promise" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.CommandRunFn.$1", + "type": "CompoundType", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunContext", + "text": "RunContext" + }, + " & T" + ], + "path": "packages/kbn-dev-cli-runner/src/run_with_commands.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunFn", + "type": "Type", + "tags": [], + "label": "RunFn", + "description": [], + "signature": [ + "(context: ", + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunContext", + "text": "RunContext" + }, + ") => void | Promise" + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/dev-cli-runner", + "id": "def-server.RunFn.$1", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "@kbn/dev-cli-runner", + "scope": "server", + "docId": "kibKbnDevCliRunnerPluginApi", + "section": "def-server.RunContext", + "text": "RunContext" + } + ], + "path": "packages/kbn-dev-cli-runner/src/run.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_dev_cli_runner.mdx b/api_docs/kbn_dev_cli_runner.mdx new file mode 100644 index 0000000000000..56055ee3b9030 --- /dev/null +++ b/api_docs/kbn_dev_cli_runner.mdx @@ -0,0 +1,36 @@ +--- +id: kibKbnDevCliRunnerPluginApi +slug: /kibana-dev-docs/api/kbn-dev-cli-runner +title: "@kbn/dev-cli-runner" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/dev-cli-runner plugin +date: 2022-05-24 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-runner'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnDevCliRunnerObj from './kbn_dev_cli_runner.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 65 | 0 | 64 | 0 | + +## Server + +### Functions + + +### Classes + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_dev_proc_runner.devdocs.json b/api_docs/kbn_dev_proc_runner.devdocs.json new file mode 100644 index 0000000000000..875359f3f36d9 --- /dev/null +++ b/api_docs/kbn_dev_proc_runner.devdocs.json @@ -0,0 +1,288 @@ +{ + "id": "@kbn/dev-proc-runner", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.ProcRunner", + "type": "Class", + "tags": [ + "class" + ], + "label": "ProcRunner", + "description": [ + "\n Helper for starting and managing processes. In many ways it resembles the\n API from `grunt_run`, processes are named and can be started, waited for,\n backgrounded once they log something matching a RegExp...\n" + ], + "path": "packages/kbn-dev-proc-runner/src/proc_runner.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.ProcRunner.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-dev-proc-runner/src/proc_runner.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.ProcRunner.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "ToolingLog" + ], + "path": "packages/kbn-dev-proc-runner/src/proc_runner.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.ProcRunner.run", + "type": "Function", + "tags": [], + "label": "run", + "description": [ + "\n Start a process, tracking it by `name`" + ], + "signature": [ + "(name: string, options: RunOptions) => Promise" + ], + "path": "packages/kbn-dev-proc-runner/src/proc_runner.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.ProcRunner.run.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-dev-proc-runner/src/proc_runner.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.ProcRunner.run.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "RunOptions" + ], + "path": "packages/kbn-dev-proc-runner/src/proc_runner.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.ProcRunner.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [ + "\n Stop a named proc" + ], + "signature": [ + "(name: string, signal?: NodeJS.Signals) => Promise" + ], + "path": "packages/kbn-dev-proc-runner/src/proc_runner.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.ProcRunner.stop.$1", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-dev-proc-runner/src/proc_runner.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.ProcRunner.stop.$2", + "type": "CompoundType", + "tags": [], + "label": "signal", + "description": [], + "signature": [ + "NodeJS.Signals" + ], + "path": "packages/kbn-dev-proc-runner/src/proc_runner.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.ProcRunner.waitForAllToStop", + "type": "Function", + "tags": [ + "return" + ], + "label": "waitForAllToStop", + "description": [ + "\n Wait for all running processes to stop naturally" + ], + "signature": [ + "() => Promise" + ], + "path": "packages/kbn-dev-proc-runner/src/proc_runner.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.ProcRunner.teardown", + "type": "Function", + "tags": [ + "return" + ], + "label": "teardown", + "description": [ + "\n Close the ProcRunner and stop all running\n processes with `signal`\n" + ], + "signature": [ + "(signal?: \"exit\" | NodeJS.Signals) => Promise" + ], + "path": "packages/kbn-dev-proc-runner/src/proc_runner.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.ProcRunner.teardown.$1", + "type": "CompoundType", + "tags": [], + "label": "signal", + "description": [], + "signature": [ + "\"exit\" | NodeJS.Signals" + ], + "path": "packages/kbn-dev-proc-runner/src/proc_runner.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [ + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.withProcRunner", + "type": "Function", + "tags": [ + "return" + ], + "label": "withProcRunner", + "description": [ + "\n Create a ProcRunner and pass it to an async function. When\n the async function finishes the ProcRunner is torn-down\n automatically\n" + ], + "signature": [ + "(log: ", + "ToolingLog", + ", fn: (procs: ", + { + "pluginId": "@kbn/dev-proc-runner", + "scope": "server", + "docId": "kibKbnDevProcRunnerPluginApi", + "section": "def-server.ProcRunner", + "text": "ProcRunner" + }, + ") => Promise) => Promise" + ], + "path": "packages/kbn-dev-proc-runner/src/with_proc_runner.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.withProcRunner.$1", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "ToolingLog" + ], + "path": "packages/kbn-dev-proc-runner/src/with_proc_runner.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/dev-proc-runner", + "id": "def-server.withProcRunner.$2", + "type": "Function", + "tags": [], + "label": "fn", + "description": [], + "signature": [ + "(procs: ", + { + "pluginId": "@kbn/dev-proc-runner", + "scope": "server", + "docId": "kibKbnDevProcRunnerPluginApi", + "section": "def-server.ProcRunner", + "text": "ProcRunner" + }, + ") => Promise" + ], + "path": "packages/kbn-dev-proc-runner/src/with_proc_runner.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_dev_proc_runner.mdx b/api_docs/kbn_dev_proc_runner.mdx new file mode 100644 index 0000000000000..45b27ecf3c15b --- /dev/null +++ b/api_docs/kbn_dev_proc_runner.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnDevProcRunnerPluginApi +slug: /kibana-dev-docs/api/kbn-dev-proc-runner +title: "@kbn/dev-proc-runner" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/dev-proc-runner plugin +date: 2022-05-24 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-proc-runner'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnDevProcRunnerObj from './kbn_dev_proc_runner.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 15 | 0 | 9 | 0 | + +## Server + +### Functions + + +### Classes + + diff --git a/api_docs/kbn_dev_utils.devdocs.json b/api_docs/kbn_dev_utils.devdocs.json index 7ffb74a9f9220..6ff8061e664cf 100644 --- a/api_docs/kbn_dev_utils.devdocs.json +++ b/api_docs/kbn_dev_utils.devdocs.json @@ -9,463 +9,8 @@ "objects": [] }, "server": { - "classes": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner", - "type": "Class", - "tags": [ - "class" - ], - "label": "ProcRunner", - "description": [ - "\n Helper for starting and managing processes. In many ways it resembles the\n API from `grunt_run`, processes are named and can be started, waited for,\n backgrounded once they log something matching a RegExp...\n" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "log", - "description": [], - "signature": [ - "ToolingLog" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.run", - "type": "Function", - "tags": [ - "property", - "property", - "property", - "property", - "return" - ], - "label": "run", - "description": [ - "\n Start a process, tracking it by `name`" - ], - "signature": [ - "(name: string, options: RunOptions) => Promise" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.run.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.run.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "RunOptions" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.stop", - "type": "Function", - "tags": [], - "label": "stop", - "description": [ - "\n Stop a named proc" - ], - "signature": [ - "(name: string, signal?: NodeJS.Signals) => Promise" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.stop.$1", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.stop.$2", - "type": "CompoundType", - "tags": [], - "label": "signal", - "description": [], - "signature": [ - "NodeJS.Signals" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.waitForAllToStop", - "type": "Function", - "tags": [ - "return" - ], - "label": "waitForAllToStop", - "description": [ - "\n Wait for all running processes to stop naturally" - ], - "signature": [ - "() => Promise" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.teardown", - "type": "Function", - "tags": [ - "return" - ], - "label": "teardown", - "description": [ - "\n Close the ProcRunner and stop all running\n processes with `signal`\n" - ], - "signature": [ - "(signal?: \"exit\" | NodeJS.Signals) => Promise" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.ProcRunner.teardown.$1", - "type": "CompoundType", - "tags": [], - "label": "signal", - "description": [], - "signature": [ - "\"exit\" | NodeJS.Signals" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/proc_runner.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommands", - "type": "Class", - "tags": [], - "label": "RunWithCommands", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunWithCommands", - "text": "RunWithCommands" - }, - "" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommands.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommands.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunWithCommandsOptions", - "text": "RunWithCommandsOptions" - }, - "" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommands.Unnamed.$2", - "type": "Array", - "tags": [], - "label": "commands", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Command", - "text": "Command" - }, - "[]" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommands.command", - "type": "Function", - "tags": [], - "label": "command", - "description": [], - "signature": [ - "(options: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Command", - "text": "Command" - }, - ") => ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunWithCommands", - "text": "RunWithCommands" - }, - "" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommands.command.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Command", - "text": "Command" - }, - "" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommands.execute", - "type": "Function", - "tags": [], - "label": "execute", - "description": [], - "signature": [ - "() => Promise" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], + "classes": [], "functions": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.combineErrors", - "type": "Function", - "tags": [], - "label": "combineErrors", - "description": [], - "signature": [ - "(errors: (Error | FailError)[]) => Error" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.combineErrors.$1", - "type": "Array", - "tags": [], - "label": "errors", - "description": [], - "signature": [ - "(Error | FailError)[]" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createFailError", - "type": "Function", - "tags": [], - "label": "createFailError", - "description": [], - "signature": [ - "(reason: string, options: FailErrorOptions) => FailError" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createFailError.$1", - "type": "string", - "tags": [], - "label": "reason", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createFailError.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "FailErrorOptions" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createFlagError", - "type": "Function", - "tags": [], - "label": "createFlagError", - "description": [], - "signature": [ - "(reason: string) => FailError" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.createFlagError.$1", - "type": "string", - "tags": [], - "label": "reason", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/dev-utils", "id": "def-server.diffStrings", @@ -546,87 +91,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.getFlags", - "type": "Function", - "tags": [], - "label": "getFlags", - "description": [], - "signature": [ - "(argv: string[], flagOptions: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - }, - " | undefined, defaultLogLevel: string) => ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Flags", - "text": "Flags" - } - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.getFlags.$1", - "type": "Array", - "tags": [], - "label": "argv", - "description": [], - "signature": [ - "string[]" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.getFlags.$2", - "type": "Object", - "tags": [], - "label": "flagOptions", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - }, - " | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.getFlags.$3", - "type": "string", - "tags": [], - "label": "defaultLogLevel", - "description": [], - "signature": [ - "string" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/dev-utils", "id": "def-server.isAxiosRequestError", @@ -706,199 +170,15 @@ }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.isFailError", + "id": "def-server.runPluginListCli", "type": "Function", "tags": [], - "label": "isFailError", + "label": "runPluginListCli", "description": [], "signature": [ - "(error: any) => boolean" + "() => void" ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.isFailError.$1", - "type": "Any", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "any" - ], - "path": "packages/kbn-dev-utils/src/run/fail.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.mergeFlagOptions", - "type": "Function", - "tags": [], - "label": "mergeFlagOptions", - "description": [], - "signature": [ - "(global: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - }, - ", local: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - }, - ") => ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - } - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.mergeFlagOptions.$1", - "type": "Object", - "tags": [], - "label": "global", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - } - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.mergeFlagOptions.$2", - "type": "Object", - "tags": [], - "label": "local", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - } - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.run", - "type": "Function", - "tags": [], - "label": "run", - "description": [], - "signature": [ - "(fn: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunFn", - "text": "RunFn" - }, - ", options: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunOptions", - "text": "RunOptions" - }, - ") => Promise" - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.run.$1", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunFn", - "text": "RunFn" - } - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.run.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunOptions", - "text": "RunOptions" - } - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.runPluginListCli", - "type": "Function", - "tags": [], - "label": "runPluginListCli", - "description": [], - "signature": [ - "() => void" - ], - "path": "packages/kbn-dev-utils/src/plugin_list/run_plugin_list_cli.ts", + "path": "packages/kbn-dev-utils/src/plugin_list/run_plugin_list_cli.ts", "deprecated": false, "children": [], "returnComment": [], @@ -926,963 +206,185 @@ "type": "Function", "tags": [], "label": "shipCiStatsCli", - "description": [], - "signature": [ - "() => void" - ], - "path": "packages/kbn-dev-utils/src/ship_ci_stats_cli.ts", - "deprecated": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.transformFileStream", - "type": "Function", - "tags": [], - "label": "transformFileStream", - "description": [ - "\nCreate a transform stream that processes Vinyl fs streams and\ncalls a function for each file, allowing the function to either\nmutate the file, replace it with another file (return a new File\nobject), or drop it from the stream (return null)" - ], - "signature": [ - "(fn: (file: BufferedFile) => void | ", - "node_modules/@types/vinyl/index", - " | Promise | null) => ", - "Transform" - ], - "path": "packages/kbn-dev-utils/src/streams.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.transformFileStream.$1", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "(file: BufferedFile) => void | ", - "node_modules/@types/vinyl/index", - " | Promise | null" - ], - "path": "packages/kbn-dev-utils/src/streams.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.transformFileWithBabel", - "type": "Function", - "tags": [], - "label": "transformFileWithBabel", - "description": [ - "\nReturns a promise that resolves when the file has been\nmutated so the contents of the file are tranformed with\nbabel, include inline sourcemaps, and the filename has\nbeen updated to use .js.\n\nIf the file was previously transformed with this function\nthe promise will just resolve immediately." - ], - "signature": [ - "(file: ", - "node_modules/@types/vinyl/index", - ") => Promise" - ], - "path": "packages/kbn-dev-utils/src/babel.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.transformFileWithBabel.$1", - "type": "Object", - "tags": [], - "label": "file", - "description": [], - "signature": [ - "node_modules/@types/vinyl/index" - ], - "path": "packages/kbn-dev-utils/src/babel.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.withProcRunner", - "type": "Function", - "tags": [ - "return" - ], - "label": "withProcRunner", - "description": [ - "\n Create a ProcRunner and pass it to an async function. When\n the async function finishes the ProcRunner is torn-down\n automatically\n" - ], - "signature": [ - "(log: ", - "ToolingLog", - ", fn: (procs: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ProcRunner", - "text": "ProcRunner" - }, - ") => Promise) => Promise" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/with_proc_runner.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.withProcRunner.$1", - "type": "Object", - "tags": [], - "label": "log", - "description": [], - "signature": [ - "ToolingLog" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/with_proc_runner.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.withProcRunner.$2", - "type": "Function", - "tags": [], - "label": "fn", - "description": [], - "signature": [ - "(procs: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ProcRunner", - "text": "ProcRunner" - }, - ") => Promise" - ], - "path": "packages/kbn-dev-utils/src/proc_runner/with_proc_runner.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.AxiosRequestError", - "type": "Interface", - "tags": [], - "label": "AxiosRequestError", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.AxiosRequestError", - "text": "AxiosRequestError" - }, - " extends ", - "AxiosError", - "" - ], - "path": "packages/kbn-dev-utils/src/axios/errors.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.AxiosRequestError.response", - "type": "Uncategorized", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "undefined" - ], - "path": "packages/kbn-dev-utils/src/axios/errors.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.AxiosResponseError", - "type": "Interface", - "tags": [], - "label": "AxiosResponseError", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.AxiosResponseError", - "text": "AxiosResponseError" - }, - " extends ", - "AxiosError", - "" - ], - "path": "packages/kbn-dev-utils/src/axios/errors.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.AxiosResponseError.response", - "type": "Object", - "tags": [], - "label": "response", - "description": [], - "signature": [ - "AxiosResponse", - "" - ], - "path": "packages/kbn-dev-utils/src/axios/errors.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Command", - "type": "Interface", - "tags": [], - "label": "Command", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Command", - "text": "Command" - }, - "" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Command.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Command.run", - "type": "Function", - "tags": [], - "label": "run", - "description": [], - "signature": [ - "(context: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunContext", - "text": "RunContext" - }, - " & T) => void | Promise" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Command.run.$1", - "type": "CompoundType", - "tags": [], - "label": "context", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunContext", - "text": "RunContext" - }, - " & T" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Command.description", - "type": "string", - "tags": [], - "label": "description", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Command.usage", - "type": "string", - "tags": [], - "label": "usage", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Command.flags", - "type": "Object", - "tags": [], - "label": "flags", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - }, - " | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.FlagOptions", - "type": "Interface", - "tags": [], - "label": "FlagOptions", - "description": [], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.FlagOptions.allowUnexpected", - "type": "CompoundType", - "tags": [], - "label": "allowUnexpected", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.FlagOptions.guessTypesForUnexpectedFlags", - "type": "CompoundType", - "tags": [], - "label": "guessTypesForUnexpectedFlags", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.FlagOptions.help", - "type": "string", - "tags": [], - "label": "help", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.FlagOptions.alias", - "type": "Object", - "tags": [], - "label": "alias", - "description": [], - "signature": [ - "{ [key: string]: string | string[]; } | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.FlagOptions.boolean", - "type": "Array", - "tags": [], - "label": "boolean", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.FlagOptions.string", - "type": "Array", - "tags": [], - "label": "string", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.FlagOptions.default", - "type": "Object", - "tags": [], - "label": "default", - "description": [], - "signature": [ - "{ [key: string]: any; } | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Flags", - "type": "Interface", - "tags": [], - "label": "Flags", - "description": [], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Flags.verbose", - "type": "boolean", - "tags": [], - "label": "verbose", - "description": [], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Flags.quiet", - "type": "boolean", - "tags": [], - "label": "quiet", - "description": [], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Flags.silent", - "type": "boolean", - "tags": [], - "label": "silent", - "description": [], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Flags.debug", - "type": "boolean", - "tags": [], - "label": "debug", - "description": [], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Flags.help", - "type": "boolean", - "tags": [], - "label": "help", - "description": [], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Flags._", - "type": "Array", - "tags": [], - "label": "_", - "description": [], - "signature": [ - "string[]" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Flags.unexpected", - "type": "Array", - "tags": [], - "label": "unexpected", - "description": [], - "signature": [ - "string[]" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.Flags.Unnamed", - "type": "IndexSignature", - "tags": [], - "label": "[key: string]: string | boolean | string[] | undefined", - "description": [], - "signature": [ - "[key: string]: string | boolean | string[] | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/flags.ts", - "deprecated": false - } + "description": [], + "signature": [ + "() => void" ], + "path": "packages/kbn-dev-utils/src/ship_ci_stats_cli.ts", + "deprecated": false, + "children": [], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunContext", - "type": "Interface", + "id": "def-server.transformFileStream", + "type": "Function", "tags": [], - "label": "RunContext", - "description": [], - "path": "packages/kbn-dev-utils/src/run/run.ts", + "label": "transformFileStream", + "description": [ + "\nCreate a transform stream that processes Vinyl fs streams and\ncalls a function for each file, allowing the function to either\nmutate the file, replace it with another file (return a new File\nobject), or drop it from the stream (return null)" + ], + "signature": [ + "(fn: (file: BufferedFile) => void | ", + "node_modules/@types/vinyl/index", + " | Promise | null) => ", + "Transform" + ], + "path": "packages/kbn-dev-utils/src/streams.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunContext.log", - "type": "Object", - "tags": [], - "label": "log", - "description": [], - "signature": [ - "ToolingLog" - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunContext.flags", - "type": "Object", - "tags": [], - "label": "flags", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.Flags", - "text": "Flags" - } - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunContext.procRunner", - "type": "Object", - "tags": [], - "label": "procRunner", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.ProcRunner", - "text": "ProcRunner" - } - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunContext.statsMeta", - "type": "Object", - "tags": [], - "label": "statsMeta", - "description": [], - "signature": [ - "Map" - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunContext.addCleanupTask", + "id": "def-server.transformFileStream.$1", "type": "Function", "tags": [], - "label": "addCleanupTask", + "label": "fn", "description": [], "signature": [ - "(task: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.CleanupTask", - "text": "CleanupTask" - }, - ") => void" + "(file: BufferedFile) => void | ", + "node_modules/@types/vinyl/index", + " | Promise | null" ], - "path": "packages/kbn-dev-utils/src/run/run.ts", + "path": "packages/kbn-dev-utils/src/streams.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunContext.addCleanupTask.$1", - "type": "Function", - "tags": [], - "label": "task", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.CleanupTask", - "text": "CleanupTask" - } - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunOptions", - "type": "Interface", + "id": "def-server.transformFileWithBabel", + "type": "Function", "tags": [], - "label": "RunOptions", - "description": [], - "path": "packages/kbn-dev-utils/src/run/run.ts", + "label": "transformFileWithBabel", + "description": [ + "\nReturns a promise that resolves when the file has been\nmutated so the contents of the file are tranformed with\nbabel, include inline sourcemaps, and the filename has\nbeen updated to use .js.\n\nIf the file was previously transformed with this function\nthe promise will just resolve immediately." + ], + "signature": [ + "(file: ", + "node_modules/@types/vinyl/index", + ") => Promise" + ], + "path": "packages/kbn-dev-utils/src/babel.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunOptions.usage", - "type": "string", - "tags": [], - "label": "usage", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunOptions.description", - "type": "string", - "tags": [], - "label": "description", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunOptions.log", - "type": "Object", - "tags": [], - "label": "log", - "description": [], - "signature": [ - "{ defaultLevel?: \"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunOptions.flags", + "id": "def-server.transformFileWithBabel.$1", "type": "Object", "tags": [], - "label": "flags", + "label": "file", "description": [], "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - }, - " | undefined" + "node_modules/@types/vinyl/index" ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false + "path": "packages/kbn-dev-utils/src/babel.ts", + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false - }, + } + ], + "interfaces": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommandsOptions", + "id": "def-server.AxiosRequestError", "type": "Interface", "tags": [], - "label": "RunWithCommandsOptions", + "label": "AxiosRequestError", "description": [], "signature": [ { "pluginId": "@kbn/dev-utils", "scope": "server", "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunWithCommandsOptions", - "text": "RunWithCommandsOptions" + "section": "def-server.AxiosRequestError", + "text": "AxiosRequestError" }, - "" + " extends ", + "AxiosError", + "" ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", + "path": "packages/kbn-dev-utils/src/axios/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommandsOptions.log", - "type": "Object", - "tags": [], - "label": "log", - "description": [], - "signature": [ - "{ defaultLevel?: \"error\" | \"success\" | \"warning\" | \"info\" | \"debug\" | \"silent\" | \"verbose\" | undefined; } | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommandsOptions.description", - "type": "string", - "tags": [], - "label": "description", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommandsOptions.usage", - "type": "string", - "tags": [], - "label": "usage", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommandsOptions.globalFlags", - "type": "Object", + "id": "def-server.AxiosRequestError.response", + "type": "Uncategorized", "tags": [], - "label": "globalFlags", + "label": "response", "description": [], "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.FlagOptions", - "text": "FlagOptions" - }, - " | undefined" + "undefined" ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", + "path": "packages/kbn-dev-utils/src/axios/errors.ts", "deprecated": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommandsOptions.extendContext", - "type": "Function", - "tags": [], - "label": "extendContext", - "description": [], - "signature": [ - "((context: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunContext", - "text": "RunContext" - }, - ") => T | Promise) | undefined" - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunWithCommandsOptions.extendContext.$1", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunContext", - "text": "RunContext" - } - ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] } ], "initialIsOpen": false - } - ], - "enums": [], - "misc": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CA_CERT_PATH", - "type": "string", - "tags": [], - "label": "CA_CERT_PATH", - "description": [], - "path": "packages/kbn-dev-utils/src/certs.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CleanupTask", - "type": "Type", - "tags": [], - "label": "CleanupTask", - "description": [ - "\nA function which will be called when the CLI is torn-down which should\nquickly cleanup whatever it needs." - ], - "signature": [ - "() => void" - ], - "path": "packages/kbn-dev-utils/src/run/cleanup.ts", - "deprecated": false, - "returnComment": [], - "children": [], - "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CommandRunFn", - "type": "Type", + "id": "def-server.AxiosResponseError", + "type": "Interface", "tags": [], - "label": "CommandRunFn", + "label": "AxiosResponseError", "description": [], "signature": [ - "(context: ", { "pluginId": "@kbn/dev-utils", "scope": "server", "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunContext", - "text": "RunContext" + "section": "def-server.AxiosResponseError", + "text": "AxiosResponseError" }, - " & T) => void | Promise" + " extends ", + "AxiosError", + "" ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", + "path": "packages/kbn-dev-utils/src/axios/errors.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "@kbn/dev-utils", - "id": "def-server.CommandRunFn.$1", - "type": "CompoundType", + "id": "def-server.AxiosResponseError.response", + "type": "Object", "tags": [], - "label": "context", + "label": "response", "description": [], "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunContext", - "text": "RunContext" - }, - " & T" + "AxiosResponse", + "" ], - "path": "packages/kbn-dev-utils/src/run/run_with_commands.ts", + "path": "packages/kbn-dev-utils/src/axios/errors.ts", "deprecated": false } ], "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/dev-utils", + "id": "def-server.CA_CERT_PATH", + "type": "string", + "tags": [], + "label": "CA_CERT_PATH", + "description": [], + "path": "packages/kbn-dev-utils/src/certs.ts", + "deprecated": false, + "initialIsOpen": false }, { "parentPluginId": "@kbn/dev-utils", @@ -1999,50 +501,6 @@ "path": "packages/kbn-dev-utils/src/certs.ts", "deprecated": false, "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunFn", - "type": "Type", - "tags": [], - "label": "RunFn", - "description": [], - "signature": [ - "(context: ", - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunContext", - "text": "RunContext" - }, - ") => void | Promise" - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/dev-utils", - "id": "def-server.RunFn.$1", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - { - "pluginId": "@kbn/dev-utils", - "scope": "server", - "docId": "kibKbnDevUtilsPluginApi", - "section": "def-server.RunContext", - "text": "RunContext" - } - ], - "path": "packages/kbn-dev-utils/src/run/run.ts", - "deprecated": false - } - ], - "initialIsOpen": false } ], "objects": [] diff --git a/api_docs/kbn_dev_utils.mdx b/api_docs/kbn_dev_utils.mdx index 66ac63e6464b6..40a6e1132c317 100644 --- a/api_docs/kbn_dev_utils.mdx +++ b/api_docs/kbn_dev_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-utils title: "@kbn/dev-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-utils plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,16 +18,13 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 120 | 3 | 109 | 0 | +| 31 | 2 | 27 | 0 | ## Server ### Functions -### Classes - - ### Interfaces diff --git a/api_docs/kbn_doc_links.devdocs.json b/api_docs/kbn_doc_links.devdocs.json index d0d228ea60e36..5f01f92b064de 100644 --- a/api_docs/kbn_doc_links.devdocs.json +++ b/api_docs/kbn_doc_links.devdocs.json @@ -9,11 +9,19 @@ "objects": [] }, "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/doc-links", - "id": "def-server.getDocLinks", + "id": "def-common.getDocLinks", "type": "Function", "tags": [], "label": "getDocLinks", @@ -24,9 +32,9 @@ ") => ", { "pluginId": "@kbn/doc-links", - "scope": "server", + "scope": "common", "docId": "kibKbnDocLinksPluginApi", - "section": "def-server.DocLinks", + "section": "def-common.DocLinks", "text": "DocLinks" } ], @@ -35,7 +43,7 @@ "children": [ { "parentPluginId": "@kbn/doc-links", - "id": "def-server.getDocLinks.$1", + "id": "def-common.getDocLinks.$1", "type": "Object", "tags": [], "label": "{ kibanaBranch }", @@ -53,7 +61,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.getDocLinksMeta", + "id": "def-common.getDocLinksMeta", "type": "Function", "tags": [], "label": "getDocLinksMeta", @@ -64,9 +72,9 @@ ") => ", { "pluginId": "@kbn/doc-links", - "scope": "server", + "scope": "common", "docId": "kibKbnDocLinksPluginApi", - "section": "def-server.DocLinksMeta", + "section": "def-common.DocLinksMeta", "text": "DocLinksMeta" } ], @@ -75,7 +83,7 @@ "children": [ { "parentPluginId": "@kbn/doc-links", - "id": "def-server.getDocLinksMeta.$1", + "id": "def-common.getDocLinksMeta.$1", "type": "Object", "tags": [], "label": "{ kibanaBranch }", @@ -95,7 +103,7 @@ "interfaces": [ { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks", + "id": "def-common.DocLinks", "type": "Interface", "tags": [], "label": "DocLinks", @@ -105,7 +113,7 @@ "children": [ { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.settings", + "id": "def-common.DocLinks.settings", "type": "string", "tags": [], "label": "settings", @@ -115,7 +123,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.elasticStackGetStarted", + "id": "def-common.DocLinks.elasticStackGetStarted", "type": "string", "tags": [], "label": "elasticStackGetStarted", @@ -125,7 +133,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.upgrade", + "id": "def-common.DocLinks.upgrade", "type": "Object", "tags": [], "label": "upgrade", @@ -138,20 +146,20 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.apm", + "id": "def-common.DocLinks.apm", "type": "Object", "tags": [], "label": "apm", "description": [], "signature": [ - "{ readonly kibanaSettings: string; readonly supportedServiceMaps: string; readonly customLinks: string; readonly droppedTransactionSpans: string; readonly upgrading: string; readonly metaData: string; readonly overview: string; readonly tailSamplingPolicies: string; }" + "{ readonly kibanaSettings: string; readonly supportedServiceMaps: string; readonly customLinks: string; readonly droppedTransactionSpans: string; readonly upgrading: string; readonly metaData: string; readonly overview: string; readonly tailSamplingPolicies: string; readonly elasticAgent: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.canvas", + "id": "def-common.DocLinks.canvas", "type": "Object", "tags": [], "label": "canvas", @@ -164,7 +172,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.cloud", + "id": "def-common.DocLinks.cloud", "type": "Object", "tags": [], "label": "cloud", @@ -177,7 +185,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.console", + "id": "def-common.DocLinks.console", "type": "Object", "tags": [], "label": "console", @@ -190,7 +198,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.dashboard", + "id": "def-common.DocLinks.dashboard", "type": "Object", "tags": [], "label": "dashboard", @@ -203,7 +211,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.discover", + "id": "def-common.DocLinks.discover", "type": "Object", "tags": [], "label": "discover", @@ -216,7 +224,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.filebeat", + "id": "def-common.DocLinks.filebeat", "type": "Object", "tags": [], "label": "filebeat", @@ -229,7 +237,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.auditbeat", + "id": "def-common.DocLinks.auditbeat", "type": "Object", "tags": [], "label": "auditbeat", @@ -242,7 +250,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.metricbeat", + "id": "def-common.DocLinks.metricbeat", "type": "Object", "tags": [], "label": "metricbeat", @@ -255,20 +263,20 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.appSearch", + "id": "def-common.DocLinks.appSearch", "type": "Object", "tags": [], "label": "appSearch", "description": [], "signature": [ - "{ readonly apiRef: string; readonly apiClients: string; readonly apiKeys: string; readonly authentication: string; readonly crawlRules: string; readonly curations: string; readonly duplicateDocuments: string; readonly elasticsearchIndexedEngines: string; readonly entryPoints: string; readonly guide: string; readonly indexingDocuments: string; readonly indexingDocumentsSchema: string; readonly logSettings: string; readonly metaEngines: string; readonly precisionTuning: string; readonly relevanceTuning: string; readonly resultSettings: string; readonly searchUI: string; readonly security: string; readonly synonyms: string; readonly webCrawler: string; readonly webCrawlerEventLogs: string; }" + "{ readonly apiRef: string; readonly apiClients: string; readonly apiKeys: string; readonly authentication: string; readonly crawlRules: string; readonly curations: string; readonly duplicateDocuments: string; readonly elasticsearchIndexedEngines: string; readonly entryPoints: string; readonly guide: string; readonly indexingDocuments: string; readonly indexingDocumentsSchema: string; readonly logSettings: string; readonly metaEngines: string; readonly precisionTuning: string; readonly relevanceTuning: string; readonly resultSettings: string; readonly searchUI: string; readonly security: string; readonly synonyms: string; readonly webCrawler: string; readonly webCrawlerEventLogs: string; readonly webCrawlerReference: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.enterpriseSearch", + "id": "def-common.DocLinks.enterpriseSearch", "type": "Object", "tags": [], "label": "enterpriseSearch", @@ -281,20 +289,20 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.workplaceSearch", + "id": "def-common.DocLinks.workplaceSearch", "type": "Object", "tags": [], "label": "workplaceSearch", "description": [], "signature": [ - "{ readonly apiKeys: string; readonly box: string; readonly confluenceCloud: string; readonly confluenceServer: string; readonly customSources: string; readonly customSourcePermissions: string; readonly documentPermissions: string; readonly dropbox: string; readonly externalSharePointOnline: string; readonly externalIdentities: string; readonly gitHub: string; readonly gettingStarted: string; readonly gmail: string; readonly googleDrive: string; readonly indexingSchedule: string; readonly jiraCloud: string; readonly jiraServer: string; readonly oneDrive: string; readonly permissions: string; readonly salesforce: string; readonly security: string; readonly serviceNow: string; readonly sharePoint: string; readonly sharePointServer: string; readonly slack: string; readonly synch: string; readonly zendesk: string; }" + "{ readonly apiKeys: string; readonly box: string; readonly confluenceCloud: string; readonly confluenceCloudConnectorPackage: string; readonly confluenceServer: string; readonly customConnectorPackage: string; readonly customSources: string; readonly customSourcePermissions: string; readonly documentPermissions: string; readonly dropbox: string; readonly externalSharePointOnline: string; readonly externalIdentities: string; readonly gitHub: string; readonly gettingStarted: string; readonly gmail: string; readonly googleDrive: string; readonly indexingSchedule: string; readonly jiraCloud: string; readonly jiraServer: string; readonly networkDrive: string; readonly oneDrive: string; readonly outlook: string; readonly permissions: string; readonly salesforce: string; readonly security: string; readonly serviceNow: string; readonly sharePoint: string; readonly sharePointServer: string; readonly slack: string; readonly synch: string; readonly teams: string; readonly zendesk: string; readonly zoom: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.heartbeat", + "id": "def-common.DocLinks.heartbeat", "type": "Object", "tags": [], "label": "heartbeat", @@ -307,7 +315,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.libbeat", + "id": "def-common.DocLinks.libbeat", "type": "Object", "tags": [], "label": "libbeat", @@ -320,7 +328,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.logstash", + "id": "def-common.DocLinks.logstash", "type": "Object", "tags": [], "label": "logstash", @@ -333,7 +341,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.functionbeat", + "id": "def-common.DocLinks.functionbeat", "type": "Object", "tags": [], "label": "functionbeat", @@ -346,7 +354,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.winlogbeat", + "id": "def-common.DocLinks.winlogbeat", "type": "Object", "tags": [], "label": "winlogbeat", @@ -359,7 +367,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.aggs", + "id": "def-common.DocLinks.aggs", "type": "Object", "tags": [], "label": "aggs", @@ -372,7 +380,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.runtimeFields", + "id": "def-common.DocLinks.runtimeFields", "type": "Object", "tags": [], "label": "runtimeFields", @@ -385,7 +393,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.scriptedFields", + "id": "def-common.DocLinks.scriptedFields", "type": "Object", "tags": [], "label": "scriptedFields", @@ -398,7 +406,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.search", + "id": "def-common.DocLinks.search", "type": "Object", "tags": [], "label": "search", @@ -411,7 +419,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.indexPatterns", + "id": "def-common.DocLinks.indexPatterns", "type": "Object", "tags": [], "label": "indexPatterns", @@ -424,7 +432,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.addData", + "id": "def-common.DocLinks.addData", "type": "string", "tags": [], "label": "addData", @@ -434,7 +442,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.kibana", + "id": "def-common.DocLinks.kibana", "type": "Object", "tags": [], "label": "kibana", @@ -447,7 +455,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.upgradeAssistant", + "id": "def-common.DocLinks.upgradeAssistant", "type": "Object", "tags": [], "label": "upgradeAssistant", @@ -460,7 +468,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.rollupJobs", + "id": "def-common.DocLinks.rollupJobs", "type": "string", "tags": [], "label": "rollupJobs", @@ -470,7 +478,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.elasticsearch", + "id": "def-common.DocLinks.elasticsearch", "type": "Object", "tags": [], "label": "elasticsearch", @@ -483,7 +491,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.siem", + "id": "def-common.DocLinks.siem", "type": "Object", "tags": [], "label": "siem", @@ -496,7 +504,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.securitySolution", + "id": "def-common.DocLinks.securitySolution", "type": "Object", "tags": [], "label": "securitySolution", @@ -509,7 +517,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.query", + "id": "def-common.DocLinks.query", "type": "Object", "tags": [], "label": "query", @@ -522,7 +530,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.date", + "id": "def-common.DocLinks.date", "type": "Object", "tags": [], "label": "date", @@ -535,7 +543,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.management", + "id": "def-common.DocLinks.management", "type": "Object", "tags": [], "label": "management", @@ -548,7 +556,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.ml", + "id": "def-common.DocLinks.ml", "type": "Object", "tags": [], "label": "ml", @@ -561,7 +569,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.transforms", + "id": "def-common.DocLinks.transforms", "type": "Object", "tags": [], "label": "transforms", @@ -574,7 +582,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.visualize", + "id": "def-common.DocLinks.visualize", "type": "Object", "tags": [], "label": "visualize", @@ -587,7 +595,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.apis", + "id": "def-common.DocLinks.apis", "type": "Object", "tags": [], "label": "apis", @@ -600,7 +608,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.observability", + "id": "def-common.DocLinks.observability", "type": "Object", "tags": [], "label": "observability", @@ -613,7 +621,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.alerting", + "id": "def-common.DocLinks.alerting", "type": "Object", "tags": [], "label": "alerting", @@ -626,20 +634,20 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.maps", + "id": "def-common.DocLinks.maps", "type": "Object", "tags": [], "label": "maps", "description": [], "signature": [ - "{ readonly guide: string; readonly importGeospatialPrivileges: string; readonly gdalTutorial: string; }" + "{ readonly guide: string; readonly importGeospatialPrivileges: string; readonly gdalTutorial: string; readonly termJoinsExample: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.monitoring", + "id": "def-common.DocLinks.monitoring", "type": "Object", "tags": [], "label": "monitoring", @@ -652,7 +660,20 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.security", + "id": "def-common.DocLinks.reporting", + "type": "Object", + "tags": [], + "label": "reporting", + "description": [], + "signature": [ + "{ readonly cloudMinimumRequirements: string; }" + ], + "path": "packages/kbn-doc-links/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/doc-links", + "id": "def-common.DocLinks.security", "type": "Object", "tags": [], "label": "security", @@ -665,7 +686,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.spaces", + "id": "def-common.DocLinks.spaces", "type": "Object", "tags": [], "label": "spaces", @@ -678,7 +699,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.watcher", + "id": "def-common.DocLinks.watcher", "type": "Object", "tags": [], "label": "watcher", @@ -691,7 +712,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.ccs", + "id": "def-common.DocLinks.ccs", "type": "Object", "tags": [], "label": "ccs", @@ -704,20 +725,20 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.plugins", + "id": "def-common.DocLinks.plugins", "type": "Object", "tags": [], "label": "plugins", "description": [], "signature": [ - "{ azureRepo: string; gcsRepo: string; hdfsRepo: string; s3Repo: string; snapshotRestoreRepos: string; mapperSize: string; }" + "{ azureRepo: string; gcsRepo: string; hdfsRepo: string; ingestAttachment: string; s3Repo: string; snapshotRestoreRepos: string; mapperSize: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.snapshotRestore", + "id": "def-common.DocLinks.snapshotRestore", "type": "Object", "tags": [], "label": "snapshotRestore", @@ -730,7 +751,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.ingest", + "id": "def-common.DocLinks.ingest", "type": "Object", "tags": [], "label": "ingest", @@ -743,20 +764,20 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.fleet", + "id": "def-common.DocLinks.fleet", "type": "Object", "tags": [], "label": "fleet", "description": [], "signature": [ - "{ readonly beatsAgentComparison: string; readonly guide: string; readonly fleetServer: string; readonly fleetServerAddFleetServer: string; readonly settings: string; readonly settingsFleetServerHostSettings: string; readonly settingsFleetServerProxySettings: string; readonly troubleshooting: string; readonly elasticAgent: string; readonly datastreams: string; readonly datastreamsILM: string; readonly datastreamsNamingScheme: string; readonly installElasticAgent: string; readonly installElasticAgentStandalone: string; readonly upgradeElasticAgent: string; readonly upgradeElasticAgent712lower: string; readonly learnMoreBlog: string; readonly apiKeysLearnMore: string; readonly onPremRegistry: string; readonly secureLogstash: string; }" + "{ readonly beatsAgentComparison: string; readonly guide: string; readonly fleetServer: string; readonly fleetServerAddFleetServer: string; readonly settings: string; readonly settingsFleetServerHostSettings: string; readonly settingsFleetServerProxySettings: string; readonly troubleshooting: string; readonly elasticAgent: string; readonly datastreams: string; readonly datastreamsILM: string; readonly datastreamsNamingScheme: string; readonly installElasticAgent: string; readonly installElasticAgentStandalone: string; readonly upgradeElasticAgent: string; readonly learnMoreBlog: string; readonly apiKeysLearnMore: string; readonly onPremRegistry: string; readonly secureLogstash: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.ecs", + "id": "def-common.DocLinks.ecs", "type": "Object", "tags": [], "label": "ecs", @@ -769,7 +790,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.clients", + "id": "def-common.DocLinks.clients", "type": "Object", "tags": [], "label": "clients", @@ -782,7 +803,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.endpoints", + "id": "def-common.DocLinks.endpoints", "type": "Object", "tags": [], "label": "endpoints", @@ -795,7 +816,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.legal", + "id": "def-common.DocLinks.legal", "type": "Object", "tags": [], "label": "legal", @@ -808,13 +829,13 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinks.kibanaUpgradeSavedObjects", + "id": "def-common.DocLinks.kibanaUpgradeSavedObjects", "type": "Object", "tags": [], "label": "kibanaUpgradeSavedObjects", "description": [], "signature": [ - "{ readonly resolveMigrationFailures: string; }" + "{ readonly resolveMigrationFailures: string; readonly repeatedTimeoutRequests: string; readonly routingAllocationDisabled: string; readonly clusterShardLimitExceeded: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false @@ -824,7 +845,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinksMeta", + "id": "def-common.DocLinksMeta", "type": "Interface", "tags": [], "label": "DocLinksMeta", @@ -834,7 +855,7 @@ "children": [ { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinksMeta.version", + "id": "def-common.DocLinksMeta.version", "type": "string", "tags": [], "label": "version", @@ -844,7 +865,7 @@ }, { "parentPluginId": "@kbn/doc-links", - "id": "def-server.DocLinksMeta.elasticWebsiteUrl", + "id": "def-common.DocLinksMeta.elasticWebsiteUrl", "type": "string", "tags": [], "label": "elasticWebsiteUrl", @@ -859,13 +880,5 @@ "enums": [], "misc": [], "objects": [] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] } } \ No newline at end of file diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index 4d23bdfc99533..5740f46ca8261 100644 --- a/api_docs/kbn_doc_links.mdx +++ b/api_docs/kbn_doc_links.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-doc-links title: "@kbn/doc-links" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/doc-links plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/doc-links'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,13 +18,13 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 64 | 0 | 64 | 2 | +| 65 | 0 | 65 | 2 | -## Server +## Common ### Functions - + ### Interfaces - + diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx index 3fd9067f34bae..44f2207af0580 100644 --- a/api_docs/kbn_docs_utils.mdx +++ b/api_docs/kbn_docs_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-docs-utils title: "@kbn/docs-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/docs-utils plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/docs-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_archiver.mdx b/api_docs/kbn_es_archiver.mdx index 2372ce2f44342..00c8183a7c173 100644 --- a/api_docs/kbn_es_archiver.mdx +++ b/api_docs/kbn_es_archiver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-archiver title: "@kbn/es-archiver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-archiver plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-archiver'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index f51fa006128aa..d7bcee0665458 100644 --- a/api_docs/kbn_es_query.mdx +++ b/api_docs/kbn_es_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-query title: "@kbn/es-query" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-query plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-query'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_eslint_plugin_imports.mdx b/api_docs/kbn_eslint_plugin_imports.mdx index 39fd23924e882..a6cd7adf4f641 100644 --- a/api_docs/kbn_eslint_plugin_imports.mdx +++ b/api_docs/kbn_eslint_plugin_imports.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-eslint-plugin-imports title: "@kbn/eslint-plugin-imports" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/eslint-plugin-imports plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_field_types.devdocs.json b/api_docs/kbn_field_types.devdocs.json index a0c3de8a3d807..47a8f1982a518 100644 --- a/api_docs/kbn_field_types.devdocs.json +++ b/api_docs/kbn_field_types.devdocs.json @@ -9,10 +9,18 @@ "objects": [] }, "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { "classes": [ { "parentPluginId": "@kbn/field-types", - "id": "def-server.KbnFieldType", + "id": "def-common.KbnFieldType", "type": "Class", "tags": [], "label": "KbnFieldType", @@ -22,7 +30,7 @@ "children": [ { "parentPluginId": "@kbn/field-types", - "id": "def-server.KbnFieldType.name", + "id": "def-common.KbnFieldType.name", "type": "string", "tags": [], "label": "name", @@ -32,7 +40,7 @@ }, { "parentPluginId": "@kbn/field-types", - "id": "def-server.KbnFieldType.sortable", + "id": "def-common.KbnFieldType.sortable", "type": "boolean", "tags": [], "label": "sortable", @@ -42,7 +50,7 @@ }, { "parentPluginId": "@kbn/field-types", - "id": "def-server.KbnFieldType.filterable", + "id": "def-common.KbnFieldType.filterable", "type": "boolean", "tags": [], "label": "filterable", @@ -52,7 +60,7 @@ }, { "parentPluginId": "@kbn/field-types", - "id": "def-server.KbnFieldType.esTypes", + "id": "def-common.KbnFieldType.esTypes", "type": "Object", "tags": [], "label": "esTypes", @@ -61,9 +69,9 @@ "readonly ", { "pluginId": "@kbn/field-types", - "scope": "server", + "scope": "common", "docId": "kibKbnFieldTypesPluginApi", - "section": "def-server.ES_FIELD_TYPES", + "section": "def-common.ES_FIELD_TYPES", "text": "ES_FIELD_TYPES" }, "[]" @@ -73,7 +81,7 @@ }, { "parentPluginId": "@kbn/field-types", - "id": "def-server.KbnFieldType.Unnamed", + "id": "def-common.KbnFieldType.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -86,7 +94,7 @@ "children": [ { "parentPluginId": "@kbn/field-types", - "id": "def-server.KbnFieldType.Unnamed.$1", + "id": "def-common.KbnFieldType.Unnamed.$1", "type": "Object", "tags": [], "label": "options", @@ -95,9 +103,9 @@ "Partial<", { "pluginId": "@kbn/field-types", - "scope": "server", + "scope": "common", "docId": "kibKbnFieldTypesPluginApi", - "section": "def-server.KbnFieldTypeOptions", + "section": "def-common.KbnFieldTypeOptions", "text": "KbnFieldTypeOptions" }, ">" @@ -116,7 +124,7 @@ "functions": [ { "parentPluginId": "@kbn/field-types", - "id": "def-server.castEsToKbnFieldTypeName", + "id": "def-common.castEsToKbnFieldTypeName", "type": "Function", "tags": [ "return" @@ -129,9 +137,9 @@ "(esType: string) => ", { "pluginId": "@kbn/field-types", - "scope": "server", + "scope": "common", "docId": "kibKbnFieldTypesPluginApi", - "section": "def-server.KBN_FIELD_TYPES", + "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" } ], @@ -140,7 +148,7 @@ "children": [ { "parentPluginId": "@kbn/field-types", - "id": "def-server.castEsToKbnFieldTypeName.$1", + "id": "def-common.castEsToKbnFieldTypeName.$1", "type": "string", "tags": [], "label": "esType", @@ -158,7 +166,7 @@ }, { "parentPluginId": "@kbn/field-types", - "id": "def-server.getFilterableKbnTypeNames", + "id": "def-common.getFilterableKbnTypeNames", "type": "Function", "tags": [ "return" @@ -178,7 +186,7 @@ }, { "parentPluginId": "@kbn/field-types", - "id": "def-server.getKbnFieldType", + "id": "def-common.getKbnFieldType", "type": "Function", "tags": [ "return" @@ -191,9 +199,9 @@ "(typeName: string) => ", { "pluginId": "@kbn/field-types", - "scope": "server", + "scope": "common", "docId": "kibKbnFieldTypesPluginApi", - "section": "def-server.KbnFieldType", + "section": "def-common.KbnFieldType", "text": "KbnFieldType" } ], @@ -202,7 +210,7 @@ "children": [ { "parentPluginId": "@kbn/field-types", - "id": "def-server.getKbnFieldType.$1", + "id": "def-common.getKbnFieldType.$1", "type": "string", "tags": [], "label": "typeName", @@ -220,7 +228,7 @@ }, { "parentPluginId": "@kbn/field-types", - "id": "def-server.getKbnTypeNames", + "id": "def-common.getKbnTypeNames", "type": "Function", "tags": [ "return" @@ -242,7 +250,7 @@ "interfaces": [ { "parentPluginId": "@kbn/field-types", - "id": "def-server.KbnFieldTypeOptions", + "id": "def-common.KbnFieldTypeOptions", "type": "Interface", "tags": [], "label": "KbnFieldTypeOptions", @@ -252,7 +260,7 @@ "children": [ { "parentPluginId": "@kbn/field-types", - "id": "def-server.KbnFieldTypeOptions.sortable", + "id": "def-common.KbnFieldTypeOptions.sortable", "type": "boolean", "tags": [], "label": "sortable", @@ -262,7 +270,7 @@ }, { "parentPluginId": "@kbn/field-types", - "id": "def-server.KbnFieldTypeOptions.filterable", + "id": "def-common.KbnFieldTypeOptions.filterable", "type": "boolean", "tags": [], "label": "filterable", @@ -272,7 +280,7 @@ }, { "parentPluginId": "@kbn/field-types", - "id": "def-server.KbnFieldTypeOptions.name", + "id": "def-common.KbnFieldTypeOptions.name", "type": "string", "tags": [], "label": "name", @@ -282,7 +290,7 @@ }, { "parentPluginId": "@kbn/field-types", - "id": "def-server.KbnFieldTypeOptions.esTypes", + "id": "def-common.KbnFieldTypeOptions.esTypes", "type": "Array", "tags": [], "label": "esTypes", @@ -290,9 +298,9 @@ "signature": [ { "pluginId": "@kbn/field-types", - "scope": "server", + "scope": "common", "docId": "kibKbnFieldTypesPluginApi", - "section": "def-server.ES_FIELD_TYPES", + "section": "def-common.ES_FIELD_TYPES", "text": "ES_FIELD_TYPES" }, "[]" @@ -307,7 +315,7 @@ "enums": [ { "parentPluginId": "@kbn/field-types", - "id": "def-server.ES_FIELD_TYPES", + "id": "def-common.ES_FIELD_TYPES", "type": "Enum", "tags": [], "label": "ES_FIELD_TYPES", @@ -318,7 +326,7 @@ }, { "parentPluginId": "@kbn/field-types", - "id": "def-server.KBN_FIELD_TYPES", + "id": "def-common.KBN_FIELD_TYPES", "type": "Enum", "tags": [], "label": "KBN_FIELD_TYPES", @@ -330,13 +338,5 @@ ], "misc": [], "objects": [] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] } } \ No newline at end of file diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx index 34d156709b95c..e180f17bbc2f6 100644 --- a/api_docs/kbn_field_types.mdx +++ b/api_docs/kbn_field_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-field-types title: "@kbn/field-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/field-types plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -20,17 +20,17 @@ Contact [Owner missing] for questions regarding this plugin. |-------------------|-----------|------------------------|-----------------| | 20 | 0 | 16 | 0 | -## Server +## Common ### Functions - + ### Classes - + ### Interfaces - + ### Enums - + diff --git a/api_docs/kbn_find_used_node_modules.mdx b/api_docs/kbn_find_used_node_modules.mdx index 95310ec27972b..5be9c941e585d 100644 --- a/api_docs/kbn_find_used_node_modules.mdx +++ b/api_docs/kbn_find_used_node_modules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-find-used-node-modules title: "@kbn/find-used-node-modules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/find-used-node-modules plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/find-used-node-modules'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_generate.mdx b/api_docs/kbn_generate.mdx index 891a77319d2c0..4ed7a9b37dca0 100644 --- a/api_docs/kbn_generate.mdx +++ b/api_docs/kbn_generate.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-generate title: "@kbn/generate" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/generate plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_handlebars.mdx b/api_docs/kbn_handlebars.mdx index 79d09d800a950..b9955fc792bea 100644 --- a/api_docs/kbn_handlebars.mdx +++ b/api_docs/kbn_handlebars.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-handlebars title: "@kbn/handlebars" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/handlebars plugin -date: 2022-05-23 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/handlebars'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_i18n.mdx b/api_docs/kbn_i18n.mdx index f1c2d35173a65..0385c399205fa 100644 --- a/api_docs/kbn_i18n.mdx +++ b/api_docs/kbn_i18n.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-i18n title: "@kbn/i18n" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/i18n plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_import_resolver.mdx b/api_docs/kbn_import_resolver.mdx index ea7b7ff9aba1d..edde41219d667 100644 --- a/api_docs/kbn_import_resolver.mdx +++ b/api_docs/kbn_import_resolver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-import-resolver title: "@kbn/import-resolver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/import-resolver plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_interpreter.devdocs.json b/api_docs/kbn_interpreter.devdocs.json index e2dc487b9c0fc..efcfec31ab71b 100644 --- a/api_docs/kbn_interpreter.devdocs.json +++ b/api_docs/kbn_interpreter.devdocs.json @@ -9,10 +9,18 @@ "objects": [] }, "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { "classes": [ { "parentPluginId": "@kbn/interpreter", - "id": "def-server.Registry", + "id": "def-common.Registry", "type": "Class", "tags": [], "label": "Registry", @@ -20,9 +28,9 @@ "signature": [ { "pluginId": "@kbn/interpreter", - "scope": "server", + "scope": "common", "docId": "kibKbnInterpreterPluginApi", - "section": "def-server.Registry", + "section": "def-common.Registry", "text": "Registry" }, "" @@ -32,7 +40,7 @@ "children": [ { "parentPluginId": "@kbn/interpreter", - "id": "def-server.Registry.Unnamed", + "id": "def-common.Registry.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -45,7 +53,7 @@ "children": [ { "parentPluginId": "@kbn/interpreter", - "id": "def-server.Registry.Unnamed.$1", + "id": "def-common.Registry.Unnamed.$1", "type": "string", "tags": [], "label": "prop", @@ -62,7 +70,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.Registry.wrapper", + "id": "def-common.Registry.wrapper", "type": "Function", "tags": [], "label": "wrapper", @@ -75,7 +83,7 @@ "children": [ { "parentPluginId": "@kbn/interpreter", - "id": "def-server.Registry.wrapper.$1", + "id": "def-common.Registry.wrapper.$1", "type": "Uncategorized", "tags": [], "label": "obj", @@ -92,7 +100,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.Registry.register", + "id": "def-common.Registry.register", "type": "Function", "tags": [], "label": "register", @@ -105,7 +113,7 @@ "children": [ { "parentPluginId": "@kbn/interpreter", - "id": "def-server.Registry.register.$1", + "id": "def-common.Registry.register.$1", "type": "Function", "tags": [], "label": "fn", @@ -122,7 +130,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.Registry.toJS", + "id": "def-common.Registry.toJS", "type": "Function", "tags": [], "label": "toJS", @@ -137,7 +145,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.Registry.toArray", + "id": "def-common.Registry.toArray", "type": "Function", "tags": [], "label": "toArray", @@ -152,7 +160,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.Registry.get", + "id": "def-common.Registry.get", "type": "Function", "tags": [], "label": "get", @@ -165,7 +173,7 @@ "children": [ { "parentPluginId": "@kbn/interpreter", - "id": "def-server.Registry.get.$1", + "id": "def-common.Registry.get.$1", "type": "string", "tags": [], "label": "name", @@ -182,7 +190,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.Registry.getProp", + "id": "def-common.Registry.getProp", "type": "Function", "tags": [], "label": "getProp", @@ -197,7 +205,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.Registry.reset", + "id": "def-common.Registry.reset", "type": "Function", "tags": [], "label": "reset", @@ -217,7 +225,7 @@ "functions": [ { "parentPluginId": "@kbn/interpreter", - "id": "def-server.fromExpression", + "id": "def-common.fromExpression", "type": "Function", "tags": [], "label": "fromExpression", @@ -226,9 +234,9 @@ "(expression: string, type: string) => ", { "pluginId": "@kbn/interpreter", - "scope": "server", + "scope": "common", "docId": "kibKbnInterpreterPluginApi", - "section": "def-server.Ast", + "section": "def-common.Ast", "text": "Ast" } ], @@ -237,7 +245,7 @@ "children": [ { "parentPluginId": "@kbn/interpreter", - "id": "def-server.fromExpression.$1", + "id": "def-common.fromExpression.$1", "type": "string", "tags": [], "label": "expression", @@ -251,7 +259,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.fromExpression.$2", + "id": "def-common.fromExpression.$2", "type": "string", "tags": [], "label": "type", @@ -269,7 +277,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.getType", + "id": "def-common.getType", "type": "Function", "tags": [], "label": "getType", @@ -282,7 +290,7 @@ "children": [ { "parentPluginId": "@kbn/interpreter", - "id": "def-server.getType.$1", + "id": "def-common.getType.$1", "type": "Any", "tags": [], "label": "node", @@ -300,7 +308,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.isAst", + "id": "def-common.isAst", "type": "Function", "tags": [], "label": "isAst", @@ -313,7 +321,7 @@ "children": [ { "parentPluginId": "@kbn/interpreter", - "id": "def-server.isAst.$1", + "id": "def-common.isAst.$1", "type": "Any", "tags": [], "label": "value", @@ -331,7 +339,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.isAstWithMeta", + "id": "def-common.isAstWithMeta", "type": "Function", "tags": [], "label": "isAstWithMeta", @@ -344,7 +352,7 @@ "children": [ { "parentPluginId": "@kbn/interpreter", - "id": "def-server.isAstWithMeta.$1", + "id": "def-common.isAstWithMeta.$1", "type": "Any", "tags": [], "label": "value", @@ -362,7 +370,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.safeElementFromExpression", + "id": "def-common.safeElementFromExpression", "type": "Function", "tags": [], "label": "safeElementFromExpression", @@ -371,9 +379,9 @@ "(expression: string) => ", { "pluginId": "@kbn/interpreter", - "scope": "server", + "scope": "common", "docId": "kibKbnInterpreterPluginApi", - "section": "def-server.Ast", + "section": "def-common.Ast", "text": "Ast" } ], @@ -382,7 +390,7 @@ "children": [ { "parentPluginId": "@kbn/interpreter", - "id": "def-server.safeElementFromExpression.$1", + "id": "def-common.safeElementFromExpression.$1", "type": "string", "tags": [], "label": "expression", @@ -400,7 +408,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.toExpression", + "id": "def-common.toExpression", "type": "Function", "tags": [], "label": "toExpression", @@ -409,9 +417,9 @@ "(ast: ", { "pluginId": "@kbn/interpreter", - "scope": "server", + "scope": "common", "docId": "kibKbnInterpreterPluginApi", - "section": "def-server.AstNode", + "section": "def-common.AstNode", "text": "AstNode" }, ", options: string | Options) => string" @@ -421,7 +429,7 @@ "children": [ { "parentPluginId": "@kbn/interpreter", - "id": "def-server.toExpression.$1", + "id": "def-common.toExpression.$1", "type": "CompoundType", "tags": [], "label": "ast", @@ -429,9 +437,9 @@ "signature": [ { "pluginId": "@kbn/interpreter", - "scope": "server", + "scope": "common", "docId": "kibKbnInterpreterPluginApi", - "section": "def-server.AstNode", + "section": "def-common.AstNode", "text": "AstNode" } ], @@ -441,7 +449,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.toExpression.$2", + "id": "def-common.toExpression.$2", "type": "CompoundType", "tags": [], "label": "options", @@ -463,7 +471,7 @@ "misc": [ { "parentPluginId": "@kbn/interpreter", - "id": "def-server.Ast", + "id": "def-common.Ast", "type": "Type", "tags": [], "label": "Ast", @@ -472,9 +480,9 @@ "{ type: \"expression\"; chain: ", { "pluginId": "@kbn/interpreter", - "scope": "server", + "scope": "common", "docId": "kibKbnInterpreterPluginApi", - "section": "def-server.AstFunction", + "section": "def-common.AstFunction", "text": "AstFunction" }, "[]; }" @@ -485,7 +493,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.AstArgument", + "id": "def-common.AstArgument", "type": "Type", "tags": [], "label": "AstArgument", @@ -494,9 +502,9 @@ "string | number | boolean | ", { "pluginId": "@kbn/interpreter", - "scope": "server", + "scope": "common", "docId": "kibKbnInterpreterPluginApi", - "section": "def-server.Ast", + "section": "def-common.Ast", "text": "Ast" } ], @@ -506,7 +514,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.AstArgumentWithMeta", + "id": "def-common.AstArgumentWithMeta", "type": "Type", "tags": [], "label": "AstArgumentWithMeta", @@ -514,9 +522,9 @@ "signature": [ { "pluginId": "@kbn/interpreter", - "scope": "server", + "scope": "common", "docId": "kibKbnInterpreterPluginApi", - "section": "def-server.AstWithMeta", + "section": "def-common.AstWithMeta", "text": "AstWithMeta" }, " | WithMeta | WithMeta | WithMeta | WithMeta" @@ -527,7 +535,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.AstFunction", + "id": "def-common.AstFunction", "type": "Type", "tags": [], "label": "AstFunction", @@ -536,9 +544,9 @@ "{ type: \"function\"; function: string; arguments: Record; }" @@ -549,7 +557,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.AstFunctionWithMeta", + "id": "def-common.AstFunctionWithMeta", "type": "Type", "tags": [], "label": "AstFunctionWithMeta", @@ -558,17 +566,17 @@ "WithMeta>" @@ -579,7 +587,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.AstNode", + "id": "def-common.AstNode", "type": "Type", "tags": [], "label": "AstNode", @@ -587,17 +595,17 @@ "signature": [ { "pluginId": "@kbn/interpreter", - "scope": "server", + "scope": "common", "docId": "kibKbnInterpreterPluginApi", - "section": "def-server.AstFunction", + "section": "def-common.AstFunction", "text": "AstFunction" }, " | ", { "pluginId": "@kbn/interpreter", - "scope": "server", + "scope": "common", "docId": "kibKbnInterpreterPluginApi", - "section": "def-server.AstArgument", + "section": "def-common.AstArgument", "text": "AstArgument" } ], @@ -607,7 +615,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.AstWithMeta", + "id": "def-common.AstWithMeta", "type": "Type", "tags": [], "label": "AstWithMeta", @@ -616,17 +624,17 @@ "WithMeta>" @@ -637,7 +645,7 @@ }, { "parentPluginId": "@kbn/interpreter", - "id": "def-server.typedParse", + "id": "def-common.typedParse", "type": "Any", "tags": [], "label": "typedParse", @@ -651,13 +659,5 @@ } ], "objects": [] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] } } \ No newline at end of file diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx index 7a6b18efd63c5..634184ca6bdde 100644 --- a/api_docs/kbn_interpreter.mdx +++ b/api_docs/kbn_interpreter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-interpreter title: "@kbn/interpreter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/interpreter plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -20,14 +20,14 @@ Contact App Services for questions regarding this plugin. |-------------------|-----------|------------------------|-----------------| | 35 | 4 | 35 | 0 | -## Server +## Common ### Functions - + ### Classes - + ### Consts, variables and types - + diff --git a/api_docs/kbn_io_ts_utils.devdocs.json b/api_docs/kbn_io_ts_utils.devdocs.json index 0eac86c5269a4..cde8a3b1eb600 100644 --- a/api_docs/kbn_io_ts_utils.devdocs.json +++ b/api_docs/kbn_io_ts_utils.devdocs.json @@ -9,11 +9,19 @@ "objects": [] }, "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.deepExactRt", + "id": "def-common.deepExactRt", "type": "Function", "tags": [], "label": "deepExactRt", @@ -26,7 +34,7 @@ "children": [ { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.deepExactRt.$1", + "id": "def-common.deepExactRt.$1", "type": "Uncategorized", "tags": [], "label": "type", @@ -44,7 +52,7 @@ }, { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.deepExactRt", + "id": "def-common.deepExactRt", "type": "Function", "tags": [], "label": "deepExactRt", @@ -91,7 +99,7 @@ "children": [ { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.deepExactRt.$1", + "id": "def-common.deepExactRt.$1", "type": "CompoundType", "tags": [], "label": "type", @@ -111,7 +119,7 @@ }, { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.mergeRt", + "id": "def-common.mergeRt", "type": "Function", "tags": [], "label": "mergeRt", @@ -126,7 +134,7 @@ "children": [ { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.mergeRt.$1", + "id": "def-common.mergeRt.$1", "type": "Uncategorized", "tags": [], "label": "a", @@ -140,7 +148,7 @@ }, { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.mergeRt.$2", + "id": "def-common.mergeRt.$2", "type": "Uncategorized", "tags": [], "label": "b", @@ -158,7 +166,7 @@ }, { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.mergeRt", + "id": "def-common.mergeRt", "type": "Function", "tags": [], "label": "mergeRt", @@ -181,7 +189,7 @@ "children": [ { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.mergeRt.$1", + "id": "def-common.mergeRt.$1", "type": "Array", "tags": [], "label": "types", @@ -200,7 +208,7 @@ }, { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.strictKeysRt", + "id": "def-common.strictKeysRt", "type": "Function", "tags": [], "label": "strictKeysRt", @@ -215,7 +223,7 @@ "children": [ { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.strictKeysRt.$1", + "id": "def-common.strictKeysRt.$1", "type": "Uncategorized", "tags": [], "label": "type", @@ -233,7 +241,7 @@ }, { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.toJsonSchema", + "id": "def-common.toJsonSchema", "type": "Function", "tags": [], "label": "toJsonSchema", @@ -248,7 +256,7 @@ "children": [ { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.toJsonSchema.$1", + "id": "def-common.toJsonSchema.$1", "type": "Object", "tags": [], "label": "type", @@ -268,7 +276,7 @@ "interfaces": [ { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.NonEmptyStringBrand", + "id": "def-common.NonEmptyStringBrand", "type": "Interface", "tags": [], "label": "NonEmptyStringBrand", @@ -278,7 +286,7 @@ "children": [ { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.NonEmptyStringBrand.NonEmptyString", + "id": "def-common.NonEmptyStringBrand.NonEmptyString", "type": "Uncategorized", "tags": [], "label": "NonEmptyString", @@ -287,9 +295,9 @@ "typeof ", { "pluginId": "@kbn/io-ts-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", - "section": "def-server.NonEmptyStringBrand", + "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, "[\"NonEmptyString\"]" @@ -306,7 +314,7 @@ "objects": [ { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.isoToEpochRt", + "id": "def-common.isoToEpochRt", "type": "Object", "tags": [], "label": "isoToEpochRt", @@ -321,7 +329,7 @@ }, { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.jsonRt", + "id": "def-common.jsonRt", "type": "Object", "tags": [], "label": "jsonRt", @@ -336,7 +344,7 @@ }, { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.nonEmptyStringRt", + "id": "def-common.nonEmptyStringRt", "type": "Object", "tags": [], "label": "nonEmptyStringRt", @@ -348,9 +356,9 @@ ", ", { "pluginId": "@kbn/io-ts-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnIoTsUtilsPluginApi", - "section": "def-server.NonEmptyStringBrand", + "section": "def-common.NonEmptyStringBrand", "text": "NonEmptyStringBrand" }, ">" @@ -361,7 +369,7 @@ }, { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.toBooleanRt", + "id": "def-common.toBooleanRt", "type": "Object", "tags": [], "label": "toBooleanRt", @@ -376,7 +384,7 @@ }, { "parentPluginId": "@kbn/io-ts-utils", - "id": "def-server.toNumberRt", + "id": "def-common.toNumberRt", "type": "Object", "tags": [], "label": "toNumberRt", @@ -390,13 +398,5 @@ "initialIsOpen": false } ] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] } } \ No newline at end of file diff --git a/api_docs/kbn_io_ts_utils.mdx b/api_docs/kbn_io_ts_utils.mdx index 0890c33d45907..35a5203b9ea01 100644 --- a/api_docs/kbn_io_ts_utils.mdx +++ b/api_docs/kbn_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-io-ts-utils title: "@kbn/io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/io-ts-utils plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/io-ts-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -20,14 +20,14 @@ Contact [Owner missing] for questions regarding this plugin. |-------------------|-----------|------------------------|-----------------| | 20 | 0 | 20 | 2 | -## Server +## Common ### Objects - + ### Functions - + ### Interfaces - + diff --git a/api_docs/kbn_jest_serializers.mdx b/api_docs/kbn_jest_serializers.mdx index f9e1f71dc7804..4163d96e41085 100644 --- a/api_docs/kbn_jest_serializers.mdx +++ b/api_docs/kbn_jest_serializers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-jest-serializers title: "@kbn/jest-serializers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/jest-serializers plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_kibana_json_schema.mdx b/api_docs/kbn_kibana_json_schema.mdx index 16776b0a20e55..d4976f635a3a3 100644 --- a/api_docs/kbn_kibana_json_schema.mdx +++ b/api_docs/kbn_kibana_json_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-kibana-json-schema title: "@kbn/kibana-json-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/kibana-json-schema plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/kibana-json-schema'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_logging.devdocs.json b/api_docs/kbn_logging.devdocs.json index 00bfe3a5f742b..eb835715a1c77 100644 --- a/api_docs/kbn_logging.devdocs.json +++ b/api_docs/kbn_logging.devdocs.json @@ -616,7 +616,7 @@ "label": "EcsEventCategory", "description": [], "signature": [ - "\"database\" | \"package\" | \"network\" | \"web\" | \"host\" | \"session\" | \"file\" | \"registry\" | \"process\" | \"authentication\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" + "\"database\" | \"package\" | \"network\" | \"web\" | \"file\" | \"host\" | \"session\" | \"registry\" | \"process\" | \"authentication\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" ], "path": "packages/kbn-logging/src/ecs/event.ts", "deprecated": false, @@ -630,7 +630,7 @@ "label": "EcsEventKind", "description": [], "signature": [ - "\"alert\" | \"metric\" | \"event\" | \"state\" | \"signal\" | \"pipeline_error\"" + "\"alert\" | \"state\" | \"metric\" | \"event\" | \"signal\" | \"pipeline_error\"" ], "path": "packages/kbn-logging/src/ecs/event.ts", "deprecated": false, diff --git a/api_docs/kbn_logging.mdx b/api_docs/kbn_logging.mdx index d1bd851ab5758..1c65996625828 100644 --- a/api_docs/kbn_logging.mdx +++ b/api_docs/kbn_logging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging title: "@kbn/logging" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index 490414113832e..add97416dff8a 100644 --- a/api_docs/kbn_logging_mocks.mdx +++ b/api_docs/kbn_logging_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging-mocks title: "@kbn/logging-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging-mocks plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging-mocks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_mapbox_gl.devdocs.json b/api_docs/kbn_mapbox_gl.devdocs.json index 845de56441c91..ac4e6d8bdf62e 100644 --- a/api_docs/kbn_mapbox_gl.devdocs.json +++ b/api_docs/kbn_mapbox_gl.devdocs.json @@ -9,10 +9,18 @@ "objects": [] }, "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { "classes": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource", + "id": "def-common.GeoJSONSource", "type": "Class", "tags": [], "label": "GeoJSONSource", @@ -25,7 +33,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.type", + "id": "def-common.GeoJSONSource.type", "type": "string", "tags": [], "label": "type", @@ -38,7 +46,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.id", + "id": "def-common.GeoJSONSource.id", "type": "string", "tags": [], "label": "id", @@ -48,7 +56,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.minzoom", + "id": "def-common.GeoJSONSource.minzoom", "type": "number", "tags": [], "label": "minzoom", @@ -58,7 +66,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.maxzoom", + "id": "def-common.GeoJSONSource.maxzoom", "type": "number", "tags": [], "label": "maxzoom", @@ -68,7 +76,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.tileSize", + "id": "def-common.GeoJSONSource.tileSize", "type": "number", "tags": [], "label": "tileSize", @@ -78,7 +86,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.attribution", + "id": "def-common.GeoJSONSource.attribution", "type": "string", "tags": [], "label": "attribution", @@ -88,7 +96,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.promoteId", + "id": "def-common.GeoJSONSource.promoteId", "type": "CompoundType", "tags": [], "label": "promoteId", @@ -101,7 +109,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.isTileClipped", + "id": "def-common.GeoJSONSource.isTileClipped", "type": "boolean", "tags": [], "label": "isTileClipped", @@ -111,7 +119,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.reparseOverscaled", + "id": "def-common.GeoJSONSource.reparseOverscaled", "type": "boolean", "tags": [], "label": "reparseOverscaled", @@ -121,7 +129,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource._data", + "id": "def-common.GeoJSONSource._data", "type": "CompoundType", "tags": [], "label": "_data", @@ -134,7 +142,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource._options", + "id": "def-common.GeoJSONSource._options", "type": "Any", "tags": [], "label": "_options", @@ -147,7 +155,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.workerOptions", + "id": "def-common.GeoJSONSource.workerOptions", "type": "Any", "tags": [], "label": "workerOptions", @@ -160,7 +168,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.map", + "id": "def-common.GeoJSONSource.map", "type": "Object", "tags": [], "label": "map", @@ -173,7 +181,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.actor", + "id": "def-common.GeoJSONSource.actor", "type": "Object", "tags": [], "label": "actor", @@ -186,7 +194,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource._pendingLoads", + "id": "def-common.GeoJSONSource._pendingLoads", "type": "number", "tags": [], "label": "_pendingLoads", @@ -196,7 +204,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource._collectResourceTiming", + "id": "def-common.GeoJSONSource._collectResourceTiming", "type": "boolean", "tags": [], "label": "_collectResourceTiming", @@ -206,7 +214,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource._removed", + "id": "def-common.GeoJSONSource._removed", "type": "boolean", "tags": [], "label": "_removed", @@ -216,7 +224,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.Unnamed", + "id": "def-common.GeoJSONSource.Unnamed", "type": "Function", "tags": [ "private" @@ -231,7 +239,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.Unnamed.$1", + "id": "def-common.GeoJSONSource.Unnamed.$1", "type": "string", "tags": [], "label": "id", @@ -245,7 +253,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.Unnamed.$2", + "id": "def-common.GeoJSONSource.Unnamed.$2", "type": "CompoundType", "tags": [], "label": "options", @@ -259,7 +267,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.Unnamed.$3", + "id": "def-common.GeoJSONSource.Unnamed.$3", "type": "Object", "tags": [], "label": "dispatcher", @@ -273,7 +281,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.Unnamed.$4", + "id": "def-common.GeoJSONSource.Unnamed.$4", "type": "Object", "tags": [], "label": "eventedParent", @@ -290,7 +298,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.load", + "id": "def-common.GeoJSONSource.load", "type": "Function", "tags": [], "label": "load", @@ -305,7 +313,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.onAdd", + "id": "def-common.GeoJSONSource.onAdd", "type": "Function", "tags": [], "label": "onAdd", @@ -318,7 +326,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.onAdd.$1", + "id": "def-common.GeoJSONSource.onAdd.$1", "type": "Object", "tags": [], "label": "map", @@ -335,7 +343,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.setData", + "id": "def-common.GeoJSONSource.setData", "type": "Function", "tags": [], "label": "setData", @@ -350,7 +358,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.setData.$1", + "id": "def-common.GeoJSONSource.setData.$1", "type": "CompoundType", "tags": [], "label": "data", @@ -371,7 +379,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterExpansionZoom", + "id": "def-common.GeoJSONSource.getClusterExpansionZoom", "type": "Function", "tags": [], "label": "getClusterExpansionZoom", @@ -386,7 +394,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterExpansionZoom.$1", + "id": "def-common.GeoJSONSource.getClusterExpansionZoom.$1", "type": "number", "tags": [], "label": "clusterId", @@ -402,7 +410,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterExpansionZoom.$2", + "id": "def-common.GeoJSONSource.getClusterExpansionZoom.$2", "type": "Function", "tags": [], "label": "callback", @@ -423,7 +431,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterChildren", + "id": "def-common.GeoJSONSource.getClusterChildren", "type": "Function", "tags": [], "label": "getClusterChildren", @@ -438,7 +446,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterChildren.$1", + "id": "def-common.GeoJSONSource.getClusterChildren.$1", "type": "number", "tags": [], "label": "clusterId", @@ -454,7 +462,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterChildren.$2", + "id": "def-common.GeoJSONSource.getClusterChildren.$2", "type": "Function", "tags": [], "label": "callback", @@ -475,7 +483,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterLeaves", + "id": "def-common.GeoJSONSource.getClusterLeaves", "type": "Function", "tags": [], "label": "getClusterLeaves", @@ -490,7 +498,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterLeaves.$1", + "id": "def-common.GeoJSONSource.getClusterLeaves.$1", "type": "number", "tags": [], "label": "clusterId", @@ -506,7 +514,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterLeaves.$2", + "id": "def-common.GeoJSONSource.getClusterLeaves.$2", "type": "number", "tags": [], "label": "limit", @@ -522,7 +530,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterLeaves.$3", + "id": "def-common.GeoJSONSource.getClusterLeaves.$3", "type": "number", "tags": [], "label": "offset", @@ -538,7 +546,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.getClusterLeaves.$4", + "id": "def-common.GeoJSONSource.getClusterLeaves.$4", "type": "Function", "tags": [], "label": "callback", @@ -559,7 +567,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource._updateWorkerData", + "id": "def-common.GeoJSONSource._updateWorkerData", "type": "Function", "tags": [], "label": "_updateWorkerData", @@ -572,7 +580,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource._updateWorkerData.$1", + "id": "def-common.GeoJSONSource._updateWorkerData.$1", "type": "CompoundType", "tags": [], "label": "sourceDataType", @@ -589,7 +597,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.loaded", + "id": "def-common.GeoJSONSource.loaded", "type": "Function", "tags": [], "label": "loaded", @@ -604,7 +612,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.loadTile", + "id": "def-common.GeoJSONSource.loadTile", "type": "Function", "tags": [], "label": "loadTile", @@ -617,7 +625,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.loadTile.$1", + "id": "def-common.GeoJSONSource.loadTile.$1", "type": "Object", "tags": [], "label": "tile", @@ -631,7 +639,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.loadTile.$2", + "id": "def-common.GeoJSONSource.loadTile.$2", "type": "Function", "tags": [], "label": "callback", @@ -648,7 +656,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.abortTile", + "id": "def-common.GeoJSONSource.abortTile", "type": "Function", "tags": [], "label": "abortTile", @@ -661,7 +669,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.abortTile.$1", + "id": "def-common.GeoJSONSource.abortTile.$1", "type": "Object", "tags": [], "label": "tile", @@ -678,7 +686,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.unloadTile", + "id": "def-common.GeoJSONSource.unloadTile", "type": "Function", "tags": [], "label": "unloadTile", @@ -691,7 +699,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.unloadTile.$1", + "id": "def-common.GeoJSONSource.unloadTile.$1", "type": "Object", "tags": [], "label": "tile", @@ -708,7 +716,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.onRemove", + "id": "def-common.GeoJSONSource.onRemove", "type": "Function", "tags": [], "label": "onRemove", @@ -723,7 +731,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.serialize", + "id": "def-common.GeoJSONSource.serialize", "type": "Function", "tags": [], "label": "serialize", @@ -738,7 +746,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.GeoJSONSource.hasTransition", + "id": "def-common.GeoJSONSource.hasTransition", "type": "Function", "tags": [], "label": "hasTransition", @@ -756,7 +764,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat", + "id": "def-common.LngLat", "type": "Class", "tags": [], "label": "LngLat", @@ -769,7 +777,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.lng", + "id": "def-common.LngLat.lng", "type": "number", "tags": [], "label": "lng", @@ -779,7 +787,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.lat", + "id": "def-common.LngLat.lat", "type": "number", "tags": [], "label": "lat", @@ -789,7 +797,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.Unnamed", + "id": "def-common.LngLat.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -802,7 +810,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.Unnamed.$1", + "id": "def-common.LngLat.Unnamed.$1", "type": "number", "tags": [], "label": "lng", @@ -816,7 +824,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.Unnamed.$2", + "id": "def-common.LngLat.Unnamed.$2", "type": "number", "tags": [], "label": "lat", @@ -833,7 +841,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.wrap", + "id": "def-common.LngLat.wrap", "type": "Function", "tags": [], "label": "wrap", @@ -852,7 +860,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.toArray", + "id": "def-common.LngLat.toArray", "type": "Function", "tags": [], "label": "toArray", @@ -871,7 +879,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.toString", + "id": "def-common.LngLat.toString", "type": "Function", "tags": [], "label": "toString", @@ -890,7 +898,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.distanceTo", + "id": "def-common.LngLat.distanceTo", "type": "Function", "tags": [], "label": "distanceTo", @@ -905,7 +913,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.distanceTo.$1", + "id": "def-common.LngLat.distanceTo.$1", "type": "Object", "tags": [], "label": "lngLat", @@ -926,7 +934,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.toBounds", + "id": "def-common.LngLat.toBounds", "type": "Function", "tags": [], "label": "toBounds", @@ -941,7 +949,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.toBounds.$1", + "id": "def-common.LngLat.toBounds.$1", "type": "number", "tags": [], "label": "radius", @@ -962,7 +970,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.convert", + "id": "def-common.LngLat.convert", "type": "Function", "tags": [], "label": "convert", @@ -977,7 +985,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLat.convert.$1", + "id": "def-common.LngLat.convert.$1", "type": "CompoundType", "tags": [], "label": "input", @@ -1001,7 +1009,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds", + "id": "def-common.LngLatBounds", "type": "Class", "tags": [], "label": "LngLatBounds", @@ -1014,7 +1022,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds._ne", + "id": "def-common.LngLatBounds._ne", "type": "Object", "tags": [], "label": "_ne", @@ -1027,7 +1035,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds._sw", + "id": "def-common.LngLatBounds._sw", "type": "Object", "tags": [], "label": "_sw", @@ -1040,7 +1048,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.Unnamed", + "id": "def-common.LngLatBounds.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -1053,7 +1061,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.Unnamed.$1", + "id": "def-common.LngLatBounds.Unnamed.$1", "type": "Any", "tags": [], "label": "sw", @@ -1067,7 +1075,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.Unnamed.$2", + "id": "def-common.LngLatBounds.Unnamed.$2", "type": "Any", "tags": [], "label": "ne", @@ -1084,7 +1092,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.setNorthEast", + "id": "def-common.LngLatBounds.setNorthEast", "type": "Function", "tags": [], "label": "setNorthEast", @@ -1099,7 +1107,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.setNorthEast.$1", + "id": "def-common.LngLatBounds.setNorthEast.$1", "type": "CompoundType", "tags": [], "label": "ne", @@ -1120,7 +1128,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.setSouthWest", + "id": "def-common.LngLatBounds.setSouthWest", "type": "Function", "tags": [], "label": "setSouthWest", @@ -1135,7 +1143,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.setSouthWest.$1", + "id": "def-common.LngLatBounds.setSouthWest.$1", "type": "CompoundType", "tags": [], "label": "sw", @@ -1156,7 +1164,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.extend", + "id": "def-common.LngLatBounds.extend", "type": "Function", "tags": [], "label": "extend", @@ -1171,7 +1179,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.extend.$1", + "id": "def-common.LngLatBounds.extend.$1", "type": "CompoundType", "tags": [], "label": "obj", @@ -1192,7 +1200,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getCenter", + "id": "def-common.LngLatBounds.getCenter", "type": "Function", "tags": [], "label": "getCenter", @@ -1211,7 +1219,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getSouthWest", + "id": "def-common.LngLatBounds.getSouthWest", "type": "Function", "tags": [], "label": "getSouthWest", @@ -1230,7 +1238,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getNorthEast", + "id": "def-common.LngLatBounds.getNorthEast", "type": "Function", "tags": [], "label": "getNorthEast", @@ -1249,7 +1257,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getNorthWest", + "id": "def-common.LngLatBounds.getNorthWest", "type": "Function", "tags": [], "label": "getNorthWest", @@ -1268,7 +1276,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getSouthEast", + "id": "def-common.LngLatBounds.getSouthEast", "type": "Function", "tags": [], "label": "getSouthEast", @@ -1287,7 +1295,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getWest", + "id": "def-common.LngLatBounds.getWest", "type": "Function", "tags": [], "label": "getWest", @@ -1306,7 +1314,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getSouth", + "id": "def-common.LngLatBounds.getSouth", "type": "Function", "tags": [], "label": "getSouth", @@ -1325,7 +1333,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getEast", + "id": "def-common.LngLatBounds.getEast", "type": "Function", "tags": [], "label": "getEast", @@ -1344,7 +1352,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.getNorth", + "id": "def-common.LngLatBounds.getNorth", "type": "Function", "tags": [], "label": "getNorth", @@ -1363,7 +1371,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.toArray", + "id": "def-common.LngLatBounds.toArray", "type": "Function", "tags": [], "label": "toArray", @@ -1382,7 +1390,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.toString", + "id": "def-common.LngLatBounds.toString", "type": "Function", "tags": [], "label": "toString", @@ -1401,7 +1409,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.isEmpty", + "id": "def-common.LngLatBounds.isEmpty", "type": "Function", "tags": [], "label": "isEmpty", @@ -1420,7 +1428,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.contains", + "id": "def-common.LngLatBounds.contains", "type": "Function", "tags": [], "label": "contains", @@ -1435,7 +1443,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.contains.$1", + "id": "def-common.LngLatBounds.contains.$1", "type": "CompoundType", "tags": [], "label": "lnglat", @@ -1456,7 +1464,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.convert", + "id": "def-common.LngLatBounds.convert", "type": "Function", "tags": [], "label": "convert", @@ -1471,7 +1479,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LngLatBounds.convert.$1", + "id": "def-common.LngLatBounds.convert.$1", "type": "CompoundType", "tags": [], "label": "input", @@ -1495,7 +1503,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map", + "id": "def-common.Map", "type": "Class", "tags": [], "label": "Map", @@ -1508,7 +1516,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.style", + "id": "def-common.Map.style", "type": "Object", "tags": [], "label": "style", @@ -1521,7 +1529,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.painter", + "id": "def-common.Map.painter", "type": "Object", "tags": [], "label": "painter", @@ -1534,7 +1542,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.handlers", + "id": "def-common.Map.handlers", "type": "Object", "tags": [], "label": "handlers", @@ -1547,7 +1555,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._container", + "id": "def-common.Map._container", "type": "Object", "tags": [], "label": "_container", @@ -1560,7 +1568,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._canvasContainer", + "id": "def-common.Map._canvasContainer", "type": "Object", "tags": [], "label": "_canvasContainer", @@ -1573,7 +1581,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._controlContainer", + "id": "def-common.Map._controlContainer", "type": "Object", "tags": [], "label": "_controlContainer", @@ -1586,7 +1594,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._controlPositions", + "id": "def-common.Map._controlPositions", "type": "Object", "tags": [], "label": "_controlPositions", @@ -1599,7 +1607,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._interactive", + "id": "def-common.Map._interactive", "type": "boolean", "tags": [], "label": "_interactive", @@ -1609,7 +1617,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._showTileBoundaries", + "id": "def-common.Map._showTileBoundaries", "type": "boolean", "tags": [], "label": "_showTileBoundaries", @@ -1619,7 +1627,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._showCollisionBoxes", + "id": "def-common.Map._showCollisionBoxes", "type": "boolean", "tags": [], "label": "_showCollisionBoxes", @@ -1629,7 +1637,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._showPadding", + "id": "def-common.Map._showPadding", "type": "boolean", "tags": [], "label": "_showPadding", @@ -1639,7 +1647,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._showOverdrawInspector", + "id": "def-common.Map._showOverdrawInspector", "type": "boolean", "tags": [], "label": "_showOverdrawInspector", @@ -1649,7 +1657,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._repaint", + "id": "def-common.Map._repaint", "type": "boolean", "tags": [], "label": "_repaint", @@ -1659,7 +1667,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._vertices", + "id": "def-common.Map._vertices", "type": "boolean", "tags": [], "label": "_vertices", @@ -1669,7 +1677,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._canvas", + "id": "def-common.Map._canvas", "type": "Object", "tags": [], "label": "_canvas", @@ -1682,7 +1690,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._maxTileCacheSize", + "id": "def-common.Map._maxTileCacheSize", "type": "number", "tags": [], "label": "_maxTileCacheSize", @@ -1692,7 +1700,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._frame", + "id": "def-common.Map._frame", "type": "Object", "tags": [], "label": "_frame", @@ -1705,7 +1713,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._styleDirty", + "id": "def-common.Map._styleDirty", "type": "boolean", "tags": [], "label": "_styleDirty", @@ -1715,7 +1723,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._sourcesDirty", + "id": "def-common.Map._sourcesDirty", "type": "boolean", "tags": [], "label": "_sourcesDirty", @@ -1725,7 +1733,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._placementDirty", + "id": "def-common.Map._placementDirty", "type": "boolean", "tags": [], "label": "_placementDirty", @@ -1735,7 +1743,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._loaded", + "id": "def-common.Map._loaded", "type": "boolean", "tags": [], "label": "_loaded", @@ -1745,7 +1753,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._fullyLoaded", + "id": "def-common.Map._fullyLoaded", "type": "boolean", "tags": [], "label": "_fullyLoaded", @@ -1755,7 +1763,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._trackResize", + "id": "def-common.Map._trackResize", "type": "boolean", "tags": [], "label": "_trackResize", @@ -1765,7 +1773,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._preserveDrawingBuffer", + "id": "def-common.Map._preserveDrawingBuffer", "type": "boolean", "tags": [], "label": "_preserveDrawingBuffer", @@ -1775,7 +1783,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._failIfMajorPerformanceCaveat", + "id": "def-common.Map._failIfMajorPerformanceCaveat", "type": "boolean", "tags": [], "label": "_failIfMajorPerformanceCaveat", @@ -1785,7 +1793,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._antialias", + "id": "def-common.Map._antialias", "type": "boolean", "tags": [], "label": "_antialias", @@ -1795,7 +1803,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._refreshExpiredTiles", + "id": "def-common.Map._refreshExpiredTiles", "type": "boolean", "tags": [], "label": "_refreshExpiredTiles", @@ -1805,7 +1813,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._hash", + "id": "def-common.Map._hash", "type": "Object", "tags": [], "label": "_hash", @@ -1818,7 +1826,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._delegatedListeners", + "id": "def-common.Map._delegatedListeners", "type": "Any", "tags": [], "label": "_delegatedListeners", @@ -1831,7 +1839,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._fadeDuration", + "id": "def-common.Map._fadeDuration", "type": "number", "tags": [], "label": "_fadeDuration", @@ -1841,7 +1849,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._crossSourceCollisions", + "id": "def-common.Map._crossSourceCollisions", "type": "boolean", "tags": [], "label": "_crossSourceCollisions", @@ -1851,7 +1859,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._crossFadingFactor", + "id": "def-common.Map._crossFadingFactor", "type": "number", "tags": [], "label": "_crossFadingFactor", @@ -1861,7 +1869,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._collectResourceTiming", + "id": "def-common.Map._collectResourceTiming", "type": "boolean", "tags": [], "label": "_collectResourceTiming", @@ -1871,7 +1879,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._renderTaskQueue", + "id": "def-common.Map._renderTaskQueue", "type": "Object", "tags": [], "label": "_renderTaskQueue", @@ -1884,7 +1892,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._controls", + "id": "def-common.Map._controls", "type": "Array", "tags": [], "label": "_controls", @@ -1897,7 +1905,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._mapId", + "id": "def-common.Map._mapId", "type": "number", "tags": [], "label": "_mapId", @@ -1907,7 +1915,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._localIdeographFontFamily", + "id": "def-common.Map._localIdeographFontFamily", "type": "string", "tags": [], "label": "_localIdeographFontFamily", @@ -1917,7 +1925,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._requestManager", + "id": "def-common.Map._requestManager", "type": "Object", "tags": [], "label": "_requestManager", @@ -1930,7 +1938,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._locale", + "id": "def-common.Map._locale", "type": "Any", "tags": [], "label": "_locale", @@ -1943,7 +1951,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._removed", + "id": "def-common.Map._removed", "type": "boolean", "tags": [], "label": "_removed", @@ -1953,7 +1961,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._clickTolerance", + "id": "def-common.Map._clickTolerance", "type": "number", "tags": [], "label": "_clickTolerance", @@ -1963,7 +1971,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._pixelRatio", + "id": "def-common.Map._pixelRatio", "type": "number", "tags": [], "label": "_pixelRatio", @@ -1973,7 +1981,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.scrollZoom", + "id": "def-common.Map.scrollZoom", "type": "Object", "tags": [], "label": "scrollZoom", @@ -1988,7 +1996,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.boxZoom", + "id": "def-common.Map.boxZoom", "type": "Object", "tags": [], "label": "boxZoom", @@ -2003,7 +2011,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.dragRotate", + "id": "def-common.Map.dragRotate", "type": "Object", "tags": [], "label": "dragRotate", @@ -2018,7 +2026,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.dragPan", + "id": "def-common.Map.dragPan", "type": "Object", "tags": [], "label": "dragPan", @@ -2033,7 +2041,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.keyboard", + "id": "def-common.Map.keyboard", "type": "Object", "tags": [], "label": "keyboard", @@ -2048,7 +2056,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.doubleClickZoom", + "id": "def-common.Map.doubleClickZoom", "type": "Object", "tags": [], "label": "doubleClickZoom", @@ -2063,7 +2071,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.touchZoomRotate", + "id": "def-common.Map.touchZoomRotate", "type": "Object", "tags": [], "label": "touchZoomRotate", @@ -2078,7 +2086,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.touchPitch", + "id": "def-common.Map.touchPitch", "type": "Object", "tags": [], "label": "touchPitch", @@ -2093,7 +2101,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.Unnamed", + "id": "def-common.Map.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -2106,7 +2114,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.Unnamed.$1", + "id": "def-common.Map.Unnamed.$1", "type": "Object", "tags": [], "label": "options", @@ -2123,7 +2131,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._getMapId", + "id": "def-common.Map._getMapId", "type": "Function", "tags": [], "label": "_getMapId", @@ -2138,7 +2146,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addControl", + "id": "def-common.Map.addControl", "type": "Function", "tags": [ "see" @@ -2155,7 +2163,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addControl.$1", + "id": "def-common.Map.addControl.$1", "type": "Object", "tags": [], "label": "control", @@ -2171,7 +2179,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addControl.$2", + "id": "def-common.Map.addControl.$2", "type": "CompoundType", "tags": [], "label": "position", @@ -2192,7 +2200,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeControl", + "id": "def-common.Map.removeControl", "type": "Function", "tags": [], "label": "removeControl", @@ -2207,7 +2215,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeControl.$1", + "id": "def-common.Map.removeControl.$1", "type": "Object", "tags": [], "label": "control", @@ -2228,7 +2236,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.hasControl", + "id": "def-common.Map.hasControl", "type": "Function", "tags": [], "label": "hasControl", @@ -2243,7 +2251,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.hasControl.$1", + "id": "def-common.Map.hasControl.$1", "type": "Object", "tags": [], "label": "control", @@ -2264,7 +2272,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.resize", + "id": "def-common.Map.resize", "type": "Function", "tags": [], "label": "resize", @@ -2279,7 +2287,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.resize.$1", + "id": "def-common.Map.resize.$1", "type": "Any", "tags": [], "label": "eventData", @@ -2300,7 +2308,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getPixelRatio", + "id": "def-common.Map.getPixelRatio", "type": "Function", "tags": [], "label": "getPixelRatio", @@ -2319,7 +2327,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPixelRatio", + "id": "def-common.Map.setPixelRatio", "type": "Function", "tags": [], "label": "setPixelRatio", @@ -2334,7 +2342,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPixelRatio.$1", + "id": "def-common.Map.setPixelRatio.$1", "type": "number", "tags": [], "label": "pixelRatio", @@ -2353,7 +2361,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getBounds", + "id": "def-common.Map.getBounds", "type": "Function", "tags": [], "label": "getBounds", @@ -2372,7 +2380,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getMaxBounds", + "id": "def-common.Map.getMaxBounds", "type": "Function", "tags": [], "label": "getMaxBounds", @@ -2391,7 +2399,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMaxBounds", + "id": "def-common.Map.setMaxBounds", "type": "Function", "tags": [], "label": "setMaxBounds", @@ -2406,7 +2414,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMaxBounds.$1", + "id": "def-common.Map.setMaxBounds.$1", "type": "CompoundType", "tags": [], "label": "bounds", @@ -2427,7 +2435,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMinZoom", + "id": "def-common.Map.setMinZoom", "type": "Function", "tags": [], "label": "setMinZoom", @@ -2442,7 +2450,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMinZoom.$1", + "id": "def-common.Map.setMinZoom.$1", "type": "CompoundType", "tags": [], "label": "minZoom", @@ -2463,7 +2471,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getMinZoom", + "id": "def-common.Map.getMinZoom", "type": "Function", "tags": [], "label": "getMinZoom", @@ -2482,7 +2490,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMaxZoom", + "id": "def-common.Map.setMaxZoom", "type": "Function", "tags": [], "label": "setMaxZoom", @@ -2497,7 +2505,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMaxZoom.$1", + "id": "def-common.Map.setMaxZoom.$1", "type": "CompoundType", "tags": [], "label": "maxZoom", @@ -2518,7 +2526,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getMaxZoom", + "id": "def-common.Map.getMaxZoom", "type": "Function", "tags": [], "label": "getMaxZoom", @@ -2537,7 +2545,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMinPitch", + "id": "def-common.Map.setMinPitch", "type": "Function", "tags": [], "label": "setMinPitch", @@ -2552,7 +2560,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMinPitch.$1", + "id": "def-common.Map.setMinPitch.$1", "type": "CompoundType", "tags": [], "label": "minPitch", @@ -2573,7 +2581,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getMinPitch", + "id": "def-common.Map.getMinPitch", "type": "Function", "tags": [], "label": "getMinPitch", @@ -2592,7 +2600,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMaxPitch", + "id": "def-common.Map.setMaxPitch", "type": "Function", "tags": [], "label": "setMaxPitch", @@ -2607,7 +2615,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setMaxPitch.$1", + "id": "def-common.Map.setMaxPitch.$1", "type": "CompoundType", "tags": [], "label": "maxPitch", @@ -2628,7 +2636,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getMaxPitch", + "id": "def-common.Map.getMaxPitch", "type": "Function", "tags": [], "label": "getMaxPitch", @@ -2647,7 +2655,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getRenderWorldCopies", + "id": "def-common.Map.getRenderWorldCopies", "type": "Function", "tags": [ "see" @@ -2668,7 +2676,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setRenderWorldCopies", + "id": "def-common.Map.setRenderWorldCopies", "type": "Function", "tags": [ "see" @@ -2685,7 +2693,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setRenderWorldCopies.$1", + "id": "def-common.Map.setRenderWorldCopies.$1", "type": "CompoundType", "tags": [], "label": "renderWorldCopies", @@ -2706,7 +2714,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.project", + "id": "def-common.Map.project", "type": "Function", "tags": [], "label": "project", @@ -2722,7 +2730,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.project.$1", + "id": "def-common.Map.project.$1", "type": "CompoundType", "tags": [], "label": "lnglat", @@ -2743,7 +2751,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.unproject", + "id": "def-common.Map.unproject", "type": "Function", "tags": [], "label": "unproject", @@ -2758,7 +2766,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.unproject.$1", + "id": "def-common.Map.unproject.$1", "type": "CompoundType", "tags": [], "label": "point", @@ -2779,7 +2787,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.isMoving", + "id": "def-common.Map.isMoving", "type": "Function", "tags": [], "label": "isMoving", @@ -2798,7 +2806,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.isZooming", + "id": "def-common.Map.isZooming", "type": "Function", "tags": [], "label": "isZooming", @@ -2817,7 +2825,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.isRotating", + "id": "def-common.Map.isRotating", "type": "Function", "tags": [], "label": "isRotating", @@ -2836,7 +2844,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._createDelegatedListener", + "id": "def-common.Map._createDelegatedListener", "type": "Function", "tags": [], "label": "_createDelegatedListener", @@ -2849,7 +2857,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._createDelegatedListener.$1", + "id": "def-common.Map._createDelegatedListener.$1", "type": "string", "tags": [], "label": "type", @@ -2863,7 +2871,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._createDelegatedListener.$2", + "id": "def-common.Map._createDelegatedListener.$2", "type": "string", "tags": [], "label": "layerId", @@ -2877,7 +2885,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._createDelegatedListener.$3", + "id": "def-common.Map._createDelegatedListener.$3", "type": "Function", "tags": [], "label": "listener", @@ -2894,7 +2902,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on", + "id": "def-common.Map.on", "type": "Function", "tags": [ "see", @@ -2914,7 +2922,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on.$1", + "id": "def-common.Map.on.$1", "type": "Uncategorized", "tags": [], "label": "type", @@ -2930,7 +2938,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on.$2", + "id": "def-common.Map.on.$2", "type": "string", "tags": [], "label": "layer", @@ -2944,7 +2952,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on.$3", + "id": "def-common.Map.on.$3", "type": "Function", "tags": [], "label": "listener", @@ -2965,7 +2973,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on", + "id": "def-common.Map.on", "type": "Function", "tags": [], "label": "on", @@ -2978,7 +2986,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on.$1", + "id": "def-common.Map.on.$1", "type": "Uncategorized", "tags": [], "label": "type", @@ -2992,7 +3000,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on.$2", + "id": "def-common.Map.on.$2", "type": "Function", "tags": [], "label": "listener", @@ -3009,7 +3017,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on", + "id": "def-common.Map.on", "type": "Function", "tags": [], "label": "on", @@ -3022,7 +3030,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on.$1", + "id": "def-common.Map.on.$1", "type": "string", "tags": [], "label": "type", @@ -3036,7 +3044,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.on.$2", + "id": "def-common.Map.on.$2", "type": "Function", "tags": [], "label": "listener", @@ -3053,7 +3061,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once", + "id": "def-common.Map.once", "type": "Function", "tags": [ "method", @@ -3073,7 +3081,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once.$1", + "id": "def-common.Map.once.$1", "type": "Uncategorized", "tags": [], "label": "type", @@ -3089,7 +3097,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once.$2", + "id": "def-common.Map.once.$2", "type": "string", "tags": [], "label": "layer", @@ -3103,7 +3111,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once.$3", + "id": "def-common.Map.once.$3", "type": "Function", "tags": [], "label": "listener", @@ -3124,7 +3132,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once", + "id": "def-common.Map.once", "type": "Function", "tags": [], "label": "once", @@ -3137,7 +3145,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once.$1", + "id": "def-common.Map.once.$1", "type": "Uncategorized", "tags": [], "label": "type", @@ -3151,7 +3159,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once.$2", + "id": "def-common.Map.once.$2", "type": "Function", "tags": [], "label": "listener", @@ -3168,7 +3176,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once", + "id": "def-common.Map.once", "type": "Function", "tags": [], "label": "once", @@ -3181,7 +3189,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once.$1", + "id": "def-common.Map.once.$1", "type": "string", "tags": [], "label": "type", @@ -3195,7 +3203,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.once.$2", + "id": "def-common.Map.once.$2", "type": "Function", "tags": [], "label": "listener", @@ -3212,7 +3220,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off", + "id": "def-common.Map.off", "type": "Function", "tags": [ "method", @@ -3232,7 +3240,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off.$1", + "id": "def-common.Map.off.$1", "type": "Uncategorized", "tags": [], "label": "type", @@ -3248,7 +3256,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off.$2", + "id": "def-common.Map.off.$2", "type": "string", "tags": [], "label": "layer", @@ -3262,7 +3270,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off.$3", + "id": "def-common.Map.off.$3", "type": "Function", "tags": [], "label": "listener", @@ -3283,7 +3291,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off", + "id": "def-common.Map.off", "type": "Function", "tags": [], "label": "off", @@ -3296,7 +3304,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off.$1", + "id": "def-common.Map.off.$1", "type": "Uncategorized", "tags": [], "label": "type", @@ -3310,7 +3318,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off.$2", + "id": "def-common.Map.off.$2", "type": "Function", "tags": [], "label": "listener", @@ -3327,7 +3335,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off", + "id": "def-common.Map.off", "type": "Function", "tags": [], "label": "off", @@ -3340,7 +3348,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off.$1", + "id": "def-common.Map.off.$1", "type": "string", "tags": [], "label": "type", @@ -3354,7 +3362,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.off.$2", + "id": "def-common.Map.off.$2", "type": "Function", "tags": [], "label": "listener", @@ -3371,7 +3379,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.queryRenderedFeatures", + "id": "def-common.Map.queryRenderedFeatures", "type": "Function", "tags": [ "see" @@ -3388,7 +3396,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.queryRenderedFeatures.$1", + "id": "def-common.Map.queryRenderedFeatures.$1", "type": "CompoundType", "tags": [], "label": "geometry", @@ -3404,7 +3412,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.queryRenderedFeatures.$2", + "id": "def-common.Map.queryRenderedFeatures.$2", "type": "Any", "tags": [], "label": "options", @@ -3425,7 +3433,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.querySourceFeatures", + "id": "def-common.Map.querySourceFeatures", "type": "Function", "tags": [], "label": "querySourceFeatures", @@ -3440,7 +3448,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.querySourceFeatures.$1", + "id": "def-common.Map.querySourceFeatures.$1", "type": "string", "tags": [], "label": "sourceId", @@ -3456,7 +3464,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.querySourceFeatures.$2", + "id": "def-common.Map.querySourceFeatures.$2", "type": "CompoundType", "tags": [], "label": "parameters", @@ -3477,7 +3485,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setStyle", + "id": "def-common.Map.setStyle", "type": "Function", "tags": [], "label": "setStyle", @@ -3492,7 +3500,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setStyle.$1", + "id": "def-common.Map.setStyle.$1", "type": "CompoundType", "tags": [], "label": "style", @@ -3508,7 +3516,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setStyle.$2", + "id": "def-common.Map.setStyle.$2", "type": "CompoundType", "tags": [], "label": "options", @@ -3529,7 +3537,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setTransformRequest", + "id": "def-common.Map.setTransformRequest", "type": "Function", "tags": [], "label": "setTransformRequest", @@ -3544,7 +3552,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setTransformRequest.$1", + "id": "def-common.Map.setTransformRequest.$1", "type": "Function", "tags": [], "label": "transformRequest", @@ -3565,7 +3573,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._getUIString", + "id": "def-common.Map._getUIString", "type": "Function", "tags": [], "label": "_getUIString", @@ -3578,7 +3586,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._getUIString.$1", + "id": "def-common.Map._getUIString.$1", "type": "string", "tags": [], "label": "key", @@ -3595,7 +3603,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._updateStyle", + "id": "def-common.Map._updateStyle", "type": "Function", "tags": [], "label": "_updateStyle", @@ -3608,7 +3616,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._updateStyle.$1", + "id": "def-common.Map._updateStyle.$1", "type": "CompoundType", "tags": [], "label": "style", @@ -3622,7 +3630,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._updateStyle.$2", + "id": "def-common.Map._updateStyle.$2", "type": "CompoundType", "tags": [], "label": "options", @@ -3639,7 +3647,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._lazyInitEmptyStyle", + "id": "def-common.Map._lazyInitEmptyStyle", "type": "Function", "tags": [], "label": "_lazyInitEmptyStyle", @@ -3654,7 +3662,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._diffStyle", + "id": "def-common.Map._diffStyle", "type": "Function", "tags": [], "label": "_diffStyle", @@ -3667,7 +3675,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._diffStyle.$1", + "id": "def-common.Map._diffStyle.$1", "type": "CompoundType", "tags": [], "label": "style", @@ -3681,7 +3689,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._diffStyle.$2", + "id": "def-common.Map._diffStyle.$2", "type": "CompoundType", "tags": [], "label": "options", @@ -3698,7 +3706,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._updateDiff", + "id": "def-common.Map._updateDiff", "type": "Function", "tags": [], "label": "_updateDiff", @@ -3711,7 +3719,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._updateDiff.$1", + "id": "def-common.Map._updateDiff.$1", "type": "Object", "tags": [], "label": "style", @@ -3725,7 +3733,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._updateDiff.$2", + "id": "def-common.Map._updateDiff.$2", "type": "CompoundType", "tags": [], "label": "options", @@ -3742,7 +3750,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getStyle", + "id": "def-common.Map.getStyle", "type": "Function", "tags": [], "label": "getStyle", @@ -3761,7 +3769,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.isStyleLoaded", + "id": "def-common.Map.isStyleLoaded", "type": "Function", "tags": [], "label": "isStyleLoaded", @@ -3780,7 +3788,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addSource", + "id": "def-common.Map.addSource", "type": "Function", "tags": [ "fires", @@ -3798,7 +3806,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addSource.$1", + "id": "def-common.Map.addSource.$1", "type": "string", "tags": [], "label": "id", @@ -3814,7 +3822,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addSource.$2", + "id": "def-common.Map.addSource.$2", "type": "CompoundType", "tags": [], "label": "source", @@ -3835,7 +3843,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.isSourceLoaded", + "id": "def-common.Map.isSourceLoaded", "type": "Function", "tags": [], "label": "isSourceLoaded", @@ -3850,7 +3858,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.isSourceLoaded.$1", + "id": "def-common.Map.isSourceLoaded.$1", "type": "string", "tags": [], "label": "id", @@ -3871,7 +3879,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.areTilesLoaded", + "id": "def-common.Map.areTilesLoaded", "type": "Function", "tags": [], "label": "areTilesLoaded", @@ -3890,7 +3898,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addSourceType", + "id": "def-common.Map.addSourceType", "type": "Function", "tags": [ "private" @@ -3907,7 +3915,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addSourceType.$1", + "id": "def-common.Map.addSourceType.$1", "type": "string", "tags": [], "label": "name", @@ -3923,7 +3931,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addSourceType.$2", + "id": "def-common.Map.addSourceType.$2", "type": "Any", "tags": [], "label": "SourceType", @@ -3939,7 +3947,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addSourceType.$3", + "id": "def-common.Map.addSourceType.$3", "type": "Function", "tags": [], "label": "callback", @@ -3958,7 +3966,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeSource", + "id": "def-common.Map.removeSource", "type": "Function", "tags": [], "label": "removeSource", @@ -3973,7 +3981,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeSource.$1", + "id": "def-common.Map.removeSource.$1", "type": "string", "tags": [], "label": "id", @@ -3994,7 +4002,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getSource", + "id": "def-common.Map.getSource", "type": "Function", "tags": [ "see", @@ -4013,7 +4021,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getSource.$1", + "id": "def-common.Map.getSource.$1", "type": "string", "tags": [], "label": "id", @@ -4034,7 +4042,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addImage", + "id": "def-common.Map.addImage", "type": "Function", "tags": [ "see", @@ -4052,7 +4060,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addImage.$1", + "id": "def-common.Map.addImage.$1", "type": "string", "tags": [], "label": "id", @@ -4068,7 +4076,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addImage.$2", + "id": "def-common.Map.addImage.$2", "type": "CompoundType", "tags": [], "label": "image", @@ -4084,7 +4092,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addImage.$3", + "id": "def-common.Map.addImage.$3", "type": "Object", "tags": [], "label": "{ pixelRatio, sdf, stretchX, stretchY, content }", @@ -4101,7 +4109,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.updateImage", + "id": "def-common.Map.updateImage", "type": "Function", "tags": [], "label": "updateImage", @@ -4116,7 +4124,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.updateImage.$1", + "id": "def-common.Map.updateImage.$1", "type": "string", "tags": [], "label": "id", @@ -4132,7 +4140,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.updateImage.$2", + "id": "def-common.Map.updateImage.$2", "type": "CompoundType", "tags": [], "label": "image", @@ -4151,7 +4159,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.hasImage", + "id": "def-common.Map.hasImage", "type": "Function", "tags": [], "label": "hasImage", @@ -4166,7 +4174,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.hasImage.$1", + "id": "def-common.Map.hasImage.$1", "type": "string", "tags": [], "label": "id", @@ -4187,7 +4195,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeImage", + "id": "def-common.Map.removeImage", "type": "Function", "tags": [], "label": "removeImage", @@ -4202,7 +4210,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeImage.$1", + "id": "def-common.Map.removeImage.$1", "type": "string", "tags": [], "label": "id", @@ -4221,7 +4229,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.loadImage", + "id": "def-common.Map.loadImage", "type": "Function", "tags": [ "see" @@ -4238,7 +4246,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.loadImage.$1", + "id": "def-common.Map.loadImage.$1", "type": "string", "tags": [], "label": "url", @@ -4254,7 +4262,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.loadImage.$2", + "id": "def-common.Map.loadImage.$2", "type": "Function", "tags": [], "label": "callback", @@ -4273,7 +4281,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.listImages", + "id": "def-common.Map.listImages", "type": "Function", "tags": [], "label": "listImages", @@ -4292,7 +4300,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addLayer", + "id": "def-common.Map.addLayer", "type": "Function", "tags": [ "see", @@ -4311,7 +4319,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addLayer.$1", + "id": "def-common.Map.addLayer.$1", "type": "CompoundType", "tags": [], "label": "layer", @@ -4327,7 +4335,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.addLayer.$2", + "id": "def-common.Map.addLayer.$2", "type": "string", "tags": [], "label": "beforeId", @@ -4348,7 +4356,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.moveLayer", + "id": "def-common.Map.moveLayer", "type": "Function", "tags": [], "label": "moveLayer", @@ -4363,7 +4371,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.moveLayer.$1", + "id": "def-common.Map.moveLayer.$1", "type": "string", "tags": [], "label": "id", @@ -4379,7 +4387,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.moveLayer.$2", + "id": "def-common.Map.moveLayer.$2", "type": "string", "tags": [], "label": "beforeId", @@ -4400,7 +4408,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeLayer", + "id": "def-common.Map.removeLayer", "type": "Function", "tags": [ "fires" @@ -4417,7 +4425,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeLayer.$1", + "id": "def-common.Map.removeLayer.$1", "type": "string", "tags": [], "label": "id", @@ -4436,7 +4444,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getLayer", + "id": "def-common.Map.getLayer", "type": "Function", "tags": [ "see", @@ -4454,7 +4462,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getLayer.$1", + "id": "def-common.Map.getLayer.$1", "type": "string", "tags": [], "label": "id", @@ -4475,7 +4483,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayerZoomRange", + "id": "def-common.Map.setLayerZoomRange", "type": "Function", "tags": [], "label": "setLayerZoomRange", @@ -4490,7 +4498,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayerZoomRange.$1", + "id": "def-common.Map.setLayerZoomRange.$1", "type": "string", "tags": [], "label": "layerId", @@ -4506,7 +4514,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayerZoomRange.$2", + "id": "def-common.Map.setLayerZoomRange.$2", "type": "number", "tags": [], "label": "minzoom", @@ -4522,7 +4530,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayerZoomRange.$3", + "id": "def-common.Map.setLayerZoomRange.$3", "type": "number", "tags": [], "label": "maxzoom", @@ -4543,7 +4551,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFilter", + "id": "def-common.Map.setFilter", "type": "Function", "tags": [ "see" @@ -4560,7 +4568,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFilter.$1", + "id": "def-common.Map.setFilter.$1", "type": "string", "tags": [], "label": "layerId", @@ -4576,7 +4584,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFilter.$2", + "id": "def-common.Map.setFilter.$2", "type": "CompoundType", "tags": [], "label": "filter", @@ -4592,7 +4600,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFilter.$3", + "id": "def-common.Map.setFilter.$3", "type": "Object", "tags": [], "label": "options", @@ -4613,7 +4621,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getFilter", + "id": "def-common.Map.getFilter", "type": "Function", "tags": [], "label": "getFilter", @@ -4628,7 +4636,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getFilter.$1", + "id": "def-common.Map.getFilter.$1", "type": "string", "tags": [], "label": "layerId", @@ -4649,7 +4657,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPaintProperty", + "id": "def-common.Map.setPaintProperty", "type": "Function", "tags": [ "see", @@ -4667,7 +4675,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPaintProperty.$1", + "id": "def-common.Map.setPaintProperty.$1", "type": "string", "tags": [], "label": "layerId", @@ -4683,7 +4691,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPaintProperty.$2", + "id": "def-common.Map.setPaintProperty.$2", "type": "string", "tags": [], "label": "name", @@ -4699,7 +4707,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPaintProperty.$3", + "id": "def-common.Map.setPaintProperty.$3", "type": "Any", "tags": [], "label": "value", @@ -4715,7 +4723,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setPaintProperty.$4", + "id": "def-common.Map.setPaintProperty.$4", "type": "Object", "tags": [], "label": "options", @@ -4736,7 +4744,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getPaintProperty", + "id": "def-common.Map.getPaintProperty", "type": "Function", "tags": [], "label": "getPaintProperty", @@ -4751,7 +4759,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getPaintProperty.$1", + "id": "def-common.Map.getPaintProperty.$1", "type": "string", "tags": [], "label": "layerId", @@ -4767,7 +4775,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getPaintProperty.$2", + "id": "def-common.Map.getPaintProperty.$2", "type": "string", "tags": [], "label": "name", @@ -4788,7 +4796,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayoutProperty", + "id": "def-common.Map.setLayoutProperty", "type": "Function", "tags": [], "label": "setLayoutProperty", @@ -4803,7 +4811,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayoutProperty.$1", + "id": "def-common.Map.setLayoutProperty.$1", "type": "string", "tags": [], "label": "layerId", @@ -4819,7 +4827,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayoutProperty.$2", + "id": "def-common.Map.setLayoutProperty.$2", "type": "string", "tags": [], "label": "name", @@ -4835,7 +4843,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayoutProperty.$3", + "id": "def-common.Map.setLayoutProperty.$3", "type": "Any", "tags": [], "label": "value", @@ -4851,7 +4859,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLayoutProperty.$4", + "id": "def-common.Map.setLayoutProperty.$4", "type": "Object", "tags": [], "label": "options", @@ -4872,7 +4880,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getLayoutProperty", + "id": "def-common.Map.getLayoutProperty", "type": "Function", "tags": [], "label": "getLayoutProperty", @@ -4887,7 +4895,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getLayoutProperty.$1", + "id": "def-common.Map.getLayoutProperty.$1", "type": "string", "tags": [], "label": "layerId", @@ -4903,7 +4911,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getLayoutProperty.$2", + "id": "def-common.Map.getLayoutProperty.$2", "type": "string", "tags": [], "label": "name", @@ -4924,7 +4932,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLight", + "id": "def-common.Map.setLight", "type": "Function", "tags": [], "label": "setLight", @@ -4939,7 +4947,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLight.$1", + "id": "def-common.Map.setLight.$1", "type": "Object", "tags": [], "label": "light", @@ -4955,7 +4963,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setLight.$2", + "id": "def-common.Map.setLight.$2", "type": "Object", "tags": [], "label": "options", @@ -4976,7 +4984,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getLight", + "id": "def-common.Map.getLight", "type": "Function", "tags": [], "label": "getLight", @@ -4995,7 +5003,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFeatureState", + "id": "def-common.Map.setFeatureState", "type": "Function", "tags": [ "see" @@ -5012,7 +5020,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFeatureState.$1", + "id": "def-common.Map.setFeatureState.$1", "type": "Object", "tags": [], "label": "feature", @@ -5028,7 +5036,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.setFeatureState.$2", + "id": "def-common.Map.setFeatureState.$2", "type": "Any", "tags": [], "label": "state", @@ -5047,7 +5055,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeFeatureState", + "id": "def-common.Map.removeFeatureState", "type": "Function", "tags": [], "label": "removeFeatureState", @@ -5062,7 +5070,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeFeatureState.$1", + "id": "def-common.Map.removeFeatureState.$1", "type": "Object", "tags": [], "label": "target", @@ -5078,7 +5086,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.removeFeatureState.$2", + "id": "def-common.Map.removeFeatureState.$2", "type": "string", "tags": [], "label": "key", @@ -5097,7 +5105,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getFeatureState", + "id": "def-common.Map.getFeatureState", "type": "Function", "tags": [], "label": "getFeatureState", @@ -5112,7 +5120,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getFeatureState.$1", + "id": "def-common.Map.getFeatureState.$1", "type": "Object", "tags": [], "label": "feature", @@ -5133,7 +5141,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getContainer", + "id": "def-common.Map.getContainer", "type": "Function", "tags": [], "label": "getContainer", @@ -5152,7 +5160,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getCanvasContainer", + "id": "def-common.Map.getCanvasContainer", "type": "Function", "tags": [ "see" @@ -5173,7 +5181,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.getCanvas", + "id": "def-common.Map.getCanvas", "type": "Function", "tags": [ "see", @@ -5196,7 +5204,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._containerDimensions", + "id": "def-common.Map._containerDimensions", "type": "Function", "tags": [], "label": "_containerDimensions", @@ -5211,7 +5219,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._setupContainer", + "id": "def-common.Map._setupContainer", "type": "Function", "tags": [], "label": "_setupContainer", @@ -5226,7 +5234,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._resizeCanvas", + "id": "def-common.Map._resizeCanvas", "type": "Function", "tags": [], "label": "_resizeCanvas", @@ -5239,7 +5247,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._resizeCanvas.$1", + "id": "def-common.Map._resizeCanvas.$1", "type": "number", "tags": [], "label": "width", @@ -5253,7 +5261,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._resizeCanvas.$2", + "id": "def-common.Map._resizeCanvas.$2", "type": "number", "tags": [], "label": "height", @@ -5267,7 +5275,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._resizeCanvas.$3", + "id": "def-common.Map._resizeCanvas.$3", "type": "number", "tags": [], "label": "pixelRatio", @@ -5284,7 +5292,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._setupPainter", + "id": "def-common.Map._setupPainter", "type": "Function", "tags": [], "label": "_setupPainter", @@ -5299,7 +5307,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._contextLost", + "id": "def-common.Map._contextLost", "type": "Function", "tags": [], "label": "_contextLost", @@ -5312,7 +5320,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._contextLost.$1", + "id": "def-common.Map._contextLost.$1", "type": "Any", "tags": [], "label": "event", @@ -5329,7 +5337,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._contextRestored", + "id": "def-common.Map._contextRestored", "type": "Function", "tags": [], "label": "_contextRestored", @@ -5342,7 +5350,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._contextRestored.$1", + "id": "def-common.Map._contextRestored.$1", "type": "Any", "tags": [], "label": "event", @@ -5359,7 +5367,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._onMapScroll", + "id": "def-common.Map._onMapScroll", "type": "Function", "tags": [], "label": "_onMapScroll", @@ -5372,7 +5380,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._onMapScroll.$1", + "id": "def-common.Map._onMapScroll.$1", "type": "Any", "tags": [], "label": "event", @@ -5389,7 +5397,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.loaded", + "id": "def-common.Map.loaded", "type": "Function", "tags": [], "label": "loaded", @@ -5408,7 +5416,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._update", + "id": "def-common.Map._update", "type": "Function", "tags": [ "private" @@ -5425,7 +5433,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._update.$1", + "id": "def-common.Map._update.$1", "type": "CompoundType", "tags": [], "label": "updateStyle", @@ -5446,7 +5454,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._requestRenderFrame", + "id": "def-common.Map._requestRenderFrame", "type": "Function", "tags": [ "private" @@ -5463,7 +5471,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._requestRenderFrame.$1", + "id": "def-common.Map._requestRenderFrame.$1", "type": "Function", "tags": [], "label": "callback", @@ -5482,7 +5490,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._cancelRenderFrame", + "id": "def-common.Map._cancelRenderFrame", "type": "Function", "tags": [], "label": "_cancelRenderFrame", @@ -5495,7 +5503,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._cancelRenderFrame.$1", + "id": "def-common.Map._cancelRenderFrame.$1", "type": "number", "tags": [], "label": "id", @@ -5512,7 +5520,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._render", + "id": "def-common.Map._render", "type": "Function", "tags": [ "private" @@ -5529,7 +5537,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._render.$1", + "id": "def-common.Map._render.$1", "type": "number", "tags": [], "label": "paintStartTimeStamp", @@ -5550,7 +5558,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.redraw", + "id": "def-common.Map.redraw", "type": "Function", "tags": [], "label": "redraw", @@ -5569,7 +5577,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.remove", + "id": "def-common.Map.remove", "type": "Function", "tags": [], "label": "remove", @@ -5586,7 +5594,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.triggerRepaint", + "id": "def-common.Map.triggerRepaint", "type": "Function", "tags": [ "see", @@ -5606,7 +5614,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._onWindowOnline", + "id": "def-common.Map._onWindowOnline", "type": "Function", "tags": [], "label": "_onWindowOnline", @@ -5621,7 +5629,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._onWindowResize", + "id": "def-common.Map._onWindowResize", "type": "Function", "tags": [], "label": "_onWindowResize", @@ -5634,7 +5642,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._onWindowResize.$1", + "id": "def-common.Map._onWindowResize.$1", "type": "Object", "tags": [], "label": "event", @@ -5651,7 +5659,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.showTileBoundaries", + "id": "def-common.Map.showTileBoundaries", "type": "boolean", "tags": [ "name", @@ -5668,7 +5676,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.showTileBoundaries", + "id": "def-common.Map.showTileBoundaries", "type": "boolean", "tags": [], "label": "showTileBoundaries", @@ -5678,7 +5686,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.showPadding", + "id": "def-common.Map.showPadding", "type": "boolean", "tags": [ "name", @@ -5695,7 +5703,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.showPadding", + "id": "def-common.Map.showPadding", "type": "boolean", "tags": [], "label": "showPadding", @@ -5705,7 +5713,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.showCollisionBoxes", + "id": "def-common.Map.showCollisionBoxes", "type": "boolean", "tags": [ "name", @@ -5722,7 +5730,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.showCollisionBoxes", + "id": "def-common.Map.showCollisionBoxes", "type": "boolean", "tags": [], "label": "showCollisionBoxes", @@ -5732,7 +5740,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.showOverdrawInspector", + "id": "def-common.Map.showOverdrawInspector", "type": "boolean", "tags": [], "label": "showOverdrawInspector", @@ -5742,7 +5750,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.showOverdrawInspector", + "id": "def-common.Map.showOverdrawInspector", "type": "boolean", "tags": [], "label": "showOverdrawInspector", @@ -5752,7 +5760,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.repaint", + "id": "def-common.Map.repaint", "type": "boolean", "tags": [ "name", @@ -5769,7 +5777,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.repaint", + "id": "def-common.Map.repaint", "type": "boolean", "tags": [], "label": "repaint", @@ -5779,7 +5787,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.vertices", + "id": "def-common.Map.vertices", "type": "boolean", "tags": [], "label": "vertices", @@ -5789,7 +5797,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map.vertices", + "id": "def-common.Map.vertices", "type": "boolean", "tags": [], "label": "vertices", @@ -5799,7 +5807,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._setCacheLimits", + "id": "def-common.Map._setCacheLimits", "type": "Function", "tags": [], "label": "_setCacheLimits", @@ -5812,7 +5820,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._setCacheLimits.$1", + "id": "def-common.Map._setCacheLimits.$1", "type": "number", "tags": [], "label": "limit", @@ -5826,7 +5834,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Map._setCacheLimits.$2", + "id": "def-common.Map._setCacheLimits.$2", "type": "number", "tags": [], "label": "checkThreshold", @@ -5846,7 +5854,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent", + "id": "def-common.MapMouseEvent", "type": "Class", "tags": [], "label": "MapMouseEvent", @@ -5859,7 +5867,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.type", + "id": "def-common.MapMouseEvent.type", "type": "CompoundType", "tags": [], "label": "type", @@ -5874,7 +5882,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.target", + "id": "def-common.MapMouseEvent.target", "type": "Object", "tags": [], "label": "target", @@ -5889,7 +5897,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.originalEvent", + "id": "def-common.MapMouseEvent.originalEvent", "type": "Object", "tags": [], "label": "originalEvent", @@ -5904,7 +5912,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.point", + "id": "def-common.MapMouseEvent.point", "type": "Object", "tags": [], "label": "point", @@ -5919,7 +5927,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.lngLat", + "id": "def-common.MapMouseEvent.lngLat", "type": "Object", "tags": [], "label": "lngLat", @@ -5934,7 +5942,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.preventDefault", + "id": "def-common.MapMouseEvent.preventDefault", "type": "Function", "tags": [], "label": "preventDefault", @@ -5951,7 +5959,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.defaultPrevented", + "id": "def-common.MapMouseEvent.defaultPrevented", "type": "boolean", "tags": [ "private" @@ -5965,7 +5973,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent._defaultPrevented", + "id": "def-common.MapMouseEvent._defaultPrevented", "type": "boolean", "tags": [], "label": "_defaultPrevented", @@ -5975,7 +5983,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.Unnamed", + "id": "def-common.MapMouseEvent.Unnamed", "type": "Function", "tags": [ "private" @@ -5990,7 +5998,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.Unnamed.$1", + "id": "def-common.MapMouseEvent.Unnamed.$1", "type": "string", "tags": [], "label": "type", @@ -6004,7 +6012,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.Unnamed.$2", + "id": "def-common.MapMouseEvent.Unnamed.$2", "type": "Object", "tags": [], "label": "map", @@ -6018,7 +6026,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.Unnamed.$3", + "id": "def-common.MapMouseEvent.Unnamed.$3", "type": "Object", "tags": [], "label": "originalEvent", @@ -6032,7 +6040,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapMouseEvent.Unnamed.$4", + "id": "def-common.MapMouseEvent.Unnamed.$4", "type": "Any", "tags": [], "label": "data", @@ -6052,7 +6060,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource", + "id": "def-common.VectorTileSource", "type": "Class", "tags": [], "label": "VectorTileSource", @@ -6065,7 +6073,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.type", + "id": "def-common.VectorTileSource.type", "type": "string", "tags": [], "label": "type", @@ -6078,7 +6086,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.id", + "id": "def-common.VectorTileSource.id", "type": "string", "tags": [], "label": "id", @@ -6088,7 +6096,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.minzoom", + "id": "def-common.VectorTileSource.minzoom", "type": "number", "tags": [], "label": "minzoom", @@ -6098,7 +6106,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.maxzoom", + "id": "def-common.VectorTileSource.maxzoom", "type": "number", "tags": [], "label": "maxzoom", @@ -6108,7 +6116,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.url", + "id": "def-common.VectorTileSource.url", "type": "string", "tags": [], "label": "url", @@ -6118,7 +6126,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.scheme", + "id": "def-common.VectorTileSource.scheme", "type": "string", "tags": [], "label": "scheme", @@ -6128,7 +6136,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.tileSize", + "id": "def-common.VectorTileSource.tileSize", "type": "number", "tags": [], "label": "tileSize", @@ -6138,7 +6146,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.promoteId", + "id": "def-common.VectorTileSource.promoteId", "type": "CompoundType", "tags": [], "label": "promoteId", @@ -6151,7 +6159,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource._options", + "id": "def-common.VectorTileSource._options", "type": "Object", "tags": [], "label": "_options", @@ -6164,7 +6172,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource._collectResourceTiming", + "id": "def-common.VectorTileSource._collectResourceTiming", "type": "boolean", "tags": [], "label": "_collectResourceTiming", @@ -6174,7 +6182,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.dispatcher", + "id": "def-common.VectorTileSource.dispatcher", "type": "Object", "tags": [], "label": "dispatcher", @@ -6187,7 +6195,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.map", + "id": "def-common.VectorTileSource.map", "type": "Object", "tags": [], "label": "map", @@ -6200,7 +6208,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.bounds", + "id": "def-common.VectorTileSource.bounds", "type": "Object", "tags": [], "label": "bounds", @@ -6213,7 +6221,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.tiles", + "id": "def-common.VectorTileSource.tiles", "type": "Array", "tags": [], "label": "tiles", @@ -6226,7 +6234,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.tileBounds", + "id": "def-common.VectorTileSource.tileBounds", "type": "Object", "tags": [], "label": "tileBounds", @@ -6239,7 +6247,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.reparseOverscaled", + "id": "def-common.VectorTileSource.reparseOverscaled", "type": "boolean", "tags": [], "label": "reparseOverscaled", @@ -6249,7 +6257,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.isTileClipped", + "id": "def-common.VectorTileSource.isTileClipped", "type": "boolean", "tags": [], "label": "isTileClipped", @@ -6259,7 +6267,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource._tileJSONRequest", + "id": "def-common.VectorTileSource._tileJSONRequest", "type": "Object", "tags": [], "label": "_tileJSONRequest", @@ -6272,7 +6280,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource._loaded", + "id": "def-common.VectorTileSource._loaded", "type": "boolean", "tags": [], "label": "_loaded", @@ -6282,7 +6290,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.Unnamed", + "id": "def-common.VectorTileSource.Unnamed", "type": "Function", "tags": [], "label": "Constructor", @@ -6295,7 +6303,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.Unnamed.$1", + "id": "def-common.VectorTileSource.Unnamed.$1", "type": "string", "tags": [], "label": "id", @@ -6309,7 +6317,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.Unnamed.$2", + "id": "def-common.VectorTileSource.Unnamed.$2", "type": "CompoundType", "tags": [], "label": "options", @@ -6323,7 +6331,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.Unnamed.$3", + "id": "def-common.VectorTileSource.Unnamed.$3", "type": "Object", "tags": [], "label": "dispatcher", @@ -6337,7 +6345,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.Unnamed.$4", + "id": "def-common.VectorTileSource.Unnamed.$4", "type": "Object", "tags": [], "label": "eventedParent", @@ -6354,7 +6362,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.load", + "id": "def-common.VectorTileSource.load", "type": "Function", "tags": [], "label": "load", @@ -6369,7 +6377,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.loaded", + "id": "def-common.VectorTileSource.loaded", "type": "Function", "tags": [], "label": "loaded", @@ -6384,7 +6392,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.hasTile", + "id": "def-common.VectorTileSource.hasTile", "type": "Function", "tags": [], "label": "hasTile", @@ -6397,7 +6405,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.hasTile.$1", + "id": "def-common.VectorTileSource.hasTile.$1", "type": "Object", "tags": [], "label": "tileID", @@ -6414,7 +6422,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.onAdd", + "id": "def-common.VectorTileSource.onAdd", "type": "Function", "tags": [], "label": "onAdd", @@ -6427,7 +6435,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.onAdd.$1", + "id": "def-common.VectorTileSource.onAdd.$1", "type": "Object", "tags": [], "label": "map", @@ -6444,7 +6452,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.setSourceProperty", + "id": "def-common.VectorTileSource.setSourceProperty", "type": "Function", "tags": [], "label": "setSourceProperty", @@ -6457,7 +6465,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.setSourceProperty.$1", + "id": "def-common.VectorTileSource.setSourceProperty.$1", "type": "Object", "tags": [], "label": "callback", @@ -6474,7 +6482,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.setTiles", + "id": "def-common.VectorTileSource.setTiles", "type": "Function", "tags": [], "label": "setTiles", @@ -6489,7 +6497,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.setTiles.$1", + "id": "def-common.VectorTileSource.setTiles.$1", "type": "Array", "tags": [], "label": "tiles", @@ -6510,7 +6518,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.setUrl", + "id": "def-common.VectorTileSource.setUrl", "type": "Function", "tags": [], "label": "setUrl", @@ -6525,7 +6533,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.setUrl.$1", + "id": "def-common.VectorTileSource.setUrl.$1", "type": "string", "tags": [], "label": "url", @@ -6546,7 +6554,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.onRemove", + "id": "def-common.VectorTileSource.onRemove", "type": "Function", "tags": [], "label": "onRemove", @@ -6561,7 +6569,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.serialize", + "id": "def-common.VectorTileSource.serialize", "type": "Function", "tags": [], "label": "serialize", @@ -6576,7 +6584,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.loadTile", + "id": "def-common.VectorTileSource.loadTile", "type": "Function", "tags": [], "label": "loadTile", @@ -6589,7 +6597,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.loadTile.$1", + "id": "def-common.VectorTileSource.loadTile.$1", "type": "Object", "tags": [], "label": "tile", @@ -6603,7 +6611,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.loadTile.$2", + "id": "def-common.VectorTileSource.loadTile.$2", "type": "Function", "tags": [], "label": "callback", @@ -6620,7 +6628,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.abortTile", + "id": "def-common.VectorTileSource.abortTile", "type": "Function", "tags": [], "label": "abortTile", @@ -6633,7 +6641,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.abortTile.$1", + "id": "def-common.VectorTileSource.abortTile.$1", "type": "Object", "tags": [], "label": "tile", @@ -6650,7 +6658,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.unloadTile", + "id": "def-common.VectorTileSource.unloadTile", "type": "Function", "tags": [], "label": "unloadTile", @@ -6663,7 +6671,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.unloadTile.$1", + "id": "def-common.VectorTileSource.unloadTile.$1", "type": "Object", "tags": [], "label": "tile", @@ -6680,7 +6688,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.VectorTileSource.hasTransition", + "id": "def-common.VectorTileSource.hasTransition", "type": "Function", "tags": [], "label": "hasTransition", @@ -6701,7 +6709,7 @@ "interfaces": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface", + "id": "def-common.CustomLayerInterface", "type": "Interface", "tags": [ "interface" @@ -6718,7 +6726,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.id", + "id": "def-common.CustomLayerInterface.id", "type": "string", "tags": [ "property" @@ -6730,7 +6738,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.type", + "id": "def-common.CustomLayerInterface.type", "type": "string", "tags": [ "property" @@ -6745,7 +6753,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.renderingMode", + "id": "def-common.CustomLayerInterface.renderingMode", "type": "CompoundType", "tags": [ "property" @@ -6760,7 +6768,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.render", + "id": "def-common.CustomLayerInterface.render", "type": "Function", "tags": [ "function", @@ -6783,7 +6791,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.render.$1", + "id": "def-common.CustomLayerInterface.render.$1", "type": "Object", "tags": [], "label": "gl", @@ -6798,7 +6806,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.render.$2", + "id": "def-common.CustomLayerInterface.render.$2", "type": "CompoundType", "tags": [], "label": "matrix", @@ -6815,7 +6823,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.prerender", + "id": "def-common.CustomLayerInterface.prerender", "type": "Function", "tags": [ "function", @@ -6835,7 +6843,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.onAdd", + "id": "def-common.CustomLayerInterface.onAdd", "type": "Function", "tags": [ "function", @@ -6855,7 +6863,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.onAdd.$1", + "id": "def-common.CustomLayerInterface.onAdd.$1", "type": "Object", "tags": [], "label": "map", @@ -6871,7 +6879,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.onAdd.$2", + "id": "def-common.CustomLayerInterface.onAdd.$2", "type": "Object", "tags": [], "label": "gl", @@ -6890,7 +6898,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.onRemove", + "id": "def-common.CustomLayerInterface.onRemove", "type": "Function", "tags": [ "function", @@ -6910,7 +6918,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.onRemove.$1", + "id": "def-common.CustomLayerInterface.onRemove.$1", "type": "Object", "tags": [], "label": "map", @@ -6926,7 +6934,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.CustomLayerInterface.onRemove.$2", + "id": "def-common.CustomLayerInterface.onRemove.$2", "type": "Object", "tags": [], "label": "gl", @@ -6948,7 +6956,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapSourceDataEvent", + "id": "def-common.MapSourceDataEvent", "type": "Interface", "tags": [], "label": "MapSourceDataEvent", @@ -6961,7 +6969,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapSourceDataEvent.dataType", + "id": "def-common.MapSourceDataEvent.dataType", "type": "string", "tags": [], "label": "dataType", @@ -6974,7 +6982,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapSourceDataEvent.isSourceLoaded", + "id": "def-common.MapSourceDataEvent.isSourceLoaded", "type": "boolean", "tags": [], "label": "isSourceLoaded", @@ -6984,7 +6992,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapSourceDataEvent.source", + "id": "def-common.MapSourceDataEvent.source", "type": "CompoundType", "tags": [], "label": "source", @@ -6997,7 +7005,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapSourceDataEvent.sourceId", + "id": "def-common.MapSourceDataEvent.sourceId", "type": "string", "tags": [], "label": "sourceId", @@ -7007,7 +7015,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapSourceDataEvent.sourceDataType", + "id": "def-common.MapSourceDataEvent.sourceDataType", "type": "CompoundType", "tags": [], "label": "sourceDataType", @@ -7020,7 +7028,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapSourceDataEvent.tile", + "id": "def-common.MapSourceDataEvent.tile", "type": "Any", "tags": [], "label": "tile", @@ -7036,7 +7044,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source", + "id": "def-common.Source", "type": "Interface", "tags": [ "private", @@ -7060,7 +7068,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.type", + "id": "def-common.Source.type", "type": "string", "tags": [], "label": "type", @@ -7070,7 +7078,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.id", + "id": "def-common.Source.id", "type": "string", "tags": [], "label": "id", @@ -7080,7 +7088,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.minzoom", + "id": "def-common.Source.minzoom", "type": "number", "tags": [], "label": "minzoom", @@ -7090,7 +7098,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.maxzoom", + "id": "def-common.Source.maxzoom", "type": "number", "tags": [], "label": "maxzoom", @@ -7100,7 +7108,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.tileSize", + "id": "def-common.Source.tileSize", "type": "number", "tags": [], "label": "tileSize", @@ -7110,7 +7118,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.attribution", + "id": "def-common.Source.attribution", "type": "string", "tags": [], "label": "attribution", @@ -7123,7 +7131,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.roundZoom", + "id": "def-common.Source.roundZoom", "type": "CompoundType", "tags": [], "label": "roundZoom", @@ -7136,7 +7144,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.isTileClipped", + "id": "def-common.Source.isTileClipped", "type": "CompoundType", "tags": [], "label": "isTileClipped", @@ -7149,7 +7157,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.tileID", + "id": "def-common.Source.tileID", "type": "Object", "tags": [], "label": "tileID", @@ -7162,7 +7170,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.reparseOverscaled", + "id": "def-common.Source.reparseOverscaled", "type": "CompoundType", "tags": [], "label": "reparseOverscaled", @@ -7175,7 +7183,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.vectorLayerIds", + "id": "def-common.Source.vectorLayerIds", "type": "Array", "tags": [], "label": "vectorLayerIds", @@ -7188,7 +7196,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.hasTransition", + "id": "def-common.Source.hasTransition", "type": "Function", "tags": [], "label": "hasTransition", @@ -7203,7 +7211,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.loaded", + "id": "def-common.Source.loaded", "type": "Function", "tags": [], "label": "loaded", @@ -7218,7 +7226,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.fire", + "id": "def-common.Source.fire", "type": "Function", "tags": [], "label": "fire", @@ -7231,7 +7239,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.fire.$1", + "id": "def-common.Source.fire.$1", "type": "Object", "tags": [], "label": "event", @@ -7248,7 +7256,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.onAdd", + "id": "def-common.Source.onAdd", "type": "Function", "tags": [], "label": "onAdd", @@ -7261,7 +7269,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.onAdd.$1", + "id": "def-common.Source.onAdd.$1", "type": "Object", "tags": [], "label": "map", @@ -7278,7 +7286,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.onRemove", + "id": "def-common.Source.onRemove", "type": "Function", "tags": [], "label": "onRemove", @@ -7291,7 +7299,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.onRemove.$1", + "id": "def-common.Source.onRemove.$1", "type": "Object", "tags": [], "label": "map", @@ -7308,7 +7316,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.loadTile", + "id": "def-common.Source.loadTile", "type": "Function", "tags": [], "label": "loadTile", @@ -7321,7 +7329,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.loadTile.$1", + "id": "def-common.Source.loadTile.$1", "type": "Object", "tags": [], "label": "tile", @@ -7335,7 +7343,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.loadTile.$2", + "id": "def-common.Source.loadTile.$2", "type": "Function", "tags": [], "label": "callback", @@ -7352,7 +7360,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.hasTile", + "id": "def-common.Source.hasTile", "type": "Function", "tags": [], "label": "hasTile", @@ -7365,7 +7373,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.hasTile.$1", + "id": "def-common.Source.hasTile.$1", "type": "Object", "tags": [], "label": "tileID", @@ -7382,7 +7390,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.abortTile", + "id": "def-common.Source.abortTile", "type": "Function", "tags": [], "label": "abortTile", @@ -7395,7 +7403,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.abortTile.$1", + "id": "def-common.Source.abortTile.$1", "type": "Object", "tags": [], "label": "tile", @@ -7409,7 +7417,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.abortTile.$2", + "id": "def-common.Source.abortTile.$2", "type": "Function", "tags": [], "label": "callback", @@ -7426,7 +7434,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.unloadTile", + "id": "def-common.Source.unloadTile", "type": "Function", "tags": [], "label": "unloadTile", @@ -7439,7 +7447,7 @@ "children": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.unloadTile.$1", + "id": "def-common.Source.unloadTile.$1", "type": "Object", "tags": [], "label": "tile", @@ -7453,7 +7461,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.unloadTile.$2", + "id": "def-common.Source.unloadTile.$2", "type": "Function", "tags": [], "label": "callback", @@ -7470,7 +7478,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.serialize", + "id": "def-common.Source.serialize", "type": "Function", "tags": [ "private" @@ -7489,7 +7497,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Source.prepare", + "id": "def-common.Source.prepare", "type": "Function", "tags": [], "label": "prepare", @@ -7510,7 +7518,7 @@ "misc": [ { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.FeatureIdentifier", + "id": "def-common.FeatureIdentifier", "type": "Type", "tags": [], "label": "FeatureIdentifier", @@ -7524,7 +7532,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.FilterSpecification", + "id": "def-common.FilterSpecification", "type": "Type", "tags": [], "label": "FilterSpecification", @@ -7538,7 +7546,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.LayerSpecification", + "id": "def-common.LayerSpecification", "type": "Type", "tags": [], "label": "LayerSpecification", @@ -7552,13 +7560,13 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapEvent", + "id": "def-common.MapEvent", "type": "Type", "tags": [], "label": "MapEvent", "description": [], "signature": [ - "\"remove\" | \"error\" | \"data\" | \"render\" | \"move\" | \"rotate\" | \"idle\" | \"resize\" | \"zoom\" | \"mousedown\" | \"mouseup\" | \"mouseover\" | \"mousemove\" | \"click\" | \"dblclick\" | \"mouseenter\" | \"mouseleave\" | \"mouseout\" | \"contextmenu\" | \"wheel\" | \"touchstart\" | \"touchend\" | \"touchmove\" | \"touchcancel\" | \"movestart\" | \"moveend\" | \"dragstart\" | \"drag\" | \"dragend\" | \"zoomstart\" | \"zoomend\" | \"rotatestart\" | \"rotateend\" | \"pitchstart\" | \"pitch\" | \"pitchend\" | \"boxzoomstart\" | \"boxzoomend\" | \"boxzoomcancel\" | \"webglcontextlost\" | \"webglcontextrestored\" | \"load\" | \"styledata\" | \"sourcedata\" | \"dataloading\" | \"styledataloading\" | \"sourcedataloading\" | \"styleimagemissing\" | \"style.load\" | \"dataabort\" | \"sourcedataabort\"" + "\"error\" | \"data\" | \"render\" | \"remove\" | \"move\" | \"rotate\" | \"idle\" | \"resize\" | \"zoom\" | \"mousedown\" | \"mouseup\" | \"mouseover\" | \"mousemove\" | \"click\" | \"dblclick\" | \"mouseenter\" | \"mouseleave\" | \"mouseout\" | \"contextmenu\" | \"wheel\" | \"touchstart\" | \"touchend\" | \"touchmove\" | \"touchcancel\" | \"movestart\" | \"moveend\" | \"dragstart\" | \"drag\" | \"dragend\" | \"zoomstart\" | \"zoomend\" | \"rotatestart\" | \"rotateend\" | \"pitchstart\" | \"pitch\" | \"pitchend\" | \"boxzoomstart\" | \"boxzoomend\" | \"boxzoomcancel\" | \"webglcontextlost\" | \"webglcontextrestored\" | \"load\" | \"styledata\" | \"sourcedata\" | \"dataloading\" | \"styledataloading\" | \"sourcedataloading\" | \"styleimagemissing\" | \"style.load\" | \"dataabort\" | \"sourcedataabort\"" ], "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", "deprecated": false, @@ -7566,7 +7574,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapGeoJSONFeature", + "id": "def-common.MapGeoJSONFeature", "type": "Type", "tags": [], "label": "MapGeoJSONFeature", @@ -7580,7 +7588,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.maplibregl", + "id": "def-common.maplibregl", "type": "Any", "tags": [], "label": "maplibregl", @@ -7594,7 +7602,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.MapOptions", + "id": "def-common.MapOptions", "type": "Type", "tags": [], "label": "MapOptions", @@ -7608,7 +7616,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.Point2D", + "id": "def-common.Point2D", "type": "Type", "tags": [], "label": "Point2D", @@ -7622,7 +7630,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.PointLike", + "id": "def-common.PointLike", "type": "Type", "tags": [ "typedef" @@ -7641,7 +7649,7 @@ }, { "parentPluginId": "@kbn/mapbox-gl", - "id": "def-server.StyleSpecification", + "id": "def-common.StyleSpecification", "type": "Type", "tags": [], "label": "StyleSpecification", @@ -7655,13 +7663,5 @@ } ], "objects": [] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] } } \ No newline at end of file diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index 98e67f9b8208e..c45a65ac0f552 100644 --- a/api_docs/kbn_mapbox_gl.mdx +++ b/api_docs/kbn_mapbox_gl.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-mapbox-gl title: "@kbn/mapbox-gl" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/mapbox-gl plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -20,14 +20,14 @@ Contact [Owner missing] for questions regarding this plugin. |-------------------|-----------|------------------------|-----------------| | 494 | 1 | 1 | 0 | -## Server +## Common ### Classes - + ### Interfaces - + ### Consts, variables and types - + diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index e0dbc611af5a0..2e4a085565f10 100644 --- a/api_docs/kbn_monaco.mdx +++ b/api_docs/kbn_monaco.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-monaco title: "@kbn/monaco" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/monaco plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/monaco'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_optimizer.devdocs.json b/api_docs/kbn_optimizer.devdocs.json index 8914274c1f903..bd22eca63f168 100644 --- a/api_docs/kbn_optimizer.devdocs.json +++ b/api_docs/kbn_optimizer.devdocs.json @@ -568,7 +568,41 @@ "signature": [ "() => Promise" ], - "path": "packages/kbn-optimizer/src/babel_runtime_helpers/find_babel_runtime_helpers_in_entry_bundles.ts", + "path": "packages/kbn-optimizer/src/audit_bundle_dependencies/find_babel_runtime_helpers_in_entry_bundles.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/optimizer", + "id": "def-server.runFindNodeLibsBrowserPolyfillsInEntryBundlesCli", + "type": "Function", + "tags": [], + "label": "runFindNodeLibsBrowserPolyfillsInEntryBundlesCli", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "packages/kbn-optimizer/src/audit_bundle_dependencies/find_node_libs_browser_polyfills_in_entry_bundles.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/optimizer", + "id": "def-server.runFindTargetNodeImportsCli", + "type": "Function", + "tags": [], + "label": "runFindTargetNodeImportsCli", + "description": [ + "\nAnalyzes the bundle dependencies to find any imports using the `@kbn//target_node` build target.\n\nWe should aim for those packages to be imported using the `@kbn//target_web` build because it's optimized\nfor browser compatibility.\n\nThis utility also helps identify when code that should only run in the server is leaked into the browser." + ], + "signature": [ + "() => Promise" + ], + "path": "packages/kbn-optimizer/src/audit_bundle_dependencies/find_target_node_imports.ts", "deprecated": false, "children": [], "returnComment": [], diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index 589a60a957724..a36790bde6bfa 100644 --- a/api_docs/kbn_optimizer.mdx +++ b/api_docs/kbn_optimizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer title: "@kbn/optimizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/optimizer plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 45 | 0 | 45 | 10 | +| 47 | 0 | 46 | 10 | ## Server diff --git a/api_docs/kbn_performance_testing_dataset_extractor.devdocs.json b/api_docs/kbn_performance_testing_dataset_extractor.devdocs.json new file mode 100644 index 0000000000000..bf86f26e325e7 --- /dev/null +++ b/api_docs/kbn_performance_testing_dataset_extractor.devdocs.json @@ -0,0 +1,75 @@ +{ + "id": "@kbn/performance-testing-dataset-extractor", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/performance-testing-dataset-extractor", + "id": "def-server.extractor", + "type": "Function", + "tags": [], + "label": "extractor", + "description": [], + "signature": [ + "({ param, client, log }: CLIParams) => Promise" + ], + "path": "packages/kbn-performance-testing-dataset-extractor/src/extractor.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/performance-testing-dataset-extractor", + "id": "def-server.extractor.$1", + "type": "Object", + "tags": [], + "label": "{ param, client, log }", + "description": [], + "signature": [ + "CLIParams" + ], + "path": "packages/kbn-performance-testing-dataset-extractor/src/extractor.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/performance-testing-dataset-extractor", + "id": "def-server.runExtractor", + "type": "Function", + "tags": [], + "label": "runExtractor", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "packages/kbn-performance-testing-dataset-extractor/src/cli.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_performance_testing_dataset_extractor.mdx b/api_docs/kbn_performance_testing_dataset_extractor.mdx new file mode 100644 index 0000000000000..e4b0a6d7f9b02 --- /dev/null +++ b/api_docs/kbn_performance_testing_dataset_extractor.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnPerformanceTestingDatasetExtractorPluginApi +slug: /kibana-dev-docs/api/kbn-performance-testing-dataset-extractor +title: "@kbn/performance-testing-dataset-extractor" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/performance-testing-dataset-extractor plugin +date: 2022-05-24 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/performance-testing-dataset-extractor'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnPerformanceTestingDatasetExtractorObj from './kbn_performance_testing_dataset_extractor.devdocs.json'; + +A library to convert APM traces into JSON format for performance testing. + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 3 | 0 | 3 | 0 | + +## Server + +### Functions + + diff --git a/api_docs/kbn_plugin_discovery.mdx b/api_docs/kbn_plugin_discovery.mdx index 1e30d398d906c..4d8341eee376f 100644 --- a/api_docs/kbn_plugin_discovery.mdx +++ b/api_docs/kbn_plugin_discovery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-discovery title: "@kbn/plugin-discovery" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-discovery plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-discovery'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx index 85a2f9ace93de..9ba1efa764ab2 100644 --- a/api_docs/kbn_plugin_generator.mdx +++ b/api_docs/kbn_plugin_generator.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-generator title: "@kbn/plugin-generator" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-generator plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-generator'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_plugin_helpers.mdx b/api_docs/kbn_plugin_helpers.mdx index abcb0613f1d31..abb341979ec40 100644 --- a/api_docs/kbn_plugin_helpers.mdx +++ b/api_docs/kbn_plugin_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-helpers title: "@kbn/plugin-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-helpers plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_pm.devdocs.json b/api_docs/kbn_pm.devdocs.json index d43dd55273e42..a0db71023b63c 100644 --- a/api_docs/kbn_pm.devdocs.json +++ b/api_docs/kbn_pm.devdocs.json @@ -269,50 +269,6 @@ "path": "packages/kbn-pm/src/utils/project.ts", "deprecated": false }, - { - "parentPluginId": "@kbn/pm", - "id": "def-server.Project.ensureValidProjectDependency", - "type": "Function", - "tags": [], - "label": "ensureValidProjectDependency", - "description": [], - "signature": [ - "(project: ", - { - "pluginId": "@kbn/pm", - "scope": "server", - "docId": "kibKbnPmPluginApi", - "section": "def-server.Project", - "text": "Project" - }, - ") => void" - ], - "path": "packages/kbn-pm/src/utils/project.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/pm", - "id": "def-server.Project.ensureValidProjectDependency.$1", - "type": "Object", - "tags": [], - "label": "project", - "description": [], - "signature": [ - { - "pluginId": "@kbn/pm", - "scope": "server", - "docId": "kibKbnPmPluginApi", - "section": "def-server.Project", - "text": "Project" - } - ], - "path": "packages/kbn-pm/src/utils/project.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, { "parentPluginId": "@kbn/pm", "id": "def-server.Project.getBuildConfig", diff --git a/api_docs/kbn_pm.mdx b/api_docs/kbn_pm.mdx index b720c9ac68580..8412a120ff2a4 100644 --- a/api_docs/kbn_pm.mdx +++ b/api_docs/kbn_pm.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-pm title: "@kbn/pm" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/pm plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/pm'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 47 | 0 | 35 | 5 | +| 45 | 0 | 33 | 5 | ## Server diff --git a/api_docs/kbn_react_field.mdx b/api_docs/kbn_react_field.mdx index 6253496021689..d86226fcee3a6 100644 --- a/api_docs/kbn_react_field.mdx +++ b/api_docs/kbn_react_field.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-react-field title: "@kbn/react-field" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/react-field plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_rule_data_utils.devdocs.json b/api_docs/kbn_rule_data_utils.devdocs.json index 0d1b639b9f508..291375f8827c9 100644 --- a/api_docs/kbn_rule_data_utils.devdocs.json +++ b/api_docs/kbn_rule_data_utils.devdocs.json @@ -9,11 +9,19 @@ "objects": [] }, "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.getEsQueryConfig", + "id": "def-common.getEsQueryConfig", "type": "Function", "tags": [], "label": "getEsQueryConfig", @@ -27,7 +35,7 @@ "children": [ { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.getEsQueryConfig.$1", + "id": "def-common.getEsQueryConfig.$1", "type": "Object", "tags": [], "label": "params", @@ -45,7 +53,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.getSafeSortIds", + "id": "def-common.getSafeSortIds", "type": "Function", "tags": [], "label": "getSafeSortIds", @@ -62,7 +70,7 @@ "children": [ { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.getSafeSortIds.$1", + "id": "def-common.getSafeSortIds.$1", "type": "CompoundType", "tags": [], "label": "sortIds", @@ -85,7 +93,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.isValidFeatureId", + "id": "def-common.isValidFeatureId", "type": "Function", "tags": [], "label": "isValidFeatureId", @@ -94,9 +102,9 @@ "(a: unknown) => a is ", { "pluginId": "@kbn/rule-data-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnRuleDataUtilsPluginApi", - "section": "def-server.AlertConsumers", + "section": "def-common.AlertConsumers", "text": "AlertConsumers" } ], @@ -105,7 +113,7 @@ "children": [ { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.isValidFeatureId.$1", + "id": "def-common.isValidFeatureId.$1", "type": "Unknown", "tags": [], "label": "a", @@ -127,7 +135,7 @@ "misc": [ { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_ACTION_GROUP", + "id": "def-common.ALERT_ACTION_GROUP", "type": "string", "tags": [], "label": "ALERT_ACTION_GROUP", @@ -141,7 +149,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_BUILDING_BLOCK_TYPE", + "id": "def-common.ALERT_BUILDING_BLOCK_TYPE", "type": "string", "tags": [], "label": "ALERT_BUILDING_BLOCK_TYPE", @@ -155,7 +163,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_DURATION", + "id": "def-common.ALERT_DURATION", "type": "string", "tags": [], "label": "ALERT_DURATION", @@ -169,7 +177,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_END", + "id": "def-common.ALERT_END", "type": "string", "tags": [], "label": "ALERT_END", @@ -183,7 +191,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_EVALUATION_THRESHOLD", + "id": "def-common.ALERT_EVALUATION_THRESHOLD", "type": "string", "tags": [], "label": "ALERT_EVALUATION_THRESHOLD", @@ -197,7 +205,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_EVALUATION_VALUE", + "id": "def-common.ALERT_EVALUATION_VALUE", "type": "string", "tags": [], "label": "ALERT_EVALUATION_VALUE", @@ -211,7 +219,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_INSTANCE_ID", + "id": "def-common.ALERT_INSTANCE_ID", "type": "string", "tags": [], "label": "ALERT_INSTANCE_ID", @@ -225,7 +233,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_NAMESPACE", + "id": "def-common.ALERT_NAMESPACE", "type": "string", "tags": [], "label": "ALERT_NAMESPACE", @@ -239,7 +247,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_REASON", + "id": "def-common.ALERT_REASON", "type": "string", "tags": [], "label": "ALERT_REASON", @@ -253,7 +261,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RISK_SCORE", + "id": "def-common.ALERT_RISK_SCORE", "type": "string", "tags": [], "label": "ALERT_RISK_SCORE", @@ -267,7 +275,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_AUTHOR", + "id": "def-common.ALERT_RULE_AUTHOR", "type": "string", "tags": [], "label": "ALERT_RULE_AUTHOR", @@ -281,7 +289,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_CATEGORY", + "id": "def-common.ALERT_RULE_CATEGORY", "type": "string", "tags": [], "label": "ALERT_RULE_CATEGORY", @@ -295,7 +303,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_CONSUMER", + "id": "def-common.ALERT_RULE_CONSUMER", "type": "string", "tags": [], "label": "ALERT_RULE_CONSUMER", @@ -309,7 +317,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_CREATED_AT", + "id": "def-common.ALERT_RULE_CREATED_AT", "type": "string", "tags": [], "label": "ALERT_RULE_CREATED_AT", @@ -323,7 +331,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_CREATED_BY", + "id": "def-common.ALERT_RULE_CREATED_BY", "type": "string", "tags": [], "label": "ALERT_RULE_CREATED_BY", @@ -337,7 +345,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_DESCRIPTION", + "id": "def-common.ALERT_RULE_DESCRIPTION", "type": "string", "tags": [], "label": "ALERT_RULE_DESCRIPTION", @@ -351,7 +359,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_ENABLED", + "id": "def-common.ALERT_RULE_ENABLED", "type": "string", "tags": [], "label": "ALERT_RULE_ENABLED", @@ -365,7 +373,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_EXCEPTIONS_LIST", + "id": "def-common.ALERT_RULE_EXCEPTIONS_LIST", "type": "string", "tags": [], "label": "ALERT_RULE_EXCEPTIONS_LIST", @@ -379,7 +387,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_EXECUTION_UUID", + "id": "def-common.ALERT_RULE_EXECUTION_UUID", "type": "string", "tags": [], "label": "ALERT_RULE_EXECUTION_UUID", @@ -393,7 +401,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_FROM", + "id": "def-common.ALERT_RULE_FROM", "type": "string", "tags": [], "label": "ALERT_RULE_FROM", @@ -407,7 +415,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_INTERVAL", + "id": "def-common.ALERT_RULE_INTERVAL", "type": "string", "tags": [], "label": "ALERT_RULE_INTERVAL", @@ -421,7 +429,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_LICENSE", + "id": "def-common.ALERT_RULE_LICENSE", "type": "string", "tags": [], "label": "ALERT_RULE_LICENSE", @@ -435,7 +443,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_NAME", + "id": "def-common.ALERT_RULE_NAME", "type": "string", "tags": [], "label": "ALERT_RULE_NAME", @@ -449,7 +457,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_NAMESPACE", + "id": "def-common.ALERT_RULE_NAMESPACE", "type": "string", "tags": [], "label": "ALERT_RULE_NAMESPACE", @@ -463,7 +471,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_NAMESPACE_FIELD", + "id": "def-common.ALERT_RULE_NAMESPACE_FIELD", "type": "string", "tags": [], "label": "ALERT_RULE_NAMESPACE_FIELD", @@ -477,7 +485,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_NOTE", + "id": "def-common.ALERT_RULE_NOTE", "type": "string", "tags": [], "label": "ALERT_RULE_NOTE", @@ -491,7 +499,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_PARAMETERS", + "id": "def-common.ALERT_RULE_PARAMETERS", "type": "string", "tags": [], "label": "ALERT_RULE_PARAMETERS", @@ -505,7 +513,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_PRODUCER", + "id": "def-common.ALERT_RULE_PRODUCER", "type": "string", "tags": [], "label": "ALERT_RULE_PRODUCER", @@ -519,7 +527,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_REFERENCES", + "id": "def-common.ALERT_RULE_REFERENCES", "type": "string", "tags": [], "label": "ALERT_RULE_REFERENCES", @@ -533,7 +541,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_RULE_ID", + "id": "def-common.ALERT_RULE_RULE_ID", "type": "string", "tags": [], "label": "ALERT_RULE_RULE_ID", @@ -547,7 +555,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_RULE_NAME_OVERRIDE", + "id": "def-common.ALERT_RULE_RULE_NAME_OVERRIDE", "type": "string", "tags": [], "label": "ALERT_RULE_RULE_NAME_OVERRIDE", @@ -561,7 +569,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_TAGS", + "id": "def-common.ALERT_RULE_TAGS", "type": "string", "tags": [], "label": "ALERT_RULE_TAGS", @@ -575,7 +583,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_TO", + "id": "def-common.ALERT_RULE_TO", "type": "string", "tags": [], "label": "ALERT_RULE_TO", @@ -589,7 +597,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_TYPE", + "id": "def-common.ALERT_RULE_TYPE", "type": "string", "tags": [], "label": "ALERT_RULE_TYPE", @@ -603,7 +611,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_TYPE_ID", + "id": "def-common.ALERT_RULE_TYPE_ID", "type": "string", "tags": [], "label": "ALERT_RULE_TYPE_ID", @@ -617,7 +625,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_UPDATED_AT", + "id": "def-common.ALERT_RULE_UPDATED_AT", "type": "string", "tags": [], "label": "ALERT_RULE_UPDATED_AT", @@ -631,7 +639,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_UPDATED_BY", + "id": "def-common.ALERT_RULE_UPDATED_BY", "type": "string", "tags": [], "label": "ALERT_RULE_UPDATED_BY", @@ -645,7 +653,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_UUID", + "id": "def-common.ALERT_RULE_UUID", "type": "string", "tags": [], "label": "ALERT_RULE_UUID", @@ -659,7 +667,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_RULE_VERSION", + "id": "def-common.ALERT_RULE_VERSION", "type": "string", "tags": [], "label": "ALERT_RULE_VERSION", @@ -673,7 +681,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_SEVERITY", + "id": "def-common.ALERT_SEVERITY", "type": "string", "tags": [], "label": "ALERT_SEVERITY", @@ -687,7 +695,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_SEVERITY_CRITICAL", + "id": "def-common.ALERT_SEVERITY_CRITICAL", "type": "string", "tags": [], "label": "ALERT_SEVERITY_CRITICAL", @@ -701,7 +709,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_SEVERITY_WARNING", + "id": "def-common.ALERT_SEVERITY_WARNING", "type": "string", "tags": [], "label": "ALERT_SEVERITY_WARNING", @@ -715,7 +723,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_START", + "id": "def-common.ALERT_START", "type": "string", "tags": [], "label": "ALERT_START", @@ -729,7 +737,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_STATUS", + "id": "def-common.ALERT_STATUS", "type": "string", "tags": [], "label": "ALERT_STATUS", @@ -743,7 +751,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_STATUS_ACTIVE", + "id": "def-common.ALERT_STATUS_ACTIVE", "type": "string", "tags": [], "label": "ALERT_STATUS_ACTIVE", @@ -757,7 +765,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_STATUS_RECOVERED", + "id": "def-common.ALERT_STATUS_RECOVERED", "type": "string", "tags": [], "label": "ALERT_STATUS_RECOVERED", @@ -771,7 +779,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_SYSTEM_STATUS", + "id": "def-common.ALERT_SYSTEM_STATUS", "type": "string", "tags": [], "label": "ALERT_SYSTEM_STATUS", @@ -785,7 +793,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_UUID", + "id": "def-common.ALERT_UUID", "type": "string", "tags": [], "label": "ALERT_UUID", @@ -799,7 +807,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_WORKFLOW_REASON", + "id": "def-common.ALERT_WORKFLOW_REASON", "type": "string", "tags": [], "label": "ALERT_WORKFLOW_REASON", @@ -813,7 +821,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_WORKFLOW_STATUS", + "id": "def-common.ALERT_WORKFLOW_STATUS", "type": "string", "tags": [], "label": "ALERT_WORKFLOW_STATUS", @@ -827,7 +835,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ALERT_WORKFLOW_USER", + "id": "def-common.ALERT_WORKFLOW_USER", "type": "string", "tags": [], "label": "ALERT_WORKFLOW_USER", @@ -841,7 +849,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.AlertConsumers", + "id": "def-common.AlertConsumers", "type": "Type", "tags": [], "label": "AlertConsumers", @@ -855,7 +863,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.AlertSeverity", + "id": "def-common.AlertSeverity", "type": "Type", "tags": [], "label": "AlertSeverity", @@ -869,7 +877,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.AlertStatus", + "id": "def-common.AlertStatus", "type": "Type", "tags": [], "label": "AlertStatus", @@ -883,7 +891,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ECS_VERSION", + "id": "def-common.ECS_VERSION", "type": "string", "tags": [], "label": "ECS_VERSION", @@ -897,7 +905,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.EVENT_ACTION", + "id": "def-common.EVENT_ACTION", "type": "string", "tags": [], "label": "EVENT_ACTION", @@ -911,7 +919,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.EVENT_KIND", + "id": "def-common.EVENT_KIND", "type": "string", "tags": [], "label": "EVENT_KIND", @@ -925,7 +933,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.EVENT_MODULE", + "id": "def-common.EVENT_MODULE", "type": "string", "tags": [], "label": "EVENT_MODULE", @@ -939,7 +947,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.KIBANA_NAMESPACE", + "id": "def-common.KIBANA_NAMESPACE", "type": "string", "tags": [], "label": "KIBANA_NAMESPACE", @@ -953,7 +961,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.SPACE_IDS", + "id": "def-common.SPACE_IDS", "type": "string", "tags": [], "label": "SPACE_IDS", @@ -967,7 +975,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.STATUS_VALUES", + "id": "def-common.STATUS_VALUES", "type": "Type", "tags": [], "label": "STATUS_VALUES", @@ -981,7 +989,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.TAGS", + "id": "def-common.TAGS", "type": "string", "tags": [], "label": "TAGS", @@ -995,7 +1003,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.TechnicalRuleDataFieldName", + "id": "def-common.TechnicalRuleDataFieldName", "type": "Type", "tags": [], "label": "TechnicalRuleDataFieldName", @@ -1009,7 +1017,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.TIMESTAMP", + "id": "def-common.TIMESTAMP", "type": "string", "tags": [], "label": "TIMESTAMP", @@ -1023,7 +1031,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.ValidFeatureId", + "id": "def-common.ValidFeatureId", "type": "Type", "tags": [], "label": "ValidFeatureId", @@ -1037,7 +1045,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.validFeatureIds", + "id": "def-common.validFeatureIds", "type": "Array", "tags": [], "label": "validFeatureIds", @@ -1051,7 +1059,7 @@ }, { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.VERSION", + "id": "def-common.VERSION", "type": "string", "tags": [], "label": "VERSION", @@ -1067,7 +1075,7 @@ "objects": [ { "parentPluginId": "@kbn/rule-data-utils", - "id": "def-server.AlertConsumers", + "id": "def-common.AlertConsumers", "type": "Object", "tags": [], "label": "AlertConsumers", @@ -1082,13 +1090,5 @@ "initialIsOpen": false } ] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] } } \ No newline at end of file diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index 94645ec075d4d..bf19fdfc35d36 100644 --- a/api_docs/kbn_rule_data_utils.mdx +++ b/api_docs/kbn_rule_data_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-rule-data-utils title: "@kbn/rule-data-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/rule-data-utils plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rule-data-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -20,14 +20,14 @@ Contact [Owner missing] for questions regarding this plugin. |-------------------|-----------|------------------------|-----------------| | 74 | 0 | 71 | 0 | -## Server +## Common ### Objects - + ### Functions - + ### Consts, variables and types - + diff --git a/api_docs/kbn_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx index e007783b67ee3..6c4077ccf27f3 100644 --- a/api_docs/kbn_securitysolution_autocomplete.mdx +++ b/api_docs/kbn_securitysolution_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-autocomplete title: "@kbn/securitysolution-autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-autocomplete plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-autocomplete'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_es_utils.mdx b/api_docs/kbn_securitysolution_es_utils.mdx index 4662dfc9e1a4e..0c78f787e3a90 100644 --- a/api_docs/kbn_securitysolution_es_utils.mdx +++ b/api_docs/kbn_securitysolution_es_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-es-utils title: "@kbn/securitysolution-es-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-es-utils plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-es-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_hook_utils.devdocs.json b/api_docs/kbn_securitysolution_hook_utils.devdocs.json index 08146af045fab..895107bcb707f 100644 --- a/api_docs/kbn_securitysolution_hook_utils.devdocs.json +++ b/api_docs/kbn_securitysolution_hook_utils.devdocs.json @@ -274,6 +274,20 @@ ], "enums": [], "misc": [ + { + "parentPluginId": "@kbn/securitysolution-hook-utils", + "id": "def-common.Action", + "type": "Type", + "tags": [], + "label": "Action", + "description": [], + "signature": [ + "{ type: \"setResult\"; result: T; } | { type: \"setError\"; error: unknown; } | { type: \"load\"; }" + ], + "path": "packages/kbn-securitysolution-hook-utils/src/use_observable/index.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-hook-utils", "id": "def-common.OptionalSignalArgs", diff --git a/api_docs/kbn_securitysolution_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index 4894eb915413e..72d15369ce1ac 100644 --- a/api_docs/kbn_securitysolution_hook_utils.mdx +++ b/api_docs/kbn_securitysolution_hook_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-hook-utils title: "@kbn/securitysolution-hook-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-hook-utils plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-hook-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 14 | 0 | 6 | 0 | +| 15 | 0 | 7 | 0 | ## Common diff --git a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx index f0e0356561dd8..5cea36c3e21a3 100644 --- a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-alerting-types title: "@kbn/securitysolution-io-ts-alerting-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-alerting-types plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-alerting-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.mdx b/api_docs/kbn_securitysolution_io_ts_list_types.mdx index 22b0760147191..0b6382bd750fb 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_list_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-list-types title: "@kbn/securitysolution-io-ts-list-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-list-types plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-list-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_types.mdx b/api_docs/kbn_securitysolution_io_ts_types.mdx index 40ecac1736349..9d26bc5c6130f 100644 --- a/api_docs/kbn_securitysolution_io_ts_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-types title: "@kbn/securitysolution-io-ts-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-types plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_io_ts_utils.mdx b/api_docs/kbn_securitysolution_io_ts_utils.mdx index 04e891298a380..29705b6a78362 100644 --- a/api_docs/kbn_securitysolution_io_ts_utils.mdx +++ b/api_docs/kbn_securitysolution_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-utils title: "@kbn/securitysolution-io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-utils plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_api.mdx b/api_docs/kbn_securitysolution_list_api.mdx index 8b6b8cf07c15a..cba2d200c80cb 100644 --- a/api_docs/kbn_securitysolution_list_api.mdx +++ b/api_docs/kbn_securitysolution_list_api.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-api title: "@kbn/securitysolution-list-api" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-api plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-api'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx index 6615bac9efb38..eb0fdf30dc31e 100644 --- a/api_docs/kbn_securitysolution_list_constants.mdx +++ b/api_docs/kbn_securitysolution_list_constants.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-constants title: "@kbn/securitysolution-list-constants" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-constants plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-constants'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_hooks.mdx b/api_docs/kbn_securitysolution_list_hooks.mdx index 70e03cbfed95c..e16588825974a 100644 --- a/api_docs/kbn_securitysolution_list_hooks.mdx +++ b/api_docs/kbn_securitysolution_list_hooks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-hooks title: "@kbn/securitysolution-list-hooks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-hooks plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-hooks'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_list_utils.mdx b/api_docs/kbn_securitysolution_list_utils.mdx index 39b7d58043270..fc6896d6164f1 100644 --- a/api_docs/kbn_securitysolution_list_utils.mdx +++ b/api_docs/kbn_securitysolution_list_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-utils title: "@kbn/securitysolution-list-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-utils plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_rules.devdocs.json b/api_docs/kbn_securitysolution_rules.devdocs.json index c79040eaed89e..655b25e326c28 100644 --- a/api_docs/kbn_securitysolution_rules.devdocs.json +++ b/api_docs/kbn_securitysolution_rules.devdocs.json @@ -9,11 +9,19 @@ "objects": [] }, "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.flattenWithPrefix", + "id": "def-common.flattenWithPrefix", "type": "Function", "tags": [], "label": "flattenWithPrefix", @@ -26,7 +34,7 @@ "children": [ { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.flattenWithPrefix.$1", + "id": "def-common.flattenWithPrefix.$1", "type": "string", "tags": [], "label": "prefix", @@ -40,7 +48,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.flattenWithPrefix.$2", + "id": "def-common.flattenWithPrefix.$2", "type": "Unknown", "tags": [], "label": "maybeObj", @@ -58,7 +66,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.isRuleType", + "id": "def-common.isRuleType", "type": "Function", "tags": [], "label": "isRuleType", @@ -71,7 +79,7 @@ "children": [ { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.isRuleType.$1", + "id": "def-common.isRuleType.$1", "type": "Unknown", "tags": [], "label": "ruleType", @@ -89,7 +97,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.isRuleTypeId", + "id": "def-common.isRuleTypeId", "type": "Function", "tags": [], "label": "isRuleTypeId", @@ -98,9 +106,9 @@ "(ruleTypeId: unknown) => ruleTypeId is ", { "pluginId": "@kbn/securitysolution-rules", - "scope": "server", + "scope": "common", "docId": "kibKbnSecuritysolutionRulesPluginApi", - "section": "def-server.RuleTypeId", + "section": "def-common.RuleTypeId", "text": "RuleTypeId" } ], @@ -109,7 +117,7 @@ "children": [ { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.isRuleTypeId.$1", + "id": "def-common.isRuleTypeId.$1", "type": "Unknown", "tags": [], "label": "ruleTypeId", @@ -131,7 +139,7 @@ "misc": [ { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.EQL_RULE_TYPE_ID", + "id": "def-common.EQL_RULE_TYPE_ID", "type": "string", "tags": [], "label": "EQL_RULE_TYPE_ID", @@ -145,7 +153,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.INDICATOR_RULE_TYPE_ID", + "id": "def-common.INDICATOR_RULE_TYPE_ID", "type": "string", "tags": [], "label": "INDICATOR_RULE_TYPE_ID", @@ -159,7 +167,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.MAX_EXECUTION_EVENTS_DISPLAYED", + "id": "def-common.MAX_EXECUTION_EVENTS_DISPLAYED", "type": "number", "tags": [], "label": "MAX_EXECUTION_EVENTS_DISPLAYED", @@ -175,7 +183,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.ML_RULE_TYPE_ID", + "id": "def-common.ML_RULE_TYPE_ID", "type": "string", "tags": [], "label": "ML_RULE_TYPE_ID", @@ -189,7 +197,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.QUERY_RULE_TYPE_ID", + "id": "def-common.QUERY_RULE_TYPE_ID", "type": "string", "tags": [], "label": "QUERY_RULE_TYPE_ID", @@ -203,7 +211,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.RuleType", + "id": "def-common.RuleType", "type": "Type", "tags": [], "label": "RuleType", @@ -217,7 +225,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.RuleTypeId", + "id": "def-common.RuleTypeId", "type": "Type", "tags": [], "label": "RuleTypeId", @@ -231,7 +239,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.SAVED_QUERY_RULE_TYPE_ID", + "id": "def-common.SAVED_QUERY_RULE_TYPE_ID", "type": "string", "tags": [], "label": "SAVED_QUERY_RULE_TYPE_ID", @@ -245,7 +253,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.SIGNALS_ID", + "id": "def-common.SIGNALS_ID", "type": "string", "tags": [], "label": "SIGNALS_ID", @@ -261,7 +269,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.THRESHOLD_RULE_TYPE_ID", + "id": "def-common.THRESHOLD_RULE_TYPE_ID", "type": "string", "tags": [], "label": "THRESHOLD_RULE_TYPE_ID", @@ -277,7 +285,7 @@ "objects": [ { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.ruleTypeMappings", + "id": "def-common.ruleTypeMappings", "type": "Object", "tags": [], "label": "ruleTypeMappings", @@ -289,7 +297,7 @@ "children": [ { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.ruleTypeMappings.eql", + "id": "def-common.ruleTypeMappings.eql", "type": "string", "tags": [], "label": "eql", @@ -302,7 +310,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.ruleTypeMappings.machine_learning", + "id": "def-common.ruleTypeMappings.machine_learning", "type": "string", "tags": [], "label": "machine_learning", @@ -315,7 +323,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.ruleTypeMappings.query", + "id": "def-common.ruleTypeMappings.query", "type": "string", "tags": [], "label": "query", @@ -328,7 +336,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.ruleTypeMappings.saved_query", + "id": "def-common.ruleTypeMappings.saved_query", "type": "string", "tags": [], "label": "saved_query", @@ -341,7 +349,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.ruleTypeMappings.threat_match", + "id": "def-common.ruleTypeMappings.threat_match", "type": "string", "tags": [], "label": "threat_match", @@ -354,7 +362,7 @@ }, { "parentPluginId": "@kbn/securitysolution-rules", - "id": "def-server.ruleTypeMappings.threshold", + "id": "def-common.ruleTypeMappings.threshold", "type": "string", "tags": [], "label": "threshold", @@ -369,13 +377,5 @@ "initialIsOpen": false } ] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] } } \ No newline at end of file diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx index e0a298ed33ecc..5898c59fde611 100644 --- a/api_docs/kbn_securitysolution_rules.mdx +++ b/api_docs/kbn_securitysolution_rules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-rules title: "@kbn/securitysolution-rules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-rules plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-rules'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -20,14 +20,14 @@ Contact [Owner missing] for questions regarding this plugin. |-------------------|-----------|------------------------|-----------------| | 24 | 0 | 21 | 0 | -## Server +## Common ### Objects - + ### Functions - + ### Consts, variables and types - + diff --git a/api_docs/kbn_securitysolution_t_grid.mdx b/api_docs/kbn_securitysolution_t_grid.mdx index 269196aeeda43..3657d94564bb0 100644 --- a/api_docs/kbn_securitysolution_t_grid.mdx +++ b/api_docs/kbn_securitysolution_t_grid.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-t-grid title: "@kbn/securitysolution-t-grid" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-t-grid plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-t-grid'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_securitysolution_utils.devdocs.json b/api_docs/kbn_securitysolution_utils.devdocs.json index 21ffac0a2035c..ed36e48ca0c1c 100644 --- a/api_docs/kbn_securitysolution_utils.devdocs.json +++ b/api_docs/kbn_securitysolution_utils.devdocs.json @@ -9,11 +9,19 @@ "objects": [] }, "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.addIdToItem", + "id": "def-common.addIdToItem", "type": "Function", "tags": [], "label": "addIdToItem", @@ -26,7 +34,7 @@ "children": [ { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.addIdToItem.$1", + "id": "def-common.addIdToItem.$1", "type": "Uncategorized", "tags": [], "label": "item", @@ -44,7 +52,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.hasSimpleExecutableName", + "id": "def-common.hasSimpleExecutableName", "type": "Function", "tags": [], "label": "hasSimpleExecutableName", @@ -53,17 +61,17 @@ "({ os, type, value, }: { os: ", { "pluginId": "@kbn/securitysolution-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.OperatingSystem", + "section": "def-common.OperatingSystem", "text": "OperatingSystem" }, "; type: ", { "pluginId": "@kbn/securitysolution-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.EntryTypes", + "section": "def-common.EntryTypes", "text": "EntryTypes" }, "; value: string; }) => boolean | undefined" @@ -73,7 +81,7 @@ "children": [ { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.hasSimpleExecutableName.$1", + "id": "def-common.hasSimpleExecutableName.$1", "type": "Object", "tags": [], "label": "{\n os,\n type,\n value,\n}", @@ -83,7 +91,7 @@ "children": [ { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.hasSimpleExecutableName.$1.os", + "id": "def-common.hasSimpleExecutableName.$1.os", "type": "Enum", "tags": [], "label": "os", @@ -91,9 +99,9 @@ "signature": [ { "pluginId": "@kbn/securitysolution-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.OperatingSystem", + "section": "def-common.OperatingSystem", "text": "OperatingSystem" } ], @@ -102,7 +110,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.hasSimpleExecutableName.$1.type", + "id": "def-common.hasSimpleExecutableName.$1.type", "type": "CompoundType", "tags": [], "label": "type", @@ -115,7 +123,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.hasSimpleExecutableName.$1.value", + "id": "def-common.hasSimpleExecutableName.$1.value", "type": "string", "tags": [], "label": "value", @@ -131,7 +139,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.isPathValid", + "id": "def-common.isPathValid", "type": "Function", "tags": [], "label": "isPathValid", @@ -140,25 +148,25 @@ "({ os, field, type, value, }: { os: ", { "pluginId": "@kbn/securitysolution-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.OperatingSystem", + "section": "def-common.OperatingSystem", "text": "OperatingSystem" }, "; field: ", { "pluginId": "@kbn/securitysolution-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.AllConditionEntryFields", + "section": "def-common.AllConditionEntryFields", "text": "AllConditionEntryFields" }, "; type: ", { "pluginId": "@kbn/securitysolution-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.EntryTypes", + "section": "def-common.EntryTypes", "text": "EntryTypes" }, "; value: string; }) => boolean" @@ -168,7 +176,7 @@ "children": [ { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.isPathValid.$1", + "id": "def-common.isPathValid.$1", "type": "Object", "tags": [], "label": "{\n os,\n field,\n type,\n value,\n}", @@ -178,7 +186,7 @@ "children": [ { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.isPathValid.$1.os", + "id": "def-common.isPathValid.$1.os", "type": "Enum", "tags": [], "label": "os", @@ -186,9 +194,9 @@ "signature": [ { "pluginId": "@kbn/securitysolution-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.OperatingSystem", + "section": "def-common.OperatingSystem", "text": "OperatingSystem" } ], @@ -197,35 +205,35 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.isPathValid.$1.field", + "id": "def-common.isPathValid.$1.field", "type": "CompoundType", "tags": [], "label": "field", "description": [], "signature": [ - "\"file.path.text\" | ", { "pluginId": "@kbn/securitysolution-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.TrustedAppConditionEntryField", + "section": "def-common.TrustedAppConditionEntryField", "text": "TrustedAppConditionEntryField" }, " | ", { "pluginId": "@kbn/securitysolution-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.BlocklistConditionEntryField", + "section": "def-common.BlocklistConditionEntryField", "text": "BlocklistConditionEntryField" - } + }, + " | \"file.path.text\"" ], "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts", "deprecated": false }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.isPathValid.$1.type", + "id": "def-common.isPathValid.$1.type", "type": "CompoundType", "tags": [], "label": "type", @@ -238,7 +246,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.isPathValid.$1.value", + "id": "def-common.isPathValid.$1.value", "type": "string", "tags": [], "label": "value", @@ -254,7 +262,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.removeIdFromItem", + "id": "def-common.removeIdFromItem", "type": "Function", "tags": [], "label": "removeIdFromItem", @@ -269,7 +277,7 @@ "children": [ { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.removeIdFromItem.$1", + "id": "def-common.removeIdFromItem.$1", "type": "Uncategorized", "tags": [], "label": "item", @@ -289,7 +297,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.transformDataToNdjson", + "id": "def-common.transformDataToNdjson", "type": "Function", "tags": [], "label": "transformDataToNdjson", @@ -302,7 +310,7 @@ "children": [ { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.transformDataToNdjson.$1", + "id": "def-common.transformDataToNdjson.$1", "type": "Array", "tags": [], "label": "data", @@ -320,7 +328,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.validateFilePathInput", + "id": "def-common.validateFilePathInput", "type": "Function", "tags": [], "label": "validateFilePathInput", @@ -329,9 +337,9 @@ "({ os, value, }: { os: ", { "pluginId": "@kbn/securitysolution-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.OperatingSystem", + "section": "def-common.OperatingSystem", "text": "OperatingSystem" }, "; value?: string | undefined; }) => string | undefined" @@ -341,7 +349,7 @@ "children": [ { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.validateFilePathInput.$1", + "id": "def-common.validateFilePathInput.$1", "type": "Object", "tags": [], "label": "{\n os,\n value = '',\n}", @@ -351,7 +359,7 @@ "children": [ { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.validateFilePathInput.$1.os", + "id": "def-common.validateFilePathInput.$1.os", "type": "Enum", "tags": [], "label": "os", @@ -359,9 +367,9 @@ "signature": [ { "pluginId": "@kbn/securitysolution-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.OperatingSystem", + "section": "def-common.OperatingSystem", "text": "OperatingSystem" } ], @@ -370,7 +378,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.validateFilePathInput.$1.value", + "id": "def-common.validateFilePathInput.$1.value", "type": "string", "tags": [], "label": "value", @@ -392,7 +400,7 @@ "enums": [ { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.ConditionEntryField", + "id": "def-common.ConditionEntryField", "type": "Enum", "tags": [], "label": "ConditionEntryField", @@ -403,7 +411,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.EntryFieldType", + "id": "def-common.EntryFieldType", "type": "Enum", "tags": [], "label": "EntryFieldType", @@ -414,7 +422,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.OperatingSystem", + "id": "def-common.OperatingSystem", "type": "Enum", "tags": [], "label": "OperatingSystem", @@ -427,28 +435,28 @@ "misc": [ { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.AllConditionEntryFields", + "id": "def-common.AllConditionEntryFields", "type": "Type", "tags": [], "label": "AllConditionEntryFields", "description": [], "signature": [ - "\"file.path.text\" | ", { "pluginId": "@kbn/securitysolution-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.TrustedAppConditionEntryField", + "section": "def-common.TrustedAppConditionEntryField", "text": "TrustedAppConditionEntryField" }, " | ", { "pluginId": "@kbn/securitysolution-utils", - "scope": "server", + "scope": "common", "docId": "kibKbnSecuritysolutionUtilsPluginApi", - "section": "def-server.BlocklistConditionEntryField", + "section": "def-common.BlocklistConditionEntryField", "text": "BlocklistConditionEntryField" - } + }, + " | \"file.path.text\"" ], "path": "packages/kbn-securitysolution-utils/src/path_validations/index.ts", "deprecated": false, @@ -456,7 +464,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.BlocklistConditionEntryField", + "id": "def-common.BlocklistConditionEntryField", "type": "Type", "tags": [], "label": "BlocklistConditionEntryField", @@ -470,7 +478,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.EntryTypes", + "id": "def-common.EntryTypes", "type": "Type", "tags": [], "label": "EntryTypes", @@ -484,7 +492,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.FILENAME_WILDCARD_WARNING", + "id": "def-common.FILENAME_WILDCARD_WARNING", "type": "string", "tags": [], "label": "FILENAME_WILDCARD_WARNING", @@ -495,7 +503,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.FILEPATH_WARNING", + "id": "def-common.FILEPATH_WARNING", "type": "string", "tags": [], "label": "FILEPATH_WARNING", @@ -506,7 +514,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.TrustedAppConditionEntryField", + "id": "def-common.TrustedAppConditionEntryField", "type": "Type", "tags": [], "label": "TrustedAppConditionEntryField", @@ -520,7 +528,7 @@ }, { "parentPluginId": "@kbn/securitysolution-utils", - "id": "def-server.TrustedAppEntryTypes", + "id": "def-common.TrustedAppEntryTypes", "type": "Type", "tags": [], "label": "TrustedAppEntryTypes", @@ -534,13 +542,5 @@ } ], "objects": [] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] } } \ No newline at end of file diff --git a/api_docs/kbn_securitysolution_utils.mdx b/api_docs/kbn_securitysolution_utils.mdx index f89634ac45a1b..358b967e0e1ab 100644 --- a/api_docs/kbn_securitysolution_utils.mdx +++ b/api_docs/kbn_securitysolution_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-utils title: "@kbn/securitysolution-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-utils plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -20,14 +20,14 @@ Contact [Owner missing] for questions regarding this plugin. |-------------------|-----------|------------------------|-----------------| | 31 | 0 | 29 | 0 | -## Server +## Common ### Functions - + ### Enums - + ### Consts, variables and types - + diff --git a/api_docs/kbn_server_http_tools.mdx b/api_docs/kbn_server_http_tools.mdx index b7177420222a4..435a1791cc7fd 100644 --- a/api_docs/kbn_server_http_tools.mdx +++ b/api_docs/kbn_server_http_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-http-tools title: "@kbn/server-http-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-http-tools plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-http-tools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_server_route_repository.devdocs.json b/api_docs/kbn_server_route_repository.devdocs.json index 170693037e662..ffea04ecd4368 100644 --- a/api_docs/kbn_server_route_repository.devdocs.json +++ b/api_docs/kbn_server_route_repository.devdocs.json @@ -9,11 +9,19 @@ "objects": [] }, "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.createServerRouteFactory", + "id": "def-common.createServerRouteFactory", "type": "Function", "tags": [], "label": "createServerRouteFactory", @@ -22,25 +30,25 @@ "() => (route: ", { "pluginId": "@kbn/server-route-repository", - "scope": "server", + "scope": "common", "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-server.ServerRoute", + "section": "def-common.ServerRoute", "text": "ServerRoute" }, ") => Record>" @@ -53,7 +61,7 @@ }, { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.decodeRequestParams", + "id": "def-common.decodeRequestParams", "type": "Function", "tags": [], "label": "decodeRequestParams", @@ -68,7 +76,7 @@ "children": [ { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.decodeRequestParams.$1", + "id": "def-common.decodeRequestParams.$1", "type": "Object", "tags": [], "label": "params", @@ -82,7 +90,7 @@ }, { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.decodeRequestParams.$2", + "id": "def-common.decodeRequestParams.$2", "type": "Uncategorized", "tags": [], "label": "paramsRt", @@ -100,7 +108,7 @@ }, { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.formatRequest", + "id": "def-common.formatRequest", "type": "Function", "tags": [], "label": "formatRequest", @@ -113,7 +121,7 @@ "children": [ { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.formatRequest.$1", + "id": "def-common.formatRequest.$1", "type": "string", "tags": [], "label": "endpoint", @@ -127,7 +135,7 @@ }, { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.formatRequest.$2", + "id": "def-common.formatRequest.$2", "type": "Object", "tags": [], "label": "pathParams", @@ -145,7 +153,7 @@ }, { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.parseEndpoint", + "id": "def-common.parseEndpoint", "type": "Function", "tags": [], "label": "parseEndpoint", @@ -158,7 +166,7 @@ "children": [ { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.parseEndpoint.$1", + "id": "def-common.parseEndpoint.$1", "type": "string", "tags": [], "label": "endpoint", @@ -178,7 +186,7 @@ "interfaces": [ { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.RouteState", + "id": "def-common.RouteState", "type": "Interface", "tags": [], "label": "RouteState", @@ -188,7 +196,7 @@ "children": [ { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.RouteState.Unnamed", + "id": "def-common.RouteState.Unnamed", "type": "IndexSignature", "tags": [], "label": "[endpoint: string]: any", @@ -207,7 +215,7 @@ "misc": [ { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.ClientRequestParamsOf", + "id": "def-common.ClientRequestParamsOf", "type": "Type", "tags": [], "label": "ClientRequestParamsOf", @@ -216,9 +224,9 @@ "TServerRouteRepository[TEndpoint] extends ", { "pluginId": "@kbn/server-route-repository", - "scope": "server", + "scope": "common", "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-server.ServerRoute", + "section": "def-common.ServerRoute", "text": "ServerRoute" }, " ? TRouteParamsRT extends ", { "pluginId": "@kbn/server-route-repository", - "scope": "server", + "scope": "common", "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-server.RouteParamsRT", + "section": "def-common.RouteParamsRT", "text": "RouteParamsRT" }, " ? ClientRequestParamsOfType : {} : never" @@ -239,7 +247,7 @@ }, { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.DecodedRequestParamsOf", + "id": "def-common.DecodedRequestParamsOf", "type": "Type", "tags": [], "label": "DecodedRequestParamsOf", @@ -248,9 +256,9 @@ "TServerRouteRepository[TEndpoint] extends ", { "pluginId": "@kbn/server-route-repository", - "scope": "server", + "scope": "common", "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-server.ServerRoute", + "section": "def-common.ServerRoute", "text": "ServerRoute" }, " ? TRouteParamsRT extends ", { "pluginId": "@kbn/server-route-repository", - "scope": "server", + "scope": "common", "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-server.RouteParamsRT", + "section": "def-common.RouteParamsRT", "text": "RouteParamsRT" }, " ? DecodedRequestParamsOfType : {} : never" @@ -271,7 +279,7 @@ }, { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.EndpointOf", + "id": "def-common.EndpointOf", "type": "Type", "tags": [], "label": "EndpointOf", @@ -285,7 +293,7 @@ }, { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.ReturnOf", + "id": "def-common.ReturnOf", "type": "Type", "tags": [], "label": "ReturnOf", @@ -294,9 +302,9 @@ "TServerRouteRepository[TEndpoint] extends ", { "pluginId": "@kbn/server-route-repository", - "scope": "server", + "scope": "common", "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-server.ServerRoute", + "section": "def-common.ServerRoute", "text": "ServerRoute" }, "(endpoint: TEndpoint, ...args: MaybeOptionalArgs<", { "pluginId": "@kbn/server-route-repository", - "scope": "server", + "scope": "common", "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-server.ClientRequestParamsOf", + "section": "def-common.ClientRequestParamsOf", "text": "ClientRequestParamsOf" }, " & TAdditionalClientOptions>) => Promise<", { "pluginId": "@kbn/server-route-repository", - "scope": "server", + "scope": "common", "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-server.ReturnOf", + "section": "def-common.ReturnOf", "text": "ReturnOf" }, ">" @@ -359,7 +367,7 @@ "children": [ { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.RouteRepositoryClient.$1", + "id": "def-common.RouteRepositoryClient.$1", "type": "Uncategorized", "tags": [], "label": "endpoint", @@ -372,7 +380,7 @@ }, { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.RouteRepositoryClient.$2", + "id": "def-common.RouteRepositoryClient.$2", "type": "Uncategorized", "tags": [], "label": "args", @@ -382,25 +390,25 @@ "<", { "pluginId": "@kbn/server-route-repository", - "scope": "server", + "scope": "common", "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-server.ClientRequestParamsOf", + "section": "def-common.ClientRequestParamsOf", "text": "ClientRequestParamsOf" }, " & TAdditionalClientOptions> extends never ? [] | [", { "pluginId": "@kbn/server-route-repository", - "scope": "server", + "scope": "common", "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-server.ClientRequestParamsOf", + "section": "def-common.ClientRequestParamsOf", "text": "ClientRequestParamsOf" }, " & TAdditionalClientOptions] : [", { "pluginId": "@kbn/server-route-repository", - "scope": "server", + "scope": "common", "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-server.ClientRequestParamsOf", + "section": "def-common.ClientRequestParamsOf", "text": "ClientRequestParamsOf" }, " & TAdditionalClientOptions]" @@ -413,7 +421,7 @@ }, { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.ServerRoute", + "id": "def-common.ServerRoute", "type": "Type", "tags": [], "label": "ServerRoute", @@ -422,9 +430,9 @@ "{ endpoint: TEndpoint; params?: TRouteParamsRT | undefined; handler: ({}: TRouteHandlerResources & (TRouteParamsRT extends ", { "pluginId": "@kbn/server-route-repository", - "scope": "server", + "scope": "common", "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-server.RouteParamsRT", + "section": "def-common.RouteParamsRT", "text": "RouteParamsRT" }, " ? DecodedRequestParamsOfType : {})) => Promise; } & TRouteCreateOptions" @@ -435,7 +443,7 @@ }, { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.ServerRouteRepository", + "id": "def-common.ServerRouteRepository", "type": "Type", "tags": [], "label": "ServerRouteRepository", @@ -444,17 +452,17 @@ "{ [x: string]: ", { "pluginId": "@kbn/server-route-repository", - "scope": "server", + "scope": "common", "docId": "kibKbnServerRouteRepositoryPluginApi", - "section": "def-server.ServerRoute", + "section": "def-common.ServerRoute", "text": "ServerRoute" }, ">; }" @@ -467,7 +475,7 @@ "objects": [ { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.routeValidationObject", + "id": "def-common.routeValidationObject", "type": "Object", "tags": [], "label": "routeValidationObject", @@ -477,7 +485,7 @@ "children": [ { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.routeValidationObject.body", + "id": "def-common.routeValidationObject.body", "type": "Object", "tags": [], "label": "body", @@ -493,7 +501,7 @@ }, { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.routeValidationObject.params", + "id": "def-common.routeValidationObject.params", "type": "Object", "tags": [], "label": "params", @@ -507,7 +515,7 @@ }, { "parentPluginId": "@kbn/server-route-repository", - "id": "def-server.routeValidationObject.query", + "id": "def-common.routeValidationObject.query", "type": "Object", "tags": [], "label": "query", @@ -523,13 +531,5 @@ "initialIsOpen": false } ] - }, - "common": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] } } \ No newline at end of file diff --git a/api_docs/kbn_server_route_repository.mdx b/api_docs/kbn_server_route_repository.mdx index b4ded054b09ea..c054b944bd3e6 100644 --- a/api_docs/kbn_server_route_repository.mdx +++ b/api_docs/kbn_server_route_repository.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository title: "@kbn/server-route-repository" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-route-repository plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -20,17 +20,17 @@ Contact [Owner missing] for questions regarding this plugin. |-------------------|-----------|------------------------|-----------------| | 25 | 0 | 24 | 1 | -## Server +## Common ### Objects - + ### Functions - + ### Interfaces - + ### Consts, variables and types - + diff --git a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx index 16c76cd894f90..1418f076fa374 100644 --- a/api_docs/kbn_shared_ux_button_exit_full_screen.mdx +++ b/api_docs/kbn_shared_ux_button_exit_full_screen.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-exit-full-screen title: "@kbn/shared-ux-button-exit-full-screen" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-button-exit-full-screen plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-exit-full-screen'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_shared_ux_components.devdocs.json b/api_docs/kbn_shared_ux_components.devdocs.json index fd3d022aeaef2..dacb43793ba26 100644 --- a/api_docs/kbn_shared_ux_components.devdocs.json +++ b/api_docs/kbn_shared_ux_components.devdocs.json @@ -88,35 +88,17 @@ }, { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplate", + "id": "def-common.KibanaNoDataPage", "type": "Function", "tags": [], - "label": "KibanaPageTemplate", + "label": "KibanaNoDataPage", "description": [ - "\nA `KibanaPageTemplate` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `KibanaPageTemplateLazy` component lazily with\na predefined fallback and error boundary." + "\nA `KibanaNoDataPage` component. The component is wrapped by the `withSuspense` HOC.\nThis component can be used directly by consumers and will load the `KibanaNoDataPageLazy` lazily with\na predefined fallback and error boundary." ], "signature": [ - "React.ForwardRefExoticComponent & { template?: \"default\" | \"empty\" | \"centeredBody\" | \"centeredContent\" | undefined; paddingSize?: \"none\" | \"m\" | \"s\" | \"l\" | undefined; pageSideBar?: React.ReactNode; pageSideBarProps?: ", - "EuiPageSideBarProps", - " | undefined; pageHeader?: ", - "EuiPageHeaderProps", - " | undefined; pageBodyProps?: ", - "EuiPageBodyProps", - "<\"main\"> | undefined; pageContentProps?: ", - "EuiPageContentProps", - " | undefined; pageContentBodyProps?: ", - "EuiPageContentBodyProps", - " | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ", - "EuiBottomBarProps", - " | undefined; fullHeight?: boolean | \"noscroll\" | undefined; minHeight?: ", - "MinHeightProperty", - " | undefined; } & { isEmptyState?: boolean | undefined; solutionNav?: ", - "KibanaPageTemplateSolutionNavProps", - " | undefined; noDataConfig?: ", - "NoDataPageProps", - " | undefined; } & React.RefAttributes<{}>>" + "React.ForwardRefExoticComponent<", + "Props", + " & React.RefAttributes<{}>>" ], "path": "packages/kbn-shared-ux-components/src/index.ts", "deprecated": false, @@ -124,7 +106,7 @@ "children": [ { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplate.$1", + "id": "def-common.KibanaNoDataPage.$1", "type": "Uncategorized", "tags": [], "label": "props", @@ -140,37 +122,19 @@ }, { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplateLazy", + "id": "def-common.KibanaNoDataPageLazy", "type": "Function", "tags": [], - "label": "KibanaPageTemplateLazy", + "label": "KibanaNoDataPageLazy", "description": [ - "\nThe lazily loaded `KibanaPageTemplate` component that is wrapped by the `withSuspense` HOC. Consumers should use\n`React.Suspense` or `withSuspense` HOC to load this component." + "\n A `KibanaNoDataPage` component, with service hooks. Consumers should use `React.Suspennse` or the\n`withSuspense` HOC to load this component." ], "signature": [ - "React.ExoticComponent & { template?: \"default\" | \"empty\" | \"centeredBody\" | \"centeredContent\" | undefined; paddingSize?: \"none\" | \"m\" | \"s\" | \"l\" | undefined; pageSideBar?: React.ReactNode; pageSideBarProps?: ", - "EuiPageSideBarProps", - " | undefined; pageHeader?: ", - "EuiPageHeaderProps", - " | undefined; pageBodyProps?: ", - "EuiPageBodyProps", - "<\"main\"> | undefined; pageContentProps?: ", - "EuiPageContentProps", - " | undefined; pageContentBodyProps?: ", - "EuiPageContentBodyProps", - " | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ", - "EuiBottomBarProps", - " | undefined; fullHeight?: boolean | \"noscroll\" | undefined; minHeight?: ", - "MinHeightProperty", - " | undefined; } & { isEmptyState?: boolean | undefined; solutionNav?: ", - "KibanaPageTemplateSolutionNavProps", - " | undefined; noDataConfig?: ", - "NoDataPageProps", - " | undefined; } & { children?: React.ReactNode; }> & { readonly _result: React.FunctionComponent<", - "KibanaPageTemplateProps", - ">; }" + "React.ExoticComponent<", + "Props", + "> & { readonly _result: ({ onDataViewCreated, noDataConfig }: ", + "Props", + ") => JSX.Element | null; }" ], "path": "packages/kbn-shared-ux-components/src/index.ts", "deprecated": false, @@ -178,7 +142,7 @@ "children": [ { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplateLazy.$1", + "id": "def-common.KibanaNoDataPageLazy.$1", "type": "Uncategorized", "tags": [], "label": "props", @@ -194,27 +158,35 @@ }, { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplateSolutionNav", + "id": "def-common.KibanaPageTemplate", "type": "Function", "tags": [], - "label": "KibanaPageTemplateSolutionNav", + "label": "KibanaPageTemplate", "description": [ - "\nA `KibanaPageTemplateSolutionNav` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `KibanaPageTemplateSolutionNavLazy` component lazily with\na predefined fallback and error boundary." + "\nA `KibanaPageTemplate` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `KibanaPageTemplateLazy` component lazily with\na predefined fallback and error boundary." ], "signature": [ - "React.ForwardRefExoticComponent<", - "CommonProps", - " & { children?: undefined; className?: string | undefined; heading?: React.ReactNode; headingProps?: ", - "EuiSideNavHeadingProps", - " | undefined; toggleOpenOnMobile?: React.MouseEventHandler | undefined; isOpenOnMobile?: boolean | undefined; mobileTitle?: React.ReactNode; mobileBreakpoints?: ", - "EuiBreakpointSize", - "[] | undefined; items: ", - "EuiSideNavItemType", - "<{}>[]; renderItem?: ", - "RenderItem", - "<{}> | undefined; truncate?: boolean | undefined; } & { name: string; icon?: ", - "IconType", - " | undefined; isOpenOnDesktop?: boolean | undefined; onCollapse?: (() => void) | undefined; } & React.RefAttributes<{}>>" + "React.ForwardRefExoticComponent & { template?: \"default\" | \"empty\" | \"centeredBody\" | \"centeredContent\" | undefined; paddingSize?: \"none\" | \"m\" | \"s\" | \"l\" | undefined; pageSideBar?: React.ReactNode; pageSideBarProps?: ", + "EuiPageSideBarProps", + " | undefined; pageHeader?: ", + "EuiPageHeaderProps", + " | undefined; pageBodyProps?: ", + "EuiPageBodyProps", + "<\"main\"> | undefined; pageContentProps?: ", + "EuiPageContentProps", + " | undefined; pageContentBodyProps?: ", + "EuiPageContentBodyProps", + " | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ", + "EuiBottomBarProps", + " | undefined; fullHeight?: boolean | \"noscroll\" | undefined; minHeight?: ", + "Property", + ".MinHeight | undefined; } & { isEmptyState?: boolean | undefined; solutionNav?: ", + "KibanaPageTemplateSolutionNavProps", + " | undefined; noDataConfig?: ", + "NoDataPageProps", + " | undefined; } & React.RefAttributes<{}>>" ], "path": "packages/kbn-shared-ux-components/src/index.ts", "deprecated": false, @@ -222,7 +194,7 @@ "children": [ { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplateSolutionNav.$1", + "id": "def-common.KibanaPageTemplate.$1", "type": "Uncategorized", "tags": [], "label": "props", @@ -238,63 +210,43 @@ }, { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplateSolutionNavLazy", + "id": "def-common.KibanaPageTemplateLazy", "type": "Function", "tags": [], - "label": "KibanaPageTemplateSolutionNavLazy", + "label": "KibanaPageTemplateLazy", "description": [ - "\nThe lazily loaded `KibanaPageTemplateSolutionNav` component that is wrapped by the `withSuspense` HOC. Consumers should use\n`React.Suspense` or `withSuspense` HOC to load this component." + "\nThe lazily loaded `KibanaPageTemplate` component that is wrapped by the `withSuspense` HOC. Consumers should use\n`React.Suspense` or `withSuspense` HOC to load this component." ], "signature": [ - "React.ExoticComponent<", - "CommonProps", - " & { children?: undefined; className?: string | undefined; heading?: React.ReactNode; headingProps?: ", - "EuiSideNavHeadingProps", - " | undefined; toggleOpenOnMobile?: React.MouseEventHandler | undefined; isOpenOnMobile?: boolean | undefined; mobileTitle?: React.ReactNode; mobileBreakpoints?: ", - "EuiBreakpointSize", - "[] | undefined; items: ", - "EuiSideNavItemType", - "<{}>[]; renderItem?: ", - "RenderItem", - "<{}> | undefined; truncate?: boolean | undefined; } & { name: string; icon?: ", - "IconType", - " | undefined; isOpenOnDesktop?: boolean | undefined; onCollapse?: (() => void) | undefined; } & { children?: React.ReactNode; }> & { readonly _result: React.FunctionComponent<", + "React.ExoticComponent & { template?: \"default\" | \"empty\" | \"centeredBody\" | \"centeredContent\" | undefined; paddingSize?: \"none\" | \"m\" | \"s\" | \"l\" | undefined; pageSideBar?: React.ReactNode; pageSideBarProps?: ", + "EuiPageSideBarProps", + " | undefined; pageHeader?: ", + "EuiPageHeaderProps", + " | undefined; pageBodyProps?: ", + "EuiPageBodyProps", + "<\"main\"> | undefined; pageContentProps?: ", + "EuiPageContentProps", + " | undefined; pageContentBodyProps?: ", + "EuiPageContentBodyProps", + " | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ", + "EuiBottomBarProps", + " | undefined; fullHeight?: boolean | \"noscroll\" | undefined; minHeight?: ", + "Property", + ".MinHeight | undefined; } & { isEmptyState?: boolean | undefined; solutionNav?: ", "KibanaPageTemplateSolutionNavProps", - ">; }" - ], - "path": "packages/kbn-shared-ux-components/src/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ + " | undefined; noDataConfig?: ", + "NoDataPageProps", + " | undefined; } & { children?: React.ReactNode; }> & { readonly _result: React.FunctionComponent<", { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaPageTemplateSolutionNavLazy.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaSolutionAvatar", - "type": "Function", - "tags": [], - "label": "KibanaSolutionAvatar", - "description": [ - "\nA `KibanaSolutionAvatar` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `KibanaPageTemplateSolutionNavAvatarLazy` component lazily with\na predefined fallback and error boundary." - ], - "signature": [ - "React.ForwardRefExoticComponent<", - "KibanaSolutionAvatarProps", - " & React.RefAttributes<{}>>" + "pluginId": "@kbn/shared-ux-components", + "scope": "common", + "docId": "kibKbnSharedUxComponentsPluginApi", + "section": "def-common.KibanaPageTemplateProps", + "text": "KibanaPageTemplateProps" + }, + ">; }" ], "path": "packages/kbn-shared-ux-components/src/index.ts", "deprecated": false, @@ -302,7 +254,7 @@ "children": [ { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaSolutionAvatar.$1", + "id": "def-common.KibanaPageTemplateLazy.$1", "type": "Uncategorized", "tags": [], "label": "props", @@ -318,19 +270,23 @@ }, { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaSolutionAvatarLazy", + "id": "def-common.KibanaPageTemplateSolutionNavLazy", "type": "Function", "tags": [], - "label": "KibanaSolutionAvatarLazy", + "label": "KibanaPageTemplateSolutionNavLazy", "description": [ - "\nThe Lazily-loaded `KibanaSolutionAvatar` component. Consumers should use `React.Suspense` or\nthe withSuspense` HOC to load this component." + "\nThe lazily loaded `KibanaPageTemplateSolutionNav` component that is wrapped by the `withSuspense` HOC. Consumers should use\n`React.Suspense` or `withSuspense` HOC to load this component." ], "signature": [ - "React.ExoticComponent<", - "KibanaSolutionAvatarProps", - "> & { readonly _result: ({ className, size, ...rest }: ", - "KibanaSolutionAvatarProps", - ") => JSX.Element; }" + "React.ExoticComponent, \"children\" | \"heading\" | \"items\"> & { name: string; icon?: ", + "IconType", + " | undefined; items?: ", + "EuiSideNavItemType", + "<{}>[] | undefined; children?: React.ReactNode; closeFlyoutButtonPosition?: \"outside\" | \"inside\" | undefined; isOpenOnDesktop?: boolean | undefined; onCollapse?: (() => void) | undefined; } & { children?: React.ReactNode; }> & { readonly _result: React.FunctionComponent<", + "KibanaPageTemplateSolutionNavProps", + ">; }" ], "path": "packages/kbn-shared-ux-components/src/index.ts", "deprecated": false, @@ -338,7 +294,7 @@ "children": [ { "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.KibanaSolutionAvatarLazy.$1", + "id": "def-common.KibanaPageTemplateSolutionNavLazy.$1", "type": "Uncategorized", "tags": [], "label": "props", @@ -388,78 +344,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.LazyNoDataViews", - "type": "Function", - "tags": [], - "label": "LazyNoDataViews", - "description": [ - "\nThe Lazily-loaded `NoDataViews` component. Consumers should use `React.Suspense` or the\n`withSuspense` HOC to load this component." - ], - "signature": [ - "React.ExoticComponent<", - "Props", - "> & { readonly _result: ({ onDataViewCreated }: ", - "Props", - ") => JSX.Element; }" - ], - "path": "packages/kbn-shared-ux-components/src/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.LazyNoDataViews.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.LazyNoDataViewsComponent", - "type": "Function", - "tags": [], - "label": "LazyNoDataViewsComponent", - "description": [ - "\nA pure `NoDataViews` component, with no services hooks. Consumers should use `React.Suspense` or the\n`withSuspense` HOC to load this component." - ], - "signature": [ - "React.ExoticComponent<", - "Props", - "> & { readonly _result: ({ onClickCreate, canCreateNewDataView, dataViewsDocLink, emptyPromptColor, }: ", - "Props", - ") => JSX.Element; }" - ], - "path": "packages/kbn-shared-ux-components/src/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.LazyNoDataViewsComponent.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/shared-ux-components", "id": "def-common.LazyToolbarButton", @@ -494,108 +378,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.NoDataViews", - "type": "Function", - "tags": [], - "label": "NoDataViews", - "description": [ - "\nA `NoDataViews` component that is wrapped by the `withSuspense` HOC. This component can\nbe used directly by consumers and will load the `LazyNoDataViews` component lazily with\na predefined fallback and error boundary." - ], - "signature": [ - "React.ForwardRefExoticComponent<", - "Props", - " & React.RefAttributes<{}>>" - ], - "path": "packages/kbn-shared-ux-components/src/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.NoDataViews.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.NoDataViewsComponent", - "type": "Function", - "tags": [], - "label": "NoDataViewsComponent", - "description": [ - "\nA pure `NoDataViews` component, with no services hooks. The component is wrapped by the `withSuspense` HOC.\nThis component can be used directly by consumers and will load the `LazyNoDataViewsComponent` lazily with\na predefined fallback and error boundary." - ], - "signature": [ - "React.ForwardRefExoticComponent<", - "Props", - " & React.RefAttributes<{}>>" - ], - "path": "packages/kbn-shared-ux-components/src/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.NoDataViewsComponent.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.RedirectAppLinks", - "type": "Function", - "tags": [], - "label": "RedirectAppLinks", - "description": [], - "signature": [ - "React.ExoticComponent & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }> & { readonly _result: React.FC<", - "RedirectAppLinksProps", - ">; }" - ], - "path": "packages/kbn-shared-ux-components/src/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "@kbn/shared-ux-components", - "id": "def-common.RedirectAppLinks.$1", - "type": "Uncategorized", - "tags": [], - "label": "props", - "description": [], - "signature": [ - "P" - ], - "path": "node_modules/@types/react/index.d.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/shared-ux-components", "id": "def-common.ToolbarButton", @@ -666,7 +448,42 @@ ], "interfaces": [], "enums": [], - "misc": [], + "misc": [ + { + "parentPluginId": "@kbn/shared-ux-components", + "id": "def-common.KibanaPageTemplateProps", + "type": "Type", + "tags": [], + "label": "KibanaPageTemplateProps", + "description": [], + "signature": [ + "Omit<", + "EuiPageProps", + ", \"paddingSize\"> & { template?: \"default\" | \"empty\" | \"centeredBody\" | \"centeredContent\" | undefined; paddingSize?: \"none\" | \"m\" | \"s\" | \"l\" | undefined; pageSideBar?: React.ReactNode; pageSideBarProps?: ", + "EuiPageSideBarProps", + " | undefined; pageHeader?: ", + "EuiPageHeaderProps", + " | undefined; pageBodyProps?: ", + "EuiPageBodyProps", + "<\"main\"> | undefined; pageContentProps?: ", + "EuiPageContentProps", + " | undefined; pageContentBodyProps?: ", + "EuiPageContentBodyProps", + " | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ", + "EuiBottomBarProps", + " | undefined; fullHeight?: boolean | \"noscroll\" | undefined; minHeight?: ", + "Property", + ".MinHeight | undefined; } & { isEmptyState?: boolean | undefined; solutionNav?: ", + "KibanaPageTemplateSolutionNavProps", + " | undefined; noDataConfig?: ", + "NoDataPageProps", + " | undefined; }" + ], + "path": "packages/kbn-shared-ux-components/src/page_template/types.ts", + "deprecated": false, + "initialIsOpen": false + } + ], "objects": [] } } \ No newline at end of file diff --git a/api_docs/kbn_shared_ux_components.mdx b/api_docs/kbn_shared_ux_components.mdx index 41704c6d85694..7e2d57701531d 100644 --- a/api_docs/kbn_shared_ux_components.mdx +++ b/api_docs/kbn_shared_ux_components.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-components title: "@kbn/shared-ux-components" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-components plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-components'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,10 +18,13 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 34 | 0 | 6 | 6 | +| 23 | 0 | 6 | 3 | ## Common ### Functions +### Consts, variables and types + + diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data.devdocs.json b/api_docs/kbn_shared_ux_page_analytics_no_data.devdocs.json new file mode 100644 index 0000000000000..b018c18bce13b --- /dev/null +++ b/api_docs/kbn_shared_ux_page_analytics_no_data.devdocs.json @@ -0,0 +1,172 @@ +{ + "id": "@kbn/shared-ux-page-analytics-no-data", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/shared-ux-page-analytics-no-data", + "id": "def-common.AnalyticsNoDataPage", + "type": "Function", + "tags": [], + "label": "AnalyticsNoDataPage", + "description": [ + "\nAn entire page that can be displayed when Kibana \"has no data\", specifically for Analytics.\nRequires a Provider for relevant services." + ], + "signature": [ + "React.ForwardRefExoticComponent<", + "AnalyticsNoDataPageProps", + " & React.RefAttributes<{}>>" + ], + "path": "packages/shared-ux/page/analytics_no_data/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-page-analytics-no-data", + "id": "def-common.AnalyticsNoDataPage.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-page-analytics-no-data", + "id": "def-common.AnalyticsNoDataPageKibanaProvider", + "type": "Function", + "tags": [], + "label": "AnalyticsNoDataPageKibanaProvider", + "description": [ + "\nKibana-specific Provider that maps dependencies to services." + ], + "signature": [ + "({ children, ...dependencies }: React.PropsWithChildren<", + "AnalyticsNoDataPageKibanaDependencies", + ">) => JSX.Element" + ], + "path": "packages/shared-ux/page/analytics_no_data/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-page-analytics-no-data", + "id": "def-common.AnalyticsNoDataPageKibanaProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{\n children,\n ...dependencies\n}", + "description": [], + "signature": [ + "React.PropsWithChildren<", + "AnalyticsNoDataPageKibanaDependencies", + ">" + ], + "path": "packages/shared-ux/page/analytics_no_data/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-page-analytics-no-data", + "id": "def-common.AnalyticsNoDataPageProvider", + "type": "Function", + "tags": [], + "label": "AnalyticsNoDataPageProvider", + "description": [ + "\nA Context Provider that provides services to the component." + ], + "signature": [ + "({ children, ...services }: React.PropsWithChildren<", + "Services", + ">) => JSX.Element" + ], + "path": "packages/shared-ux/page/analytics_no_data/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-page-analytics-no-data", + "id": "def-common.AnalyticsNoDataPageProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{ children, ...services }", + "description": [], + "signature": [ + "React.PropsWithChildren<", + "Services", + ">" + ], + "path": "packages/shared-ux/page/analytics_no_data/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/shared-ux-page-analytics-no-data", + "id": "def-common.LazyAnalyticsNoDataPage", + "type": "Function", + "tags": [], + "label": "LazyAnalyticsNoDataPage", + "description": [ + "\nLazy-loaded connected component. Must be wrapped in `React.Suspense`." + ], + "signature": [ + "React.ExoticComponent<", + "AnalyticsNoDataPageProps", + "> & { readonly _result: ({ onDataViewCreated }: ", + "AnalyticsNoDataPageProps", + ") => JSX.Element; }" + ], + "path": "packages/shared-ux/page/analytics_no_data/src/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-page-analytics-no-data", + "id": "def-common.LazyAnalyticsNoDataPage.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "P" + ], + "path": "node_modules/@types/react/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx new file mode 100644 index 0000000000000..df4375727d5b8 --- /dev/null +++ b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnSharedUxPageAnalyticsNoDataPluginApi +slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data +title: "@kbn/shared-ux-page-analytics-no-data" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/shared-ux-page-analytics-no-data plugin +date: 2022-05-24 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-data'] +warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. +--- +import kbnSharedUxPageAnalyticsNoDataObj from './kbn_shared_ux_page_analytics_no_data.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 8 | 0 | 2 | 3 | + +## Common + +### Functions + + diff --git a/api_docs/kbn_shared_ux_services.devdocs.json b/api_docs/kbn_shared_ux_services.devdocs.json index 08bfb4e4053c7..c8e12bb140018 100644 --- a/api_docs/kbn_shared_ux_services.devdocs.json +++ b/api_docs/kbn_shared_ux_services.devdocs.json @@ -29,7 +29,9 @@ "\nA factory function for creating a Jest-based implementation of `SharedUxServices`." ], "signature": [ - "() => { application: ", + "(params?: ", + "MockServicesFactoryParams", + " | undefined) => { application: ", { "pluginId": "@kbn/shared-ux-services", "scope": "common", @@ -77,11 +79,35 @@ "section": "def-common.SharedUxPlatformService", "text": "SharedUxPlatformService" }, + "; data: ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxDataService", + "text": "SharedUxDataService" + }, "; }" ], "path": "packages/kbn-shared-ux-services/src/services/mock/index.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServicesFactory.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "MockServicesFactoryParams", + " | undefined" + ], + "path": "packages/kbn-shared-ux-services/src/services/mock/index.ts", + "deprecated": false, + "isRequired": false + } + ], "returnComment": [], "initialIsOpen": false }, @@ -192,6 +218,14 @@ "section": "def-common.SharedUxPlatformService", "text": "SharedUxPlatformService" }, + "; data: ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxDataService", + "text": "SharedUxDataService" + }, "; }" ], "path": "packages/kbn-shared-ux-services/src/services/stub/index.ts", @@ -223,6 +257,31 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.useData", + "type": "Function", + "tags": [], + "label": "useData", + "description": [ + "\nReact hook for accessing the pre-wired `SharedUxDataService`." + ], + "signature": [ + "() => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxDataService", + "text": "SharedUxDataService" + } + ], + "path": "packages/kbn-shared-ux-services/src/context.tsx", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/shared-ux-services", "id": "def-common.useDocLinks", @@ -430,6 +489,72 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxDataService", + "type": "Interface", + "tags": [], + "label": "SharedUxDataService", + "description": [ + "\nA service providing data information. Typically used for handling of empty state.." + ], + "path": "packages/kbn-shared-ux-services/src/services/data.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxDataService.hasESData", + "type": "Function", + "tags": [], + "label": "hasESData", + "description": [ + "True if the cluster contains data, false otherwise." + ], + "signature": [ + "() => Promise" + ], + "path": "packages/kbn-shared-ux-services/src/services/data.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxDataService.hasUserDataView", + "type": "Function", + "tags": [], + "label": "hasUserDataView", + "description": [ + "True if Kibana instance contains user-created data view, false otherwise." + ], + "signature": [ + "() => Promise" + ], + "path": "packages/kbn-shared-ux-services/src/services/data.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxDataService.hasDataView", + "type": "Function", + "tags": [], + "label": "hasDataView", + "description": [ + "True if Kibana instance contains any data view, including system-created ones." + ], + "signature": [ + "() => Promise" + ], + "path": "packages/kbn-shared-ux-services/src/services/data.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/shared-ux-services", "id": "def-common.SharedUxDocLinksService", @@ -721,6 +846,25 @@ ], "path": "packages/kbn-shared-ux-services/src/types.ts", "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.SharedUxServices.data", + "type": "Object", + "tags": [], + "label": "data", + "description": [], + "signature": [ + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxDataService", + "text": "SharedUxDataService" + } + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -1071,6 +1215,45 @@ "deprecated": false } ] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories.dataServiceFactory", + "type": "Function", + "tags": [], + "label": "dataServiceFactory", + "description": [], + "signature": [ + "(config?: ", + "MockDataServiceFactoryConfig", + " | undefined) => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxDataService", + "text": "SharedUxDataService" + } + ], + "path": "packages/kbn-shared-ux-services/src/services/mock/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.mockServiceFactories.dataServiceFactory.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "MockDataServiceFactoryConfig", + " | undefined" + ], + "path": "packages/kbn-shared-ux-services/src/services/mock/data.mock.ts", + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -1302,6 +1485,42 @@ "deprecated": false } ] + }, + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories.dataServiceFactory", + "type": "Function", + "tags": [], + "label": "dataServiceFactory", + "description": [], + "signature": [ + "(params: void) => ", + { + "pluginId": "@kbn/shared-ux-services", + "scope": "common", + "docId": "kibKbnSharedUxServicesPluginApi", + "section": "def-common.SharedUxDataService", + "text": "SharedUxDataService" + } + ], + "path": "packages/kbn-shared-ux-services/src/services/stub/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/shared-ux-services", + "id": "def-common.stubServiceFactories.dataServiceFactory.$1", + "type": "Uncategorized", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Parameters" + ], + "path": "packages/kbn-shared-ux-services/src/types.ts", + "deprecated": false + } + ] } ], "initialIsOpen": false diff --git a/api_docs/kbn_shared_ux_services.mdx b/api_docs/kbn_shared_ux_services.mdx index 98fc062b43b0b..55159c05b2143 100644 --- a/api_docs/kbn_shared_ux_services.mdx +++ b/api_docs/kbn_shared_ux_services.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-services title: "@kbn/shared-ux-services" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-services plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-services'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 67 | 0 | 43 | 0 | +| 78 | 0 | 49 | 2 | ## Common diff --git a/api_docs/kbn_shared_ux_storybook.devdocs.json b/api_docs/kbn_shared_ux_storybook.devdocs.json index 8904597032cd4..10b8b342f4cfb 100644 --- a/api_docs/kbn_shared_ux_storybook.devdocs.json +++ b/api_docs/kbn_shared_ux_storybook.devdocs.json @@ -29,7 +29,7 @@ "\nA factory function for creating for creating a storybook implementation of `SharedUXApplicationService`." ], "signature": [ - "() => { navigateToUrl: () => Promise; currentAppId$: ", + "() => { navigateToUrl: (url: string) => Promise; currentAppId$: ", "BehaviorSubject", "; }" ], @@ -39,6 +39,53 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.dataServiceFactory", + "type": "Function", + "tags": [], + "label": "dataServiceFactory", + "description": [ + "\nA factory function for creating a Storybook implementation of `SharedUxDataService`." + ], + "signature": [ + "(params: ", + { + "pluginId": "@kbn/shared-ux-storybook", + "scope": "common", + "docId": "kibKbnSharedUxStorybookPluginApi", + "section": "def-common.DataServiceFactoryConfig", + "text": "DataServiceFactoryConfig" + }, + ") => { hasESData: () => Promise; hasDataView: () => Promise; hasUserDataView: () => Promise; }" + ], + "path": "packages/kbn-shared-ux-storybook/src/services/data.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.dataServiceFactory.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "@kbn/shared-ux-storybook", + "scope": "common", + "docId": "kibKbnSharedUxStorybookPluginApi", + "section": "def-common.DataServiceFactoryConfig", + "text": "DataServiceFactoryConfig" + } + ], + "path": "packages/kbn-shared-ux-storybook/src/services/data.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/shared-ux-storybook", "id": "def-common.docLinksServiceFactory", @@ -49,7 +96,7 @@ "\nA factory function for creating a Storybook implementation of `SharedUxDocLinksService`." ], "signature": [ - "() => { dataViewsDocLink: string; }" + "() => { dataViewsDocLink: string; kibanaGuideDocLink: string; }" ], "path": "packages/kbn-shared-ux-storybook/src/services/doc_links.ts", "deprecated": false, @@ -125,8 +172,10 @@ "signature": [ "(storyFn: ", "PartialStoryFn", - "<", + ", ", + "Args", ">) => JSX.Element" ], "path": "packages/kbn-shared-ux-storybook/src/decorators.tsx", @@ -141,8 +190,10 @@ "description": [], "signature": [ "PartialStoryFn", - "<", + ", ", + "Args", ">" ], "path": "packages/kbn-shared-ux-storybook/src/decorators.tsx", @@ -175,6 +226,8 @@ "SharedUxUserPermissionsService", "; platform: ", "SharedUxPlatformService", + "; data: ", + "SharedUxDataService", "; }" ], "path": "packages/kbn-shared-ux-storybook/src/services/index.ts", @@ -217,7 +270,51 @@ "initialIsOpen": false } ], - "interfaces": [], + "interfaces": [ + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.DataServiceFactoryConfig", + "type": "Interface", + "tags": [], + "label": "DataServiceFactoryConfig", + "description": [], + "path": "packages/kbn-shared-ux-storybook/src/services/data.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.DataServiceFactoryConfig.hasESData", + "type": "boolean", + "tags": [], + "label": "hasESData", + "description": [], + "path": "packages/kbn-shared-ux-storybook/src/services/data.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.DataServiceFactoryConfig.hasDataView", + "type": "boolean", + "tags": [], + "label": "hasDataView", + "description": [], + "path": "packages/kbn-shared-ux-storybook/src/services/data.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/shared-ux-storybook", + "id": "def-common.DataServiceFactoryConfig.hasUserDataView", + "type": "boolean", + "tags": [], + "label": "hasUserDataView", + "description": [], + "path": "packages/kbn-shared-ux-storybook/src/services/data.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], "enums": [], "misc": [], "objects": [] diff --git a/api_docs/kbn_shared_ux_storybook.mdx b/api_docs/kbn_shared_ux_storybook.mdx index 2ce78307c21c8..11fec87a6cf87 100644 --- a/api_docs/kbn_shared_ux_storybook.mdx +++ b/api_docs/kbn_shared_ux_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook title: "@kbn/shared-ux-storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-storybook plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,10 +18,13 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 10 | 0 | 2 | 0 | +| 16 | 0 | 7 | 0 | ## Common ### Functions +### Interfaces + + diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx index 5d8a6344b7906..b3f543547c75d 100644 --- a/api_docs/kbn_shared_ux_utility.mdx +++ b/api_docs/kbn_shared_ux_utility.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-utility title: "@kbn/shared-ux-utility" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-utility plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-utility'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_sort_package_json.mdx b/api_docs/kbn_sort_package_json.mdx index de6879b4cef66..0275bfd7bba16 100644 --- a/api_docs/kbn_sort_package_json.mdx +++ b/api_docs/kbn_sort_package_json.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-sort-package-json title: "@kbn/sort-package-json" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/sort-package-json plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/sort-package-json'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index f998a00c60e83..dcdb86397e80a 100644 --- a/api_docs/kbn_std.mdx +++ b/api_docs/kbn_std.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-std title: "@kbn/std" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/std plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/std'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_stdio_dev_helpers.mdx b/api_docs/kbn_stdio_dev_helpers.mdx index 0397b21fa5d78..32d48520e85da 100644 --- a/api_docs/kbn_stdio_dev_helpers.mdx +++ b/api_docs/kbn_stdio_dev_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-stdio-dev-helpers title: "@kbn/stdio-dev-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/stdio-dev-helpers plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/stdio-dev-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_storybook.devdocs.json b/api_docs/kbn_storybook.devdocs.json index 2253d81413ede..7388a90ac8ed2 100644 --- a/api_docs/kbn_storybook.devdocs.json +++ b/api_docs/kbn_storybook.devdocs.json @@ -98,7 +98,264 @@ "initialIsOpen": false } ], - "interfaces": [], + "interfaces": [ + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig", + "type": "Interface", + "tags": [], + "label": "StorybookConfig", + "description": [ + "\nThe interface for Storybook configuration in `main.ts` files." + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.addons", + "type": "Array", + "tags": [], + "label": "addons", + "description": [ + "\nSets the addons you want to use with Storybook.\n" + ], + "signature": [ + "Preset", + "[] | undefined" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.core", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + "CoreConfig", + " | undefined" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.staticDirs", + "type": "Array", + "tags": [], + "label": "staticDirs", + "description": [ + "\nSets a list of directories of static files to be loaded by Storybook server\n" + ], + "signature": [ + "(string | DirectoryMapping)[] | undefined" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.logLevel", + "type": "string", + "tags": [], + "label": "logLevel", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.features", + "type": "Object", + "tags": [], + "label": "features", + "description": [], + "signature": [ + "{ postcss?: boolean | undefined; emotionAlias?: boolean | undefined; buildStoriesJson?: boolean | undefined; previewCsfV3?: boolean | undefined; modernInlineRender?: boolean | undefined; storyStoreV7?: boolean | undefined; breakingChangesV7?: boolean | undefined; interactionsDebugger?: boolean | undefined; babelModeV7?: boolean | undefined; argTypeTargetsV7?: boolean | undefined; warnOnLegacyHierarchySeparator?: boolean | undefined; } | undefined" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.stories", + "type": "Array", + "tags": [], + "label": "stories", + "description": [ + "\nTells Storybook where to find stories.\n" + ], + "signature": [ + "StoriesEntry", + "[]" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.framework", + "type": "CompoundType", + "tags": [], + "label": "framework", + "description": [ + "\nFramework, e.g. '@storybook/react', required in v7" + ], + "signature": [ + "Preset", + " | undefined" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.typescript", + "type": "Object", + "tags": [], + "label": "typescript", + "description": [ + "\nControls how Storybook handles TypeScript files." + ], + "signature": [ + "Partial<", + "TypescriptOptions", + "> | undefined" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.refs", + "type": "CompoundType", + "tags": [], + "label": "refs", + "description": [ + "\nReferences external Storybooks" + ], + "signature": [ + "StorybookRefs | ((config: ", + "Configuration", + ", options: ", + "Options", + ") => StorybookRefs) | undefined" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.webpackFinal", + "type": "Function", + "tags": [], + "label": "webpackFinal", + "description": [ + "\nModify or return a custom Webpack config." + ], + "signature": [ + "((config: ", + "Configuration", + ", options: ", + "Options", + ") => ", + "Configuration", + " | Promise<", + "Configuration", + ">) | undefined" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.webpackFinal.$1", + "type": "Object", + "tags": [], + "label": "config", + "description": [], + "signature": [ + "Configuration" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.webpackFinal.$2", + "type": "CompoundType", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Options" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.config", + "type": "Function", + "tags": [], + "label": "config", + "description": [ + "\nAdd additional scripts to run in the preview a la `.storybook/preview.js`" + ], + "signature": [ + "((entries: string[], options: ", + "Options", + ") => string[]) | undefined" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.config.$1", + "type": "Array", + "tags": [], + "label": "entries", + "description": [], + "signature": [ + "string[]" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/storybook", + "id": "def-server.StorybookConfig.config.$2", + "type": "CompoundType", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "Options" + ], + "path": "node_modules/@storybook/core-common/dist/ts3.9/types.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], "enums": [], "misc": [], "objects": [ diff --git a/api_docs/kbn_storybook.mdx b/api_docs/kbn_storybook.mdx index c44717161b692..cfb4febbde6af 100644 --- a/api_docs/kbn_storybook.mdx +++ b/api_docs/kbn_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-storybook title: "@kbn/storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/storybook plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/storybook'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact Operations for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 22 | 2 | 21 | 0 | +| 38 | 2 | 21 | 0 | ## Server @@ -28,3 +28,6 @@ Contact Operations for questions regarding this plugin. ### Functions +### Interfaces + + diff --git a/api_docs/kbn_telemetry_tools.mdx b/api_docs/kbn_telemetry_tools.mdx index e925254e723ee..f74dba049bbd5 100644 --- a/api_docs/kbn_telemetry_tools.mdx +++ b/api_docs/kbn_telemetry_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-telemetry-tools title: "@kbn/telemetry-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/telemetry-tools plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/telemetry-tools'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_test.devdocs.json b/api_docs/kbn_test.devdocs.json index ff268e48a4ee5..2fac6616fed52 100644 --- a/api_docs/kbn_test.devdocs.json +++ b/api_docs/kbn_test.devdocs.json @@ -516,44 +516,6 @@ "path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts", "deprecated": false, "children": [ - { - "parentPluginId": "@kbn/test", - "id": "def-server.FunctionalTestRunner.lifecycle", - "type": "Object", - "tags": [], - "label": "lifecycle", - "description": [], - "signature": [ - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.Lifecycle", - "text": "Lifecycle" - } - ], - "path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/test", - "id": "def-server.FunctionalTestRunner.testMetadata", - "type": "Object", - "tags": [], - "label": "testMetadata", - "description": [], - "signature": [ - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.TestMetadata", - "text": "TestMetadata" - } - ], - "path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts", - "deprecated": false - }, { "parentPluginId": "@kbn/test", "id": "def-server.FunctionalTestRunner.Unnamed", @@ -642,11 +604,26 @@ "label": "run", "description": [], "signature": [ - "() => Promise" + "(abortSignal?: AbortSignal | undefined) => Promise" ], "path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "@kbn/test", + "id": "def-server.FunctionalTestRunner.run.$1", + "type": "Object", + "tags": [], + "label": "abortSignal", + "description": [], + "signature": [ + "AbortSignal | undefined" + ], + "path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts", + "deprecated": false, + "isRequired": false + } + ], "returnComment": [] }, { @@ -657,7 +634,7 @@ "label": "getTestStats", "description": [], "signature": [ - "() => Promise<{ testCount: number; testsExcludedByTag: any; }>" + "() => Promise<{ testCount: number; nonSkippedTestCount: number; testsExcludedByTag: any; } | undefined>" ], "path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts", "deprecated": false, @@ -666,13 +643,13 @@ }, { "parentPluginId": "@kbn/test", - "id": "def-server.FunctionalTestRunner._run", + "id": "def-server.FunctionalTestRunner.readConfigFile", "type": "Function", "tags": [], - "label": "_run", + "label": "readConfigFile", "description": [], "signature": [ - "(handler: (config: ", + "() => Promise<", { "pluginId": "@kbn/test", "scope": "server", @@ -680,45 +657,7 @@ "section": "def-server.Config", "text": "Config" }, - ", coreProvider: { type: string; name: string; fn: (...args: any[]) => any; }[]) => Promise) => Promise" - ], - "path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/test", - "id": "def-server.FunctionalTestRunner._run.$1", - "type": "Function", - "tags": [], - "label": "handler", - "description": [], - "signature": [ - "(config: ", - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.Config", - "text": "Config" - }, - ", coreProvider: { type: string; name: string; fn: (...args: any[]) => any; }[]) => Promise" - ], - "path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/test", - "id": "def-server.FunctionalTestRunner.close", - "type": "Function", - "tags": [], - "label": "close", - "description": [], - "signature": [ - "() => Promise" + ">" ], "path": "packages/kbn-test/src/functional_test_runner/functional_test_runner.ts", "deprecated": false, @@ -964,7 +903,7 @@ "ReqOptions", ") => Promise<", "AxiosResponse", - ">" + ">" ], "path": "packages/kbn-test/src/kbn_client/kbn_client.ts", "deprecated": false, @@ -1260,6 +1199,36 @@ ], "path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts", "deprecated": false + }, + { + "parentPluginId": "@kbn/test", + "id": "def-server.Lifecycle.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/test", + "id": "def-server.Lifecycle.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "ToolingLog" + ], + "path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -1340,6 +1309,20 @@ "id": "def-server.LifecyclePhase.Unnamed.$1", "type": "Object", "tags": [], + "label": "sub", + "description": [], + "signature": [ + "Subscription" + ], + "path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/test", + "id": "def-server.LifecyclePhase.Unnamed.$2", + "type": "Object", + "tags": [], "label": "options", "description": [], "path": "packages/kbn-test/src/functional_test_runner/lib/lifecycle_phase.ts", @@ -1347,7 +1330,7 @@ "children": [ { "parentPluginId": "@kbn/test", - "id": "def-server.LifecyclePhase.Unnamed.$1.singular", + "id": "def-server.LifecyclePhase.Unnamed.$2.singular", "type": "CompoundType", "tags": [], "label": "singular", @@ -1457,137 +1440,6 @@ } ], "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/test", - "id": "def-server.TestMetadata", - "type": "Class", - "tags": [], - "label": "TestMetadata", - "description": [], - "path": "packages/kbn-test/src/functional_test_runner/lib/test_metadata.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/test", - "id": "def-server.TestMetadata.Unnamed", - "type": "Function", - "tags": [], - "label": "Constructor", - "description": [], - "signature": [ - "any" - ], - "path": "packages/kbn-test/src/functional_test_runner/lib/test_metadata.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/test", - "id": "def-server.TestMetadata.Unnamed.$1", - "type": "Object", - "tags": [], - "label": "lifecycle", - "description": [], - "signature": [ - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.Lifecycle", - "text": "Lifecycle" - } - ], - "path": "packages/kbn-test/src/functional_test_runner/lib/test_metadata.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/test", - "id": "def-server.TestMetadata.addScreenshot", - "type": "Function", - "tags": [], - "label": "addScreenshot", - "description": [], - "signature": [ - "(screenshot: ", - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.ScreenshotRecord", - "text": "ScreenshotRecord" - }, - ") => void" - ], - "path": "packages/kbn-test/src/functional_test_runner/lib/test_metadata.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/test", - "id": "def-server.TestMetadata.addScreenshot.$1", - "type": "Object", - "tags": [], - "label": "screenshot", - "description": [], - "signature": [ - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.ScreenshotRecord", - "text": "ScreenshotRecord" - } - ], - "path": "packages/kbn-test/src/functional_test_runner/lib/test_metadata.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/test", - "id": "def-server.TestMetadata.getScreenshots", - "type": "Function", - "tags": [], - "label": "getScreenshots", - "description": [], - "signature": [ - "(test: any) => ", - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.ScreenshotRecord", - "text": "ScreenshotRecord" - }, - "[]" - ], - "path": "packages/kbn-test/src/functional_test_runner/lib/test_metadata.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/test", - "id": "def-server.TestMetadata.getScreenshots.$1", - "type": "Any", - "tags": [], - "label": "test", - "description": [], - "signature": [ - "any" - ], - "path": "packages/kbn-test/src/functional_test_runner/lib/test_metadata.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false } ], "functions": [ @@ -2563,6 +2415,38 @@ ], "path": "packages/kbn-test/src/es/test_es_cluster.ts", "deprecated": false + }, + { + "parentPluginId": "@kbn/test", + "id": "def-server.CreateTestEsClusterOptions.onEarlyExit", + "type": "Function", + "tags": [], + "label": "onEarlyExit", + "description": [ + "\nReport to the creator of the es-test-cluster that the es node has exitted before stop() was called, allowing\nthis caller to react appropriately. If this is not passed then an uncatchable exception will be thrown" + ], + "signature": [ + "((msg: string) => void) | undefined" + ], + "path": "packages/kbn-test/src/es/test_es_cluster.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/test", + "id": "def-server.CreateTestEsClusterOptions.onEarlyExit.$1", + "type": "string", + "tags": [], + "label": "msg", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-test/src/es/test_es_cluster.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -2943,7 +2827,7 @@ "\nDetermine if a service is avaliable" ], "signature": [ - "{ (serviceName: \"log\" | \"config\" | \"lifecycle\" | \"dockerServers\" | \"testMetadata\" | \"esVersion\"): true; (serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract; }" + "{ (serviceName: \"log\" | \"config\" | \"lifecycle\" | \"dockerServers\" | \"esVersion\"): true; (serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract; }" ], "path": "packages/kbn-test/src/functional_test_runner/public_types.ts", "deprecated": false, @@ -2956,7 +2840,7 @@ "label": "serviceName", "description": [], "signature": [ - "\"log\" | \"config\" | \"lifecycle\" | \"dockerServers\" | \"testMetadata\" | \"esVersion\"" + "\"log\" | \"config\" | \"lifecycle\" | \"dockerServers\" | \"esVersion\"" ], "path": "packages/kbn-test/src/functional_test_runner/public_types.ts", "deprecated": false, @@ -2973,7 +2857,7 @@ "label": "hasService", "description": [], "signature": [ - "{ (serviceName: \"log\" | \"config\" | \"lifecycle\" | \"dockerServers\" | \"testMetadata\" | \"esVersion\"): true; (serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract; }" + "{ (serviceName: \"log\" | \"config\" | \"lifecycle\" | \"dockerServers\" | \"esVersion\"): true; (serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract; }" ], "path": "packages/kbn-test/src/functional_test_runner/public_types.ts", "deprecated": false, @@ -3003,7 +2887,7 @@ "label": "hasService", "description": [], "signature": [ - "{ (serviceName: \"log\" | \"config\" | \"lifecycle\" | \"dockerServers\" | \"testMetadata\" | \"esVersion\"): true; (serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract; }" + "{ (serviceName: \"log\" | \"config\" | \"lifecycle\" | \"dockerServers\" | \"esVersion\"): true; (serviceName: K): serviceName is K; (serviceName: string): serviceName is Extract; }" ], "path": "packages/kbn-test/src/functional_test_runner/public_types.ts", "deprecated": false, @@ -3061,14 +2945,6 @@ "section": "def-server.DockerServersService", "text": "DockerServersService" }, - "; (serviceName: \"testMetadata\"): ", - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.TestMetadata", - "text": "TestMetadata" - }, "; (serviceName: \"esVersion\"): ", { "pluginId": "@kbn/test", @@ -3133,14 +3009,6 @@ "section": "def-server.DockerServersService", "text": "DockerServersService" }, - "; (serviceName: \"testMetadata\"): ", - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.TestMetadata", - "text": "TestMetadata" - }, "; (serviceName: \"esVersion\"): ", { "pluginId": "@kbn/test", @@ -3205,14 +3073,6 @@ "section": "def-server.DockerServersService", "text": "DockerServersService" }, - "; (serviceName: \"testMetadata\"): ", - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.TestMetadata", - "text": "TestMetadata" - }, "; (serviceName: \"esVersion\"): ", { "pluginId": "@kbn/test", @@ -3277,14 +3137,6 @@ "section": "def-server.DockerServersService", "text": "DockerServersService" }, - "; (serviceName: \"testMetadata\"): ", - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.TestMetadata", - "text": "TestMetadata" - }, "; (serviceName: \"esVersion\"): ", { "pluginId": "@kbn/test", @@ -3349,86 +3201,6 @@ "section": "def-server.DockerServersService", "text": "DockerServersService" }, - "; (serviceName: \"testMetadata\"): ", - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.TestMetadata", - "text": "TestMetadata" - }, - "; (serviceName: \"esVersion\"): ", - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.EsVersion", - "text": "EsVersion" - }, - "; (serviceName: T): ServiceMap[T]; }" - ], - "path": "packages/kbn-test/src/functional_test_runner/public_types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/test", - "id": "def-server.GenericFtrProviderContext.getService.$1", - "type": "string", - "tags": [], - "label": "serviceName", - "description": [], - "signature": [ - "\"testMetadata\"" - ], - "path": "packages/kbn-test/src/functional_test_runner/public_types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "@kbn/test", - "id": "def-server.GenericFtrProviderContext.getService", - "type": "Function", - "tags": [], - "label": "getService", - "description": [], - "signature": [ - "{ (serviceName: \"config\"): ", - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.Config", - "text": "Config" - }, - "; (serviceName: \"log\"): ", - "ToolingLog", - "; (serviceName: \"lifecycle\"): ", - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.Lifecycle", - "text": "Lifecycle" - }, - "; (serviceName: \"dockerServers\"): ", - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.DockerServersService", - "text": "DockerServersService" - }, - "; (serviceName: \"testMetadata\"): ", - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.TestMetadata", - "text": "TestMetadata" - }, "; (serviceName: \"esVersion\"): ", { "pluginId": "@kbn/test", @@ -3493,14 +3265,6 @@ "section": "def-server.DockerServersService", "text": "DockerServersService" }, - "; (serviceName: \"testMetadata\"): ", - { - "pluginId": "@kbn/test", - "scope": "server", - "docId": "kibKbnTestPluginApi", - "section": "def-server.TestMetadata", - "text": "TestMetadata" - }, "; (serviceName: \"esVersion\"): ", { "pluginId": "@kbn/test", @@ -3836,65 +3600,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "@kbn/test", - "id": "def-server.ScreenshotRecord", - "type": "Interface", - "tags": [], - "label": "ScreenshotRecord", - "description": [], - "path": "packages/kbn-test/src/functional_test_runner/lib/test_metadata.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/test", - "id": "def-server.ScreenshotRecord.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "packages/kbn-test/src/functional_test_runner/lib/test_metadata.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/test", - "id": "def-server.ScreenshotRecord.base64Png", - "type": "string", - "tags": [], - "label": "base64Png", - "description": [], - "path": "packages/kbn-test/src/functional_test_runner/lib/test_metadata.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/test", - "id": "def-server.ScreenshotRecord.baselinePath", - "type": "string", - "tags": [], - "label": "baselinePath", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-test/src/functional_test_runner/lib/test_metadata.ts", - "deprecated": false - }, - { - "parentPluginId": "@kbn/test", - "id": "def-server.ScreenshotRecord.failurePath", - "type": "string", - "tags": [], - "label": "failurePath", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "packages/kbn-test/src/functional_test_runner/lib/test_metadata.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "@kbn/test", "id": "def-server.Suite", diff --git a/api_docs/kbn_test.mdx b/api_docs/kbn_test.mdx index 5edb2515010a2..0f6a3137487dc 100644 --- a/api_docs/kbn_test.mdx +++ b/api_docs/kbn_test.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test title: "@kbn/test" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact Operations for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 252 | 6 | 214 | 9 | +| 240 | 5 | 201 | 9 | ## Server diff --git a/api_docs/kbn_test_jest_helpers.devdocs.json b/api_docs/kbn_test_jest_helpers.devdocs.json index aa2262636493c..8ba6126369789 100644 --- a/api_docs/kbn_test_jest_helpers.devdocs.json +++ b/api_docs/kbn_test_jest_helpers.devdocs.json @@ -254,6 +254,24 @@ } ], "functions": [ + { + "parentPluginId": "@kbn/test-jest-helpers", + "id": "def-server.clearBroadcastChannelInstances", + "type": "Function", + "tags": [], + "label": "clearBroadcastChannelInstances", + "description": [ + "\nRemoves all BroadcastChannel instances." + ], + "signature": [ + "() => void" + ], + "path": "packages/kbn-test-jest-helpers/src/stub_broadcast_channel.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/test-jest-helpers", "id": "def-server.delay", @@ -431,6 +449,26 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/test-jest-helpers", + "id": "def-server.getBroadcastChannelInstances", + "type": "Function", + "tags": [], + "label": "getBroadcastChannelInstances", + "description": [ + "\nReturns all BroadcastChannel instances." + ], + "signature": [ + "() => BroadcastChannel[]" + ], + "path": "packages/kbn-test-jest-helpers/src/stub_broadcast_channel.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "BroadcastChannel[]" + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/test-jest-helpers", "id": "def-server.getRandomNumber", @@ -1382,6 +1420,24 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/test-jest-helpers", + "id": "def-server.stubBroadcastChannel", + "type": "Function", + "tags": [], + "label": "stubBroadcastChannel", + "description": [ + "\nStubs the global window.BroadcastChannel for use in jest tests." + ], + "signature": [ + "() => void" + ], + "path": "packages/kbn-test-jest-helpers/src/stub_broadcast_channel.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/test-jest-helpers", "id": "def-server.stubWebWorker", diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx index 0f711e998f1c7..ac9cb43379fb2 100644 --- a/api_docs/kbn_test_jest_helpers.mdx +++ b/api_docs/kbn_test_jest_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test-jest-helpers title: "@kbn/test-jest-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test-jest-helpers plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-jest-helpers'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 132 | 8 | 103 | 2 | +| 135 | 8 | 103 | 2 | ## Server diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx index 7dcb0b67415cb..bc4884d81cb69 100644 --- a/api_docs/kbn_tooling_log.mdx +++ b/api_docs/kbn_tooling_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-tooling-log title: "@kbn/tooling-log" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/tooling-log plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_type_summarizer.mdx b/api_docs/kbn_type_summarizer.mdx index c715205758b5e..4d2af6b05b0b0 100644 --- a/api_docs/kbn_type_summarizer.mdx +++ b/api_docs/kbn_type_summarizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-type-summarizer title: "@kbn/type-summarizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/type-summarizer plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/type-summarizer'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_typed_react_router_config.mdx b/api_docs/kbn_typed_react_router_config.mdx index 66d08cdf52378..fb8060ef2712e 100644 --- a/api_docs/kbn_typed_react_router_config.mdx +++ b/api_docs/kbn_typed_react_router_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-typed-react-router-config title: "@kbn/typed-react-router-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/typed-react-router-config plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/typed-react-router-config'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_ui_theme.devdocs.json b/api_docs/kbn_ui_theme.devdocs.json index bcfd5d506638a..4e69fbc65f0f6 100644 --- a/api_docs/kbn_ui_theme.devdocs.json +++ b/api_docs/kbn_ui_theme.devdocs.json @@ -52,7 +52,7 @@ "label": "Theme", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -82,7 +82,7 @@ "label": "euiDarkVars", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -96,7 +96,7 @@ "label": "euiLightVars", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, @@ -112,7 +112,7 @@ "\nEUI Theme vars that automatically adjust to light/dark theme" ], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "packages/kbn-ui-theme/src/theme.ts", "deprecated": false, diff --git a/api_docs/kbn_ui_theme.mdx b/api_docs/kbn_ui_theme.mdx index bb34a249143f0..2484a73cc6652 100644 --- a/api_docs/kbn_ui_theme.mdx +++ b/api_docs/kbn_ui_theme.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ui-theme title: "@kbn/ui-theme" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ui-theme plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kbn_utility_types.devdocs.json b/api_docs/kbn_utility_types.devdocs.json index bb3eb25102399..3ad3c5339a00c 100644 --- a/api_docs/kbn_utility_types.devdocs.json +++ b/api_docs/kbn_utility_types.devdocs.json @@ -362,6 +362,22 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "@kbn/utility-types", + "id": "def-server.OneOf", + "type": "Type", + "tags": [], + "label": "OneOf", + "description": [ + "\nXOR for some properties applied to a type\n(XOR is one of these but not both or neither)\n\nUsage: OneOf\n\nTo require aria-label or aria-labelledby but not both\nExample: OneOf" + ], + "signature": [ + "Omit & { [k in K]: Pick, k> & { [k1 in Exclude]?: undefined; }; }[K]" + ], + "path": "packages/kbn-utility-types/src/index.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/utility-types", "id": "def-server.Optional", diff --git a/api_docs/kbn_utility_types.mdx b/api_docs/kbn_utility_types.mdx index 5af644c15e127..b856aadc1bfd7 100644 --- a/api_docs/kbn_utility_types.mdx +++ b/api_docs/kbn_utility_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types title: "@kbn/utility-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utility-types plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 28 | 0 | 10 | 1 | +| 29 | 0 | 10 | 1 | ## Server diff --git a/api_docs/kbn_utils.mdx b/api_docs/kbn_utils.mdx index 3ada49f8bdb89..8a8ce384d7a41 100644 --- a/api_docs/kbn_utils.mdx +++ b/api_docs/kbn_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utils title: "@kbn/utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utils plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_overview.mdx b/api_docs/kibana_overview.mdx index 155ccdd4f45b8..67f670cd7fd6e 100644 --- a/api_docs/kibana_overview.mdx +++ b/api_docs/kibana_overview.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaOverview title: "kibanaOverview" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaOverview plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/kibana_react.devdocs.json b/api_docs/kibana_react.devdocs.json index 36fdcb2139cdf..6335f6d2771c1 100644 --- a/api_docs/kibana_react.devdocs.json +++ b/api_docs/kibana_react.devdocs.json @@ -120,6 +120,80 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.TableListView.componentDidUpdate", + "type": "Function", + "tags": [], + "label": "componentDidUpdate", + "description": [], + "signature": [ + "(prevProps: ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.TableListViewProps", + "text": "TableListViewProps" + }, + ", prevState: ", + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.TableListViewState", + "text": "TableListViewState" + }, + ") => void" + ], + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaReact", + "id": "def-public.TableListView.componentDidUpdate.$1", + "type": "Object", + "tags": [], + "label": "prevProps", + "description": [], + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.TableListViewProps", + "text": "TableListViewProps" + }, + "" + ], + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.TableListView.componentDidUpdate.$2", + "type": "Object", + "tags": [], + "label": "prevState", + "description": [], + "signature": [ + { + "pluginId": "kibanaReact", + "scope": "public", + "docId": "kibKibanaReactPluginApi", + "section": "def-public.TableListViewState", + "text": "TableListViewState" + }, + "" + ], + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "kibanaReact", "id": "def-public.TableListView.debouncedFetch", @@ -334,6 +408,39 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.TableListView.onTableChange", + "type": "Function", + "tags": [], + "label": "onTableChange", + "description": [], + "signature": [ + "(criteria: ", + "Criteria", + ") => void" + ], + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaReact", + "id": "def-public.TableListView.onTableChange.$1", + "type": "Object", + "tags": [], + "label": "criteria", + "description": [], + "signature": [ + "Criteria", + "" + ], + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "kibanaReact", "id": "def-public.TableListView.renderTable", @@ -349,6 +456,23 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.TableListView.getTableColumns", + "type": "Function", + "tags": [], + "label": "getTableColumns", + "description": [], + "signature": [ + "() => ", + "EuiBasicTableColumn", + "[]" + ], + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "kibanaReact", "id": "def-public.TableListView.renderCreateButton", @@ -1068,14 +1192,6 @@ "plugin": "osquery", "path": "x-pack/plugins/osquery/public/components/empty_state.tsx" }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/app/home/template_wrapper/index.tsx" - }, { "plugin": "kibanaOverview", "path": "src/plugins/kibana_overview/public/components/overview/overview.tsx" @@ -1680,6 +1796,30 @@ "plugin": "home", "path": "src/plugins/home/public/application/application.tsx" }, + { + "plugin": "data", + "path": "src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx" + }, + { + "plugin": "data", + "path": "src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx" + }, + { + "plugin": "data", + "path": "src/plugins/data/public/search/session/session_indicator/connected_search_session_indicator/connected_search_session_indicator.tsx" + }, + { + "plugin": "data", + "path": "src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx" + }, + { + "plugin": "data", + "path": "src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx" + }, + { + "plugin": "data", + "path": "src/plugins/data/public/search/session/sessions_mgmt/lib/get_columns.tsx" + }, { "plugin": "spaces", "path": "x-pack/plugins/spaces/public/management/spaces_management_app.tsx" @@ -1752,30 +1892,6 @@ "plugin": "observability", "path": "x-pack/plugins/observability/public/application/index.tsx" }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/public/search/sessions_mgmt/lib/get_columns.tsx" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/public/search/sessions_mgmt/lib/get_columns.tsx" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/public/search/sessions_mgmt/lib/get_columns.tsx" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/public/search/ui/connected_search_session_indicator/connected_search_session_indicator.tsx" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/public/search/ui/connected_search_session_indicator/connected_search_session_indicator.tsx" - }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/public/search/ui/connected_search_session_indicator/connected_search_session_indicator.tsx" - }, { "plugin": "ml", "path": "x-pack/plugins/ml/public/application/components/ml_page/ml_page.tsx" @@ -1878,27 +1994,39 @@ }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/lib/alert_types/alert_messages.tsx" + "path": "x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/alert_messages.tsx" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/alert_messages.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/lib/alert_types/alert_messages.tsx" + "path": "x-pack/plugins/synthetics/public/legacy_uptime/lib/alert_types/alert_messages.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/lib/alert_types/alert_messages.tsx" + "path": "x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_app.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/uptime_app.tsx" + "path": "x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_app.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/uptime_app.tsx" + "path": "x-pack/plugins/synthetics/public/legacy_uptime/app/uptime_app.tsx" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/uptime_app.tsx" + "path": "x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx" + }, + { + "plugin": "synthetics", + "path": "x-pack/plugins/synthetics/public/apps/synthetics/synthetics_app.tsx" }, { "plugin": "upgradeAssistant", @@ -1928,6 +2056,30 @@ "plugin": "ux", "path": "x-pack/plugins/ux/public/application/ux_app.tsx" }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx" + }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx" + }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx" + }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx" + }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx" + }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx" + }, { "plugin": "kibanaOverview", "path": "src/plugins/kibana_overview/public/components/add_data/add_data.tsx" @@ -1972,30 +2124,6 @@ "plugin": "kibanaOverview", "path": "src/plugins/kibana_overview/public/components/overview/overview.tsx" }, - { - "plugin": "savedObjectsManagement", - "path": "src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx" - }, - { - "plugin": "savedObjectsManagement", - "path": "src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx" - }, - { - "plugin": "savedObjectsManagement", - "path": "src/plugins/saved_objects_management/public/management_section/saved_objects_edition_page.tsx" - }, - { - "plugin": "savedObjectsManagement", - "path": "src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx" - }, - { - "plugin": "savedObjectsManagement", - "path": "src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx" - }, - { - "plugin": "savedObjectsManagement", - "path": "src/plugins/saved_objects_management/public/management_section/objects_table/saved_objects_table.tsx" - }, { "plugin": "home", "path": "src/plugins/home/public/application/components/add_data/add_data.tsx" @@ -2028,6 +2156,41 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.Route", + "type": "Function", + "tags": [], + "label": "Route", + "description": [ + "\nIt's a wrapper around the react-router-dom Route component that inserts\nMatchPropagator in every application route. It helps track all route changes\nand send them to the execution context, later used to enrich APM\n'route-change' transactions." + ], + "signature": [ + "({ children, component: Component, render, ...rest }: ", + "RouteProps", + ") => JSX.Element" + ], + "path": "src/plugins/kibana_react/public/router/router.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "kibanaReact", + "id": "def-public.Route.$1", + "type": "Object", + "tags": [], + "label": "{ children, component: Component, render, ...rest }", + "description": [], + "signature": [ + "RouteProps" + ], + "path": "src/plugins/kibana_react/public/router/router.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "kibanaReact", "id": "def-public.toMountPoint", @@ -2273,7 +2436,7 @@ "section": "def-public.ExecutionContextSetup", "text": "ExecutionContextSetup" }, - ", context: ", + " | undefined, context: ", "KibanaExecutionContext", ") => void" ], @@ -2294,11 +2457,12 @@ "docId": "kibCorePluginApi", "section": "def-public.ExecutionContextSetup", "text": "ExecutionContextSetup" - } + }, + " | undefined" ], "path": "src/plugins/kibana_react/public/use_execution_context/use_execution_context.ts", "deprecated": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "kibanaReact", @@ -3336,25 +3500,25 @@ "label": "toastNotifications", "description": [], "signature": [ - "{ get$: () => ", - "Observable", - "<", + "{ add: (toastOrTitle: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "section": "def-public.ToastInput", + "text": "ToastInput" }, - "[]>; add: (toastOrTitle: ", + ") => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "section": "def-public.Toast", + "text": "Toast" }, - ") => ", + "; get$: () => ", + "Observable", + "<", { "pluginId": "core", "scope": "public", @@ -3362,7 +3526,7 @@ "section": "def-public.Toast", "text": "Toast" }, - "; remove: (toastOrId: string | ", + "[]>; remove: (toastOrId: string | ", { "pluginId": "core", "scope": "public", @@ -3624,6 +3788,19 @@ "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "deprecated": false }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.TableListViewState.hasUpdatedAtMetadata", + "type": "CompoundType", + "tags": [], + "label": "hasUpdatedAtMetadata", + "description": [], + "signature": [ + "boolean | null" + ], + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "deprecated": false + }, { "parentPluginId": "kibanaReact", "id": "def-public.TableListViewState.isFetchingItems", @@ -3710,6 +3887,21 @@ "description": [], "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", "deprecated": false + }, + { + "parentPluginId": "kibanaReact", + "id": "def-public.TableListViewState.tableSort", + "type": "Object", + "tags": [], + "label": "tableSort", + "description": [], + "signature": [ + "{ field: keyof V; direction: ", + "Direction", + "; } | undefined" + ], + "path": "src/plugins/kibana_react/public/table_list_view/table_list_view.tsx", + "deprecated": false } ], "initialIsOpen": false @@ -4114,8 +4306,8 @@ " | undefined; bottomBar?: React.ReactNode; bottomBarProps?: ", "EuiBottomBarProps", " | undefined; fullHeight?: boolean | \"noscroll\" | undefined; minHeight?: ", - "MinHeightProperty", - " | undefined; } & { isEmptyState?: boolean | undefined; solutionNav?: ", + "Property", + ".MinHeight | undefined; } & { isEmptyState?: boolean | undefined; solutionNav?: ", "KibanaPageTemplateSolutionNavProps", " | undefined; noDataConfig?: ", { @@ -4250,29 +4442,13 @@ "plugin": "enterpriseSearch", "path": "x-pack/plugins/enterprise_search/public/applications/shared/layout/page_template.tsx" }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/navigation/use_security_solution_navigation/use_primary_navigation.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/common/components/navigation/use_security_solution_navigation/use_primary_navigation.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx" - }, - { - "plugin": "securitySolution", - "path": "x-pack/plugins/security_solution/public/app/home/template_wrapper/bottom_bar/index.tsx" - }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/use_no_data_config.ts" + "path": "x-pack/plugins/synthetics/public/legacy_uptime/app/use_no_data_config.ts" }, { "plugin": "synthetics", - "path": "x-pack/plugins/synthetics/public/apps/use_no_data_config.ts" + "path": "x-pack/plugins/synthetics/public/legacy_uptime/app/use_no_data_config.ts" }, { "plugin": "ux", @@ -4996,11 +5172,17 @@ "signature": [ "(storyFn: ", "PartialStoryFn", - "<", + ", ", + "Args", ">, { globals }: ", "StoryContext", - ") => JSX.Element" + ", ", + "Args", + ">) => JSX.Element" ], "path": "src/plugins/kibana_react/common/eui_styled_components.tsx", "deprecated": false, @@ -5014,8 +5196,10 @@ "description": [], "signature": [ "PartialStoryFn", - "<", + ", ", + "Args", ">" ], "path": "src/plugins/kibana_react/common/eui_styled_components.tsx", @@ -5030,7 +5214,12 @@ "label": "{ globals }", "description": [], "signature": [ - "StoryContext" + "StoryContext", + ", ", + "Args", + ">" ], "path": "src/plugins/kibana_react/common/eui_styled_components.tsx", "deprecated": false, @@ -5156,7 +5345,7 @@ "label": "eui", "description": [], "signature": [ - "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; ruleMargins: { marginXSmall: string; marginSmall: string; marginMedium: string; marginLarge: string; marginXLarge: string; marginXXLarge: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; spacerSizes: { xs: string; s: string; m: string; l: string; xl: string; xxl: string; }; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiShadowColorLarge: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" + "{ paddingSizes: { xs: string; s: string; m: string; l: string; xl: string; }; euiBadgeGroupGutterTypes: { gutterExtraSmall: string; gutterSmall: string; }; euiBreadcrumbSpacing: string; euiBreadcrumbTruncateWidth: string; euiButtonEmptyTypes: { primary: string; danger: string; disabled: string; ghost: string; text: string; success: string; warning: string; }; euiCallOutTypes: { primary: string; success: string; warning: string; danger: string; }; euiCardSpacing: string; euiCardBottomNodeHeight: string; euiCardSelectButtonBorders: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardSelectButtonBackgrounds: { text: string; primary: string; success: string; danger: string; ghost: string; }; euiCardPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCheckableCardPadding: string; euiCodeBlockPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiCollapsibleNavGroupLightBackgroundColor: string; euiCollapsibleNavGroupDarkBackgroundColor: string; euiCollapsibleNavGroupDarkHighContrastColor: string; euiColorPickerValueRange0: string; euiColorPickerValueRange1: string; euiColorPickerSaturationRange0: string; euiColorPickerSaturationRange1: string; euiColorPickerIndicatorSize: string; euiColorPickerWidth: string; euiColorPaletteDisplaySizes: { sizeExtraSmall: string; sizeSmall: string; sizeMedium: string; }; euiContextMenuWidth: string; euiControlBarBackground: string; euiControlBarText: string; euiControlBarBorderColor: string; euiControlBarInitialHeight: string; euiControlBarMaxHeight: string; euiControlBarHeights: { s: string; m: string; l: string; }; euiDataGridPrefix: string; euiDataGridStyles: string; euiZDataGrid: number; euiZHeaderBelowDataGrid: number; euiZDataGridCellPopover: number; euiDataGridColumnResizerWidth: string; euiDataGridPopoverMaxHeight: string; euiDataGridCellPaddingS: string; euiDataGridCellPaddingM: string; euiDataGridCellPaddingL: string; euiDataGridVerticalBorder: string; euiSuperDatePickerWidth: string; euiSuperDatePickerButtonWidth: string; euiDragAndDropSpacing: { s: string; m: string; l: string; }; euiExpressionColors: { subdued: string; primary: string; success: string; warning: string; danger: string; accent: string; }; euiFacetGutterSizes: { gutterNone: number; gutterSmall: string; gutterMedium: string; gutterLarge: string; }; gutterTypes: { gutterExtraSmall: string; gutterSmall: string; gutterMedium: string; gutterLarge: string; gutterExtraLarge: string; }; fractions: { fourths: { percentage: string; count: number; }; thirds: { percentage: string; count: number; }; halves: { percentage: string; count: number; }; single: { percentage: string; count: number; }; }; flyoutSizes: { small: { min: string; width: string; max: string; }; medium: { min: string; width: string; max: string; }; large: { min: string; width: string; max: string; }; }; euiFlyoutBorder: string; euiFlyoutPaddingModifiers: { paddingNone: number; paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiFilePickerTallHeight: string; euiRangeLevelColors: { primary: string; success: string; warning: string; danger: string; }; textareaResizing: { vertical: string; horizontal: string; both: string; none: string; }; euiHeaderLinksGutterSizes: { gutterXS: string; gutterS: string; gutterM: string; gutterL: string; }; euiIconLoadingOpacity: number; euiIconColors: { accent: string; danger: string; ghost: string; primary: string; success: string; subdued: string; text: string; warning: string; inherit: string; }; euiIconSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiKeyPadMenuSize: string; euiKeyPadMenuMarginSize: string; euiLinkColors: { subdued: string; primary: string; success: string; accent: string; warning: string; danger: string; text: string; ghost: string; }; euiListGroupItemHoverBackground: string; euiListGroupItemHoverBackgroundGhost: string; euiListGroupGutterTypes: { gutterSmall: string; gutterMedium: string; }; euiListGroupItemColorTypes: { primary: string; text: string; subdued: string; ghost: string; }; euiListGroupItemSizeTypes: { xSmall: string; small: string; medium: string; large: string; }; euiGradientStartStop: string; euiGradientMiddle: string; euiLoadingSpinnerSizes: { small: string; medium: string; large: string; xLarge: string; xxLarge: string; }; euiMarkdownEditorMinHeight: string; euiPopoverArrowSize: string; euiPopoverTranslateDistance: string; euiProgressSizes: { xs: string; s: string; m: string; l: string; }; euiProgressColors: { primary: string; success: string; warning: string; danger: string; accent: string; subdued: string; vis0: string; vis1: string; vis2: string; vis3: string; vis4: string; vis5: string; vis6: string; vis7: string; vis8: string; vis9: string; customColor: string; }; euiResizableButtonTransitionSpeed: string; euiResizableButtonSize: string; euiSelectableListItemBorder: string; euiSelectableListItemPadding: string; euiSelectableTemplateSitewideTypes: { application: { color: string; 'font-weight': number; }; deployment: { color: string; 'font-weight': number; }; article: { color: string; 'font-weight': number; }; case: { color: string; 'font-weight': number; }; platform: { color: string; 'font-weight': number; }; }; euiSideNavEmphasizedBackgroundColor: string; euiSideNavRootTextcolor: string; euiSideNavBranchTextcolor: string; euiSideNavSelectedTextcolor: string; euiSideNavDisabledTextcolor: string; euiStepNumberSize: string; euiStepNumberSmallSize: string; euiStepNumberMargin: string; euiStepStatusColorsToFade: { warning: string; danger: string; disabled: string; incomplete: string; }; euiSuggestItemColors: { tint0: string; tint1: string; tint2: string; tint3: string; tint4: string; tint5: string; tint6: string; tint7: string; tint8: string; tint9: string; tint10: string; }; euiTableCellContentPadding: string; euiTableCellContentPaddingCompressed: string; euiTableCellCheckboxWidth: string; euiTableActionsAreaWidth: string; euiTableHoverColor: string; euiTableSelectedColor: string; euiTableHoverSelectedColor: string; euiTableActionsBorderColor: string; euiTableHoverClickableColor: string; euiTableFocusClickableColor: string; euiTextColors: { default: string; subdued: string; success: string; accent: string; warning: string; danger: string; ghost: string; inherit: string; }; euiTextConstrainedMaxWidth: string; euiToastWidth: string; euiToastTypes: { primary: string; success: string; warning: string; danger: string; }; euiTokenGrayColor: string; euiTokenTypes: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; gray: { graphic: string; behindText: string; }; }; euiTokenTypeKeys: string; euiContrastRatioText: number; euiContrastRatioGraphic: number; euiContrastRatioDisabled: number; euiAnimSlightBounce: string; euiAnimSlightResistance: string; euiAnimSpeedExtraFast: string; euiAnimSpeedFast: string; euiAnimSpeedNormal: string; euiAnimSpeedSlow: string; euiAnimSpeedExtraSlow: string; euiBorderWidthThin: string; euiBorderWidthThick: string; euiBorderColor: string; euiBorderRadius: string; euiBorderRadiusSmall: string; euiBorderThick: string; euiBorderThin: string; euiBorderEditable: string; euiButtonHeight: string; euiButtonHeightSmall: string; euiButtonHeightXSmall: string; euiButtonColorDisabled: string; euiButtonColorDisabledText: string; euiButtonColorGhostDisabled: string; euiButtonTypes: { primary: string; accent: string; success: string; warning: string; danger: string; subdued: string; ghost: string; text: string; }; euiCodeBlockBackgroundColor: string; euiCodeBlockColor: string; euiCodeBlockSelectedBackgroundColor: string; euiCodeBlockCommentColor: string; euiCodeBlockSelectorTagColor: string; euiCodeBlockStringColor: string; euiCodeBlockTagColor: string; euiCodeBlockNameColor: string; euiCodeBlockNumberColor: string; euiCodeBlockKeywordColor: string; euiCodeBlockFunctionTitleColor: string; euiCodeBlockTypeColor: string; euiCodeBlockAttributeColor: string; euiCodeBlockSymbolColor: string; euiCodeBlockParamsColor: string; euiCodeBlockMetaColor: string; euiCodeBlockTitleColor: string; euiCodeBlockSectionColor: string; euiCodeBlockAdditionColor: string; euiCodeBlockDeletionColor: string; euiCodeBlockSelectorClassColor: string; euiCodeBlockSelectorIdColor: string; euiPaletteColorBlind: { euiColorVis0: { graphic: string; behindText: string; }; euiColorVis1: { graphic: string; behindText: string; }; euiColorVis2: { graphic: string; behindText: string; }; euiColorVis3: { graphic: string; behindText: string; }; euiColorVis4: { graphic: string; behindText: string; }; euiColorVis5: { graphic: string; behindText: string; }; euiColorVis6: { graphic: string; behindText: string; }; euiColorVis7: { graphic: string; behindText: string; }; euiColorVis8: { graphic: string; behindText: string; }; euiColorVis9: { graphic: string; behindText: string; }; }; euiPaletteColorBlindKeys: string; euiColorVis0: string; euiColorVis1: string; euiColorVis2: string; euiColorVis3: string; euiColorVis4: string; euiColorVis5: string; euiColorVis6: string; euiColorVis7: string; euiColorVis8: string; euiColorVis9: string; euiColorVis0_behindText: string; euiColorVis1_behindText: string; euiColorVis2_behindText: string; euiColorVis3_behindText: string; euiColorVis4_behindText: string; euiColorVis5_behindText: string; euiColorVis6_behindText: string; euiColorVis7_behindText: string; euiColorVis8_behindText: string; euiColorVis9_behindText: string; euiFontWeightLight: number; euiFontWeightRegular: number; euiFontWeightMedium: number; euiFontWeightSemiBold: number; euiFontWeightBold: number; euiCodeFontWeightRegular: number; euiCodeFontWeightBold: number; euiFormMaxWidth: string; euiFormControlHeight: string; euiFormControlCompressedHeight: string; euiFormControlPadding: string; euiFormControlCompressedPadding: string; euiFormControlBorderRadius: string; euiFormControlCompressedBorderRadius: string; euiRadioSize: string; euiCheckBoxSize: string; euiCheckboxBorderRadius: string; euiSwitchHeight: string; euiSwitchWidth: string; euiSwitchThumbSize: string; euiSwitchIconHeight: string; euiSwitchHeightCompressed: string; euiSwitchWidthCompressed: string; euiSwitchThumbSizeCompressed: string; euiSwitchHeightMini: string; euiSwitchWidthMini: string; euiSwitchThumbSizeMini: string; euiFormBackgroundColor: string; euiFormBackgroundDisabledColor: string; euiFormBackgroundReadOnlyColor: string; euiFormBorderOpaqueColor: string; euiFormBorderColor: string; euiFormBorderDisabledColor: string; euiFormCustomControlDisabledIconColor: string; euiFormCustomControlBorderColor: string; euiFormControlDisabledColor: string; euiFormControlBoxShadow: string; euiFormControlPlaceholderText: string; euiFormInputGroupLabelBackground: string; euiFormInputGroupBorder: string; euiSwitchOffColor: string; euiFormControlLayoutGroupInputHeight: string; euiFormControlLayoutGroupInputCompressedHeight: string; euiFormControlLayoutGroupInputCompressedBorderRadius: string; euiRangeTrackColor: string; euiRangeThumbRadius: string; euiRangeThumbHeight: string; euiRangeThumbWidth: string; euiRangeThumbBorderColor: string; euiRangeTrackWidth: string; euiRangeTrackHeight: string; euiRangeTrackBorderWidth: number; euiRangeTrackBorderColor: string; euiRangeTrackRadius: string; euiRangeDisabledOpacity: number; euiRangeHighlightHeight: string; euiHeaderBackgroundColor: string; euiHeaderDarkBackgroundColor: string; euiHeaderBorderColor: string; euiHeaderBreadcrumbColor: string; euiHeaderHeight: string; euiHeaderChildSize: string; euiHeaderHeightCompensation: string; euiPageDefaultMaxWidth: string; euiPageSidebarMinWidth: string; euiPanelPaddingModifiers: { paddingSmall: string; paddingMedium: string; paddingLarge: string; }; euiPanelBorderRadiusModifiers: { borderRadiusNone: number; borderRadiusMedium: string; }; euiPanelBackgroundColorModifiers: { transparent: string; plain: string; subdued: string; accent: string; primary: string; success: string; warning: string; danger: string; }; euiBreakpoints: { xs: number; s: string; m: string; l: string; xl: string; }; euiBreakpointKeys: string; euiShadowColor: string; euiSize: string; euiSizeXS: string; euiSizeS: string; euiSizeM: string; euiSizeL: string; euiSizeXL: string; euiSizeXXL: string; euiButtonMinWidth: string; euiScrollBar: string; euiScrollBarCorner: string; euiScrollBarCornerThin: string; euiFocusRingColor: string; euiFocusRingAnimStartColor: string; euiFocusRingAnimStartSize: string; euiFocusRingAnimStartSizeLarge: string; euiFocusRingSizeLarge: string; euiFocusRingSize: string; euiFocusTransparency: number; euiFocusTransparencyPercent: string; euiFocusBackgroundColor: string; euiTooltipBackgroundColor: string; euiTooltipBorderColor: string; euiTooltipAnimations: { top: string; left: string; bottom: string; right: string; }; euiFontFamily: string; euiCodeFontFamily: string; euiFontFeatureSettings: string; euiTextScale: string; euiFontSize: string; euiFontSizeXS: string; euiFontSizeS: string; euiFontSizeM: string; euiFontSizeL: string; euiFontSizeXL: string; euiFontSizeXXL: string; euiLineHeight: number; euiBodyLineHeight: number; euiTitles: { xxxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xxs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; xs: { 'font-size': string; 'line-height': string; 'font-weight': number; }; s: { 'font-size': string; 'line-height': string; 'font-weight': number; }; m: { 'font-size': string; 'line-height': string; 'font-weight': number; }; l: { 'font-size': string; 'line-height': string; 'font-weight': number; }; }; euiZLevel0: number; euiZLevel1: number; euiZLevel2: number; euiZLevel3: number; euiZLevel4: number; euiZLevel5: number; euiZLevel6: number; euiZLevel7: number; euiZLevel8: number; euiZLevel9: number; euiZToastList: number; euiZModal: number; euiZMask: number; euiZNavigation: number; euiZContentMenu: number; euiZHeader: number; euiZFlyout: number; euiZMaskBelowHeader: number; euiZContent: number; euiColorGhost: string; euiColorInk: string; euiColorPrimary: string; euiColorAccent: string; euiColorSuccess: string; euiColorWarning: string; euiColorDanger: string; euiColorEmptyShade: string; euiColorLightestShade: string; euiColorLightShade: string; euiColorMediumShade: string; euiColorDarkShade: string; euiColorDarkestShade: string; euiColorFullShade: string; euiPageBackgroundColor: string; euiColorHighlight: string; euiTextColor: string; euiTitleColor: string; euiTextSubduedColor: string; euiColorDisabled: string; euiColorPrimaryText: string; euiColorSuccessText: string; euiColorAccentText: string; euiColorWarningText: string; euiColorDangerText: string; euiColorDisabledText: string; euiLinkColor: string; euiColorChartLines: string; euiColorChartBand: string; euiDatePickerCalendarWidth: string; euiDatePickerPadding: string; euiDatePickerGap: string; euiDatePickerCalendarColumns: number; euiDatePickerButtonSize: string; euiDatePickerMinControlWidth: string; euiDatePickerMaxControlWidth: string; euiButtonDefaultTransparency: number; euiButtonFontWeight: number; euiRangeHighlightColor: string; euiRangeThumbBackgroundColor: string; euiRangeTrackCompressedHeight: string; euiRangeHighlightCompressedHeight: string; euiRangeHeight: string; euiRangeCompressedHeight: string; euiStepStatusColors: { default: string; complete: string; warning: string; danger: string; }; }" ], "path": "src/plugins/kibana_react/common/eui_styled_components.tsx", "deprecated": false diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index 3def8e96dfcf8..6be54ccb0f28d 100644 --- a/api_docs/kibana_react.mdx +++ b/api_docs/kibana_react.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaReact title: "kibanaReact" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaReact plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaReact'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 240 | 0 | 204 | 5 | +| 250 | 0 | 213 | 5 | ## Client diff --git a/api_docs/kibana_utils.devdocs.json b/api_docs/kibana_utils.devdocs.json index ff686632d0f4a..417ec958da12e 100644 --- a/api_docs/kibana_utils.devdocs.json +++ b/api_docs/kibana_utils.devdocs.json @@ -1970,25 +1970,25 @@ "\nToast notifications service to show toasts in error cases." ], "signature": [ - "{ get$: () => ", - "Observable", - "<", + "{ add: (toastOrTitle: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "section": "def-public.ToastInput", + "text": "ToastInput" }, - "[]>; add: (toastOrTitle: ", + ") => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "section": "def-public.Toast", + "text": "Toast" }, - ") => ", + "; get$: () => ", + "Observable", + "<", { "pluginId": "core", "scope": "public", @@ -1996,7 +1996,7 @@ "section": "def-public.Toast", "text": "Toast" }, - "; remove: (toastOrId: string | ", + "[]>; remove: (toastOrId: string | ", { "pluginId": "core", "scope": "public", @@ -3526,25 +3526,25 @@ "\nToast notifications service to show toasts in error cases." ], "signature": [ - "{ get$: () => ", - "Observable", - "<", + "{ add: (toastOrTitle: ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.Toast", - "text": "Toast" + "section": "def-public.ToastInput", + "text": "ToastInput" }, - "[]>; add: (toastOrTitle: ", + ") => ", { "pluginId": "core", "scope": "public", "docId": "kibCorePluginApi", - "section": "def-public.ToastInput", - "text": "ToastInput" + "section": "def-public.Toast", + "text": "Toast" }, - ") => ", + "; get$: () => ", + "Observable", + "<", { "pluginId": "core", "scope": "public", @@ -3552,7 +3552,7 @@ "section": "def-public.Toast", "text": "Toast" }, - "; remove: (toastOrId: string | ", + "[]>; remove: (toastOrId: string | ", { "pluginId": "core", "scope": "public", @@ -7480,7 +7480,9 @@ "\n" ], "signature": [ - "(res: { custom: | Error | { message: string | Error; attributes?: ", + "(res: { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -7488,9 +7490,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -7599,6 +7599,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -7606,11 +7608,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -7630,9 +7630,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -7642,9 +7642,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -7654,9 +7654,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -7676,7 +7676,9 @@ }, ") => ", "KibanaResponse", - "" + " | undefined; } | Buffer>" ], "path": "src/plugins/kibana_utils/server/report_server_error.ts", "deprecated": false, @@ -7701,7 +7701,9 @@ "Formats a `KbnServerError` into a server error response" ], "signature": [ - "{ custom: | Error | { message: string | Error; attributes?: ", + "{ custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -7709,9 +7711,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -7820,6 +7820,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -7827,11 +7829,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -7851,9 +7851,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -7863,9 +7863,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -7875,9 +7875,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx index b639f92c9c96c..519dea4b7f539 100644 --- a/api_docs/kibana_utils.mdx +++ b/api_docs/kibana_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaUtils title: "kibanaUtils" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaUtils plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaUtils'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/lens.devdocs.json b/api_docs/lens.devdocs.json index ae98881027a3b..dc5b6bc365755 100644 --- a/api_docs/lens.devdocs.json +++ b/api_docs/lens.devdocs.json @@ -1,7 +1,595 @@ { "id": "lens", "client": { - "classes": [], + "classes": [ + { + "parentPluginId": "lens", + "id": "def-public.Embeddable", + "type": "Class", + "tags": [], + "label": "Embeddable", + "description": [], + "signature": [ + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.Embeddable", + "text": "Embeddable" + }, + " extends ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.Embeddable", + "text": "Embeddable" + }, + "<", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.LensEmbeddableInput", + "text": "LensEmbeddableInput" + }, + ", ", + "LensEmbeddableOutput", + "> implements ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ReferenceOrValueEmbeddable", + "text": "ReferenceOrValueEmbeddable" + }, + "<", + "LensByValueInput", + ", ", + "LensByReferenceInput", + ">" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.deferEmbeddableLoad", + "type": "boolean", + "tags": [], + "label": "deferEmbeddableLoad", + "description": [], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "deps", + "description": [], + "signature": [ + "LensEmbeddableDeps" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.Unnamed.$2", + "type": "CompoundType", + "tags": [], + "label": "initialInput", + "description": [], + "signature": [ + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.LensEmbeddableInput", + "text": "LensEmbeddableInput" + } + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.Unnamed.$3", + "type": "Object", + "tags": [], + "label": "parent", + "description": [], + "signature": [ + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.IContainer", + "text": "IContainer" + }, + "<{}, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerInput", + "text": "ContainerInput" + }, + "<{}>, ", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.ContainerOutput", + "text": "ContainerOutput" + }, + "> | undefined" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.supportedTriggers", + "type": "Function", + "tags": [], + "label": "supportedTriggers", + "description": [], + "signature": [ + "() => string[]" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.getInspectorAdapters", + "type": "Function", + "tags": [], + "label": "getInspectorAdapters", + "description": [], + "signature": [ + "() => ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + } + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.initializeSavedVis", + "type": "Function", + "tags": [], + "label": "initializeSavedVis", + "description": [], + "signature": [ + "(input: ", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.LensEmbeddableInput", + "text": "LensEmbeddableInput" + }, + ") => Promise" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.initializeSavedVis.$1", + "type": "CompoundType", + "tags": [], + "label": "input", + "description": [], + "signature": [ + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.LensEmbeddableInput", + "text": "LensEmbeddableInput" + } + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.onContainerStateChanged", + "type": "Function", + "tags": [], + "label": "onContainerStateChanged", + "description": [], + "signature": [ + "(containerState: ", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.LensEmbeddableInput", + "text": "LensEmbeddableInput" + }, + ") => void" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.onContainerStateChanged.$1", + "type": "CompoundType", + "tags": [], + "label": "containerState", + "description": [], + "signature": [ + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.LensEmbeddableInput", + "text": "LensEmbeddableInput" + } + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.handleContainerStateChanged", + "type": "Function", + "tags": [], + "label": "handleContainerStateChanged", + "description": [], + "signature": [ + "(containerState: ", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.LensEmbeddableInput", + "text": "LensEmbeddableInput" + }, + ") => boolean" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.handleContainerStateChanged.$1", + "type": "CompoundType", + "tags": [], + "label": "containerState", + "description": [], + "signature": [ + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.LensEmbeddableInput", + "text": "LensEmbeddableInput" + } + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.render", + "type": "Function", + "tags": [], + "label": "render", + "description": [ + "\n" + ], + "signature": [ + "(domNode: Element | HTMLElement) => void" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.render.$1", + "type": "CompoundType", + "tags": [], + "label": "domNode", + "description": [], + "signature": [ + "Element | HTMLElement" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.handleEvent", + "type": "Function", + "tags": [], + "label": "handleEvent", + "description": [], + "signature": [ + "(event: ", + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRendererEvent", + "text": "ExpressionRendererEvent" + }, + ") => Promise" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.handleEvent.$1", + "type": "Object", + "tags": [], + "label": "event", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "public", + "docId": "kibExpressionsPluginApi", + "section": "def-public.ExpressionRendererEvent", + "text": "ExpressionRendererEvent" + } + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.reload", + "type": "Function", + "tags": [], + "label": "reload", + "description": [], + "signature": [ + "() => void" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.getViewUnderlyingDataArgs", + "type": "Function", + "tags": [], + "label": "getViewUnderlyingDataArgs", + "description": [ + "\nReturns the necessary arguments to view the underlying data in discover.\n\nOnly makes sense to call this after canViewUnderlyingData has been checked" + ], + "signature": [ + "() => ", + "ViewUnderlyingDataArgs", + " | undefined" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.canViewUnderlyingData", + "type": "Function", + "tags": [], + "label": "canViewUnderlyingData", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.initializeOutput", + "type": "Function", + "tags": [], + "label": "initializeOutput", + "description": [], + "signature": [ + "() => Promise" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.inputIsRefType", + "type": "Function", + "tags": [], + "label": "inputIsRefType", + "description": [], + "signature": [ + "(input: ", + "LensByValueInput", + " | ", + "LensByReferenceInput", + ") => input is ", + "LensByReferenceInput" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.inputIsRefType.$1", + "type": "CompoundType", + "tags": [], + "label": "input", + "description": [], + "signature": [ + "LensByValueInput", + " | ", + "LensByReferenceInput" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.getInputAsRefType", + "type": "Function", + "tags": [], + "label": "getInputAsRefType", + "description": [], + "signature": [ + "() => Promise<", + "LensByReferenceInput", + ">" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.getInputAsValueType", + "type": "Function", + "tags": [], + "label": "getInputAsValueType", + "description": [], + "signature": [ + "() => Promise<", + "LensByValueInput", + ">" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.getDescription", + "type": "Function", + "tags": [], + "label": "getDescription", + "description": [], + "signature": [ + "() => string | undefined" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.getSavedVis", + "type": "Function", + "tags": [], + "label": "getSavedVis", + "description": [], + "signature": [ + "() => Readonly<", + "Document", + " | undefined>" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.destroy", + "type": "Function", + "tags": [], + "label": "destroy", + "description": [], + "signature": [ + "() => void" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], "functions": [], "interfaces": [ { @@ -203,16 +791,6 @@ "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, "children": [ - { - "parentPluginId": "lens", - "id": "def-public.DataLayerArgs.layerId", - "type": "string", - "tags": [], - "label": "layerId", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, { "parentPluginId": "lens", "id": "def-public.DataLayerArgs.accessors", @@ -221,7 +799,15 @@ "label": "accessors", "description": [], "signature": [ - "string[]" + "(string | ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.ExpressionValueVisDimension", + "text": "ExpressionValueVisDimension" + }, + ")[]" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -242,12 +828,20 @@ { "parentPluginId": "lens", "id": "def-public.DataLayerArgs.xAccessor", - "type": "string", + "type": "CompoundType", "tags": [], "label": "xAccessor", "description": [], "signature": [ - "string | undefined" + "string | ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.ExpressionValueVisDimension", + "text": "ExpressionValueVisDimension" + }, + " | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -268,38 +862,93 @@ { "parentPluginId": "lens", "id": "def-public.DataLayerArgs.splitAccessor", - "type": "string", + "type": "CompoundType", "tags": [], "label": "splitAccessor", "description": [], "signature": [ - "string | undefined" + "string | ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.ExpressionValueVisDimension", + "text": "ExpressionValueVisDimension" + }, + " | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "lens", - "id": "def-public.DataLayerArgs.columnToLabel", - "type": "string", + "id": "def-public.DataLayerArgs.markSizeAccessor", + "type": "CompoundType", "tags": [], - "label": "columnToLabel", + "label": "markSizeAccessor", "description": [], "signature": [ - "string | undefined" + "string | ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.ExpressionValueVisDimension", + "text": "ExpressionValueVisDimension" + }, + " | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.DataLayerArgs.lineWidth", + "type": "number", + "tags": [], + "label": "lineWidth", + "description": [], + "signature": [ + "number | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "lens", - "id": "def-public.DataLayerArgs.yScaleType", + "id": "def-public.DataLayerArgs.showPoints", "type": "CompoundType", "tags": [], - "label": "yScaleType", + "label": "showPoints", "description": [], "signature": [ - "\"time\" | \"log\" | \"sqrt\" | \"linear\"" + "boolean | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.DataLayerArgs.pointsRadius", + "type": "number", + "tags": [], + "label": "pointsRadius", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.DataLayerArgs.columnToLabel", + "type": "string", + "tags": [], + "label": "columnToLabel", + "description": [], + "signature": [ + "string | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -349,13 +998,7 @@ "label": "yConfig", "description": [], "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.YConfigResult", - "text": "YConfigResult" - }, + "YConfigResult", "[] | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", @@ -667,42 +1310,178 @@ "section": "def-public.DateHistogramIndexPatternColumn", "text": "DateHistogramIndexPatternColumn" }, - " extends ", - { - "pluginId": "lens", - "scope": "public", - "docId": "kibLensPluginApi", - "section": "def-public.FieldBasedIndexPatternColumn", - "text": "FieldBasedIndexPatternColumn" - } - ], - "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx", - "deprecated": false, - "children": [ + " extends ", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.FieldBasedIndexPatternColumn", + "text": "FieldBasedIndexPatternColumn" + } + ], + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.DateHistogramIndexPatternColumn.operationType", + "type": "string", + "tags": [], + "label": "operationType", + "description": [], + "signature": [ + "\"date_histogram\"" + ], + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.DateHistogramIndexPatternColumn.params", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "{ interval: string; ignoreTimeRange?: boolean | undefined; includeEmptyRows?: boolean | undefined; dropPartials?: boolean | undefined; }" + ], + "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "lens", + "id": "def-public.ExtendedYConfig", + "type": "Interface", + "tags": [], + "label": "ExtendedYConfig", + "description": [], + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.ExtendedYConfig", + "text": "ExtendedYConfig" + }, + " extends ", + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.YConfig", + "text": "YConfig" + } + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.ExtendedYConfig.icon", + "type": "CompoundType", + "tags": [], + "label": "icon", + "description": [], + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.AvailableReferenceLineIcon", + "text": "AvailableReferenceLineIcon" + }, + " | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.ExtendedYConfig.lineWidth", + "type": "number", + "tags": [], + "label": "lineWidth", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.ExtendedYConfig.lineStyle", + "type": "CompoundType", + "tags": [], + "label": "lineStyle", + "description": [], + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.LineStyle", + "text": "LineStyle" + }, + " | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.ExtendedYConfig.fill", + "type": "CompoundType", + "tags": [], + "label": "fill", + "description": [], + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.FillStyle", + "text": "FillStyle" + }, + " | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, { "parentPluginId": "lens", - "id": "def-public.DateHistogramIndexPatternColumn.operationType", - "type": "string", + "id": "def-public.ExtendedYConfig.iconPosition", + "type": "CompoundType", "tags": [], - "label": "operationType", + "label": "iconPosition", "description": [], "signature": [ - "\"date_histogram\"" + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.IconPosition", + "text": "IconPosition" + }, + " | undefined" ], - "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx", + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "lens", - "id": "def-public.DateHistogramIndexPatternColumn.params", - "type": "Object", + "id": "def-public.ExtendedYConfig.textVisibility", + "type": "CompoundType", "tags": [], - "label": "params", + "label": "textVisibility", "description": [], "signature": [ - "{ interval: string; ignoreTimeRange?: boolean | undefined; includeEmptyRows?: boolean | undefined; dropPartials?: boolean | undefined; }" + "boolean | undefined" ], - "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/date_histogram.tsx", + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false } ], @@ -1033,6 +1812,84 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "lens", + "id": "def-public.IndexPatternLayer", + "type": "Interface", + "tags": [], + "label": "IndexPatternLayer", + "description": [], + "path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.IndexPatternLayer.columnOrder", + "type": "Array", + "tags": [], + "label": "columnOrder", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.IndexPatternLayer.columns", + "type": "Object", + "tags": [], + "label": "columns", + "description": [], + "signature": [ + "{ [x: string]: ", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.GenericIndexPatternColumn", + "text": "GenericIndexPatternColumn" + }, + "; }" + ], + "path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.IndexPatternLayer.indexPatternId", + "type": "string", + "tags": [], + "label": "indexPatternId", + "description": [], + "path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.IndexPatternLayer.incompleteColumns", + "type": "Object", + "tags": [], + "label": "incompleteColumns", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "lens", "id": "def-public.IndexPatternPersistedState", @@ -1052,7 +1909,13 @@ "description": [], "signature": [ "{ [x: string]: Omit<", - "IndexPatternLayer", + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.IndexPatternLayer", + "text": "IndexPatternLayer" + }, ", \"indexPatternId\">; }" ], "path": "x-pack/plugins/lens/public/indexpattern_datasource/types.ts", @@ -1239,8 +2102,7 @@ "\nHorizontal Alignment of the legend when it is set inside chart" ], "signature": [ - "HorizontalAlignment", - " | undefined" + "\"left\" | \"right\" | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -1255,8 +2117,7 @@ "\nVertical Alignment of the legend when it is set inside chart" ], "signature": [ - "VerticalAlignment", - " | undefined" + "\"top\" | \"bottom\" | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -1309,74 +2170,21 @@ { "parentPluginId": "lens", "id": "def-public.LegendConfig.legendSize", - "type": "number", + "type": "CompoundType", "tags": [], "label": "legendSize", "description": [ "\nExact legend width (vertical) or height (horizontal)\nLimited to max of 70% of the chart container dimension Vertical legends limited to min of 30% of computed width" ], "signature": [ - "number | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "lens", - "id": "def-public.LensMultiTable", - "type": "Interface", - "tags": [], - "label": "LensMultiTable", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "lens", - "id": "def-public.LensMultiTable.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"lens_multitable\"" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-public.LensMultiTable.tables", - "type": "Object", - "tags": [], - "label": "tables", - "description": [], - "signature": [ - "{ [x: string]: ", { - "pluginId": "expressions", + "pluginId": "visualizations", "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" + "docId": "kibVisualizationsPluginApi", + "section": "def-common.LegendSize", + "text": "LegendSize" }, - "; }" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-public.LensMultiTable.dateRange", - "type": "Object", - "tags": [], - "label": "dateRange", - "description": [], - "signature": [ - "{ fromDate: Date; toDate: Date; } | undefined" + " | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -2038,6 +2846,9 @@ "tags": [], "label": "layerId", "description": [], + "signature": [ + "string | undefined" + ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, @@ -2079,13 +2890,33 @@ "pluginId": "expressionXY", "scope": "common", "docId": "kibExpressionXYPluginApi", - "section": "def-common.YConfigResult", - "text": "YConfigResult" + "section": "def-common.ExtendedYConfigResult", + "text": "ExtendedYConfigResult" }, "[] | undefined" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.ReferenceLineLayerArgs.table", + "type": "Object", + "tags": [], + "label": "table", + "description": [], + "signature": [ + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + " | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false } ], "initialIsOpen": false @@ -2247,12 +3078,19 @@ { "parentPluginId": "lens", "id": "def-public.SharedPieLayerState.legendSize", - "type": "number", + "type": "CompoundType", "tags": [], "label": "legendSize", "description": [], "signature": [ - "number | undefined" + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.LegendSize", + "text": "LegendSize" + }, + " | undefined" ], "path": "x-pack/plugins/lens/common/types.ts", "deprecated": false @@ -2607,46 +3445,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "lens", - "id": "def-public.ValidLayer", - "type": "Interface", - "tags": [], - "label": "ValidLayer", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.ValidLayer", - "text": "ValidLayer" - }, - " extends ", - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.DataLayerConfigResult", - "text": "DataLayerConfigResult" - } - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "lens", - "id": "def-public.ValidLayer.xAccessor", - "type": "string", - "tags": [], - "label": "xAccessor", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "lens", "id": "def-public.Visualization", @@ -3235,7 +4033,7 @@ "label": "getRemoveOperation", "description": [], "signature": [ - "((state: T, layerId: string) => \"remove\" | \"clear\") | undefined" + "((state: T, layerId: string) => \"clear\" | \"remove\") | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -3416,7 +4214,9 @@ "\nThe frame is telling the visualization to update or set a dimension based on user interaction\ngroupId is coming from the groupId provided in getConfiguration" ], "signature": [ - "(props: VisualizationDimensionChangeProps & { groupId: string; previousColumn?: string | undefined; }) => T" + "(props: ", + "VisualizationDimensionChangeProps", + " & { groupId: string; previousColumn?: string | undefined; }) => T" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -3429,7 +4229,8 @@ "label": "props", "description": [], "signature": [ - "VisualizationDimensionChangeProps & { groupId: string; previousColumn?: string | undefined; }" + "VisualizationDimensionChangeProps", + " & { groupId: string; previousColumn?: string | undefined; }" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -3448,7 +4249,9 @@ "\nThe frame is telling the visualization to remove a dimension. The visualization needs to\nlook at its internal state to determine which dimension is being affected." ], "signature": [ - "(props: VisualizationDimensionChangeProps) => T" + "(props: ", + "VisualizationDimensionChangeProps", + ") => T" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -3461,7 +4264,8 @@ "label": "props", "description": [], "signature": [ - "VisualizationDimensionChangeProps" + "VisualizationDimensionChangeProps", + "" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -3771,7 +4575,9 @@ "signature": [ "(state: T, datasourceLayers: ", "DatasourceLayers", - ", attributes?: Partial<{ title: string; description: string; }> | undefined) => string | ", + ", attributes?: Partial<{ title: string; description: string; }> | undefined, datasourceExpressionsByLayers?: Record | undefined) => string | ", { "pluginId": "expressions", "scope": "common", @@ -3806,21 +4612,37 @@ "label": "datasourceLayers", "description": [], "signature": [ - "DatasourceLayers" + "DatasourceLayers" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "lens", + "id": "def-public.Visualization.toExpression.$3", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "Partial<{ title: string; description: string; }> | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "lens", - "id": "def-public.Visualization.toExpression.$3", + "id": "def-public.Visualization.toExpression.$4", "type": "Object", "tags": [], - "label": "attributes", + "label": "datasourceExpressionsByLayers", "description": [], "signature": [ - "Partial<{ title: string; description: string; }> | undefined" + "Record | undefined" ], "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, @@ -3841,7 +4663,9 @@ "signature": [ "((state: T, datasourceLayers: ", "DatasourceLayers", - ") => string | ", + ", datasourceExpressionsByLayers?: Record | undefined) => string | ", { "pluginId": "expressions", "scope": "common", @@ -3881,6 +4705,22 @@ "path": "x-pack/plugins/lens/public/types.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "lens", + "id": "def-public.Visualization.toPreviewExpression.$3", + "type": "Object", + "tags": [], + "label": "datasourceExpressionsByLayers", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -4208,35 +5048,26 @@ "tags": [], "label": "XYArgs", "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false, - "children": [ + "signature": [ { - "parentPluginId": "lens", - "id": "def-public.XYArgs.title", - "type": "string", - "tags": [], - "label": "title", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.XYArgs", + "text": "XYArgs" }, + " extends ", { - "parentPluginId": "lens", - "id": "def-public.XYArgs.description", - "type": "string", - "tags": [], - "label": "description", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.DataLayerArgs", + "text": "DataLayerArgs" + } + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "children": [ { "parentPluginId": "lens", "id": "def-public.XYArgs.xTitle", @@ -4309,53 +5140,46 @@ }, { "parentPluginId": "lens", - "id": "def-public.XYArgs.legend", + "id": "def-public.XYArgs.yLeftScale", "type": "CompoundType", "tags": [], - "label": "legend", + "label": "yLeftScale", "description": [], "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LegendConfig", - "text": "LegendConfig" - }, - " & { type: \"legendConfig\"; }" + "\"time\" | \"log\" | \"sqrt\" | \"linear\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "lens", - "id": "def-public.XYArgs.valueLabels", + "id": "def-public.XYArgs.yRightScale", "type": "CompoundType", "tags": [], - "label": "valueLabels", + "label": "yRightScale", "description": [], "signature": [ - "\"hide\" | \"inside\" | \"outside\"" + "\"time\" | \"log\" | \"sqrt\" | \"linear\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "lens", - "id": "def-public.XYArgs.layers", - "type": "Array", + "id": "def-public.XYArgs.legend", + "type": "CompoundType", "tags": [], - "label": "layers", + "label": "legend", "description": [], "signature": [ { "pluginId": "expressionXY", "scope": "common", "docId": "kibExpressionXYPluginApi", - "section": "def-common.XYLayerConfigResult", - "text": "XYLayerConfigResult" + "section": "def-common.LegendConfig", + "text": "LegendConfig" }, - "[]" + " & { type: \"legendConfig\"; }" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false @@ -4393,6 +5217,47 @@ "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false }, + { + "parentPluginId": "lens", + "id": "def-public.XYArgs.valueLabels", + "type": "CompoundType", + "tags": [], + "label": "valueLabels", + "description": [], + "signature": [ + "\"show\" | \"hide\"" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYArgs.referenceLines", + "type": "Array", + "tags": [], + "label": "referenceLines", + "description": [], + "signature": [ + "ReferenceLineConfigResult", + "[]" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYArgs.annotationLayers", + "type": "Array", + "tags": [], + "label": "annotationLayers", + "description": [], + "signature": [ + "AnnotationLayerConfigResult", + "[]" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, { "parentPluginId": "lens", "id": "def-public.XYArgs.fittingFunction", @@ -4564,6 +5429,87 @@ ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYArgs.addTimeMarker", + "type": "CompoundType", + "tags": [], + "label": "addTimeMarker", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYArgs.markSizeRatio", + "type": "number", + "tags": [], + "label": "markSizeRatio", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYArgs.minTimeBarInterval", + "type": "string", + "tags": [], + "label": "minTimeBarInterval", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYArgs.splitRowAccessor", + "type": "CompoundType", + "tags": [], + "label": "splitRowAccessor", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.ExpressionValueVisDimension", + "text": "ExpressionValueVisDimension" + }, + " | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYArgs.splitColumnAccessor", + "type": "CompoundType", + "tags": [], + "label": "splitColumnAccessor", + "description": [], + "signature": [ + "string | ", + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.ExpressionValueVisDimension", + "text": "ExpressionValueVisDimension" + }, + " | undefined" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false } ], "initialIsOpen": false @@ -4578,25 +5524,6 @@ "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", "deprecated": false, "children": [ - { - "parentPluginId": "lens", - "id": "def-public.XYChartProps.data", - "type": "Object", - "tags": [], - "label": "data", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LensMultiTable", - "text": "LensMultiTable" - } - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", - "deprecated": false - }, { "parentPluginId": "lens", "id": "def-public.XYChartProps.args", @@ -4605,13 +5532,7 @@ "label": "args", "description": [], "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.XYArgs", - "text": "XYArgs" - } + "XYProps" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_renderers.ts", "deprecated": false @@ -4667,86 +5588,145 @@ }, { "parentPluginId": "lens", - "id": "def-public.XYDataLayerConfig.seriesType", - "type": "CompoundType", + "id": "def-public.XYDataLayerConfig.seriesType", + "type": "CompoundType", + "tags": [], + "label": "seriesType", + "description": [], + "signature": [ + "\"area\" | \"line\" | \"bar\" | \"bar_stacked\" | \"area_stacked\" | \"bar_horizontal\" | \"bar_percentage_stacked\" | \"bar_horizontal_stacked\" | \"area_percentage_stacked\" | \"bar_horizontal_percentage_stacked\"" + ], + "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYDataLayerConfig.xAccessor", + "type": "string", + "tags": [], + "label": "xAccessor", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYDataLayerConfig.hide", + "type": "CompoundType", + "tags": [], + "label": "hide", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYDataLayerConfig.yConfig", + "type": "Array", + "tags": [], + "label": "yConfig", + "description": [], + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.YConfig", + "text": "YConfig" + }, + "[] | undefined" + ], + "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYDataLayerConfig.splitAccessor", + "type": "string", "tags": [], - "label": "seriesType", + "label": "splitAccessor", "description": [], "signature": [ - "\"area\" | \"line\" | \"bar\" | \"bar_stacked\" | \"area_stacked\" | \"bar_horizontal\" | \"bar_percentage_stacked\" | \"bar_horizontal_stacked\" | \"area_percentage_stacked\" | \"bar_horizontal_percentage_stacked\"" + "string | undefined" ], "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "deprecated": false }, { "parentPluginId": "lens", - "id": "def-public.XYDataLayerConfig.xAccessor", - "type": "string", + "id": "def-public.XYDataLayerConfig.palette", + "type": "Object", "tags": [], - "label": "xAccessor", + "label": "palette", "description": [], "signature": [ - "string | undefined" + "PaletteOutput", + "<{ [key: string]: unknown; }> | undefined" ], "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "deprecated": false }, { "parentPluginId": "lens", - "id": "def-public.XYDataLayerConfig.hide", - "type": "CompoundType", + "id": "def-public.XYDataLayerConfig.collapseFn", + "type": "string", "tags": [], - "label": "hide", + "label": "collapseFn", "description": [], "signature": [ - "boolean | undefined" + "string | undefined" ], "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "deprecated": false }, { "parentPluginId": "lens", - "id": "def-public.XYDataLayerConfig.yConfig", - "type": "Array", + "id": "def-public.XYDataLayerConfig.xScaleType", + "type": "CompoundType", "tags": [], - "label": "yConfig", + "label": "xScaleType", "description": [], "signature": [ { "pluginId": "expressionXY", "scope": "common", "docId": "kibExpressionXYPluginApi", - "section": "def-common.YConfig", - "text": "YConfig" + "section": "def-common.XScaleType", + "text": "XScaleType" }, - "[] | undefined" + " | undefined" ], "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "deprecated": false }, { "parentPluginId": "lens", - "id": "def-public.XYDataLayerConfig.splitAccessor", - "type": "string", + "id": "def-public.XYDataLayerConfig.isHistogram", + "type": "CompoundType", "tags": [], - "label": "splitAccessor", + "label": "isHistogram", "description": [], "signature": [ - "string | undefined" + "boolean | undefined" ], "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "deprecated": false }, { "parentPluginId": "lens", - "id": "def-public.XYDataLayerConfig.palette", - "type": "Object", + "id": "def-public.XYDataLayerConfig.columnToLabel", + "type": "string", "tags": [], - "label": "palette", + "label": "columnToLabel", "description": [], "signature": [ - "PaletteOutput", - "<{ [key: string]: unknown; }> | undefined" + "string | undefined" ], "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "deprecated": false @@ -4799,8 +5779,8 @@ "pluginId": "expressionXY", "scope": "common", "docId": "kibExpressionXYPluginApi", - "section": "def-common.YConfig", - "text": "YConfig" + "section": "def-common.ExtendedYConfig", + "text": "ExtendedYConfig" }, "[] | undefined" ], @@ -5095,6 +6075,46 @@ "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "deprecated": false }, + { + "parentPluginId": "lens", + "id": "def-public.XYState.yLeftScale", + "type": "CompoundType", + "tags": [], + "label": "yLeftScale", + "description": [], + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.YScaleType", + "text": "YScaleType" + }, + " | undefined" + ], + "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", + "deprecated": false + }, + { + "parentPluginId": "lens", + "id": "def-public.XYState.yRightScale", + "type": "CompoundType", + "tags": [], + "label": "yRightScale", + "description": [], + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.YScaleType", + "text": "YScaleType" + }, + " | undefined" + ], + "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", + "deprecated": false + }, { "parentPluginId": "lens", "id": "def-public.XYState.axisTitlesVisibilitySettings", @@ -5236,161 +6256,6 @@ } ], "initialIsOpen": false - }, - { - "parentPluginId": "lens", - "id": "def-public.YConfig", - "type": "Interface", - "tags": [], - "label": "YConfig", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "lens", - "id": "def-public.YConfig.forAccessor", - "type": "string", - "tags": [], - "label": "forAccessor", - "description": [], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-public.YConfig.axisMode", - "type": "CompoundType", - "tags": [], - "label": "axisMode", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.YAxisMode", - "text": "YAxisMode" - }, - " | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-public.YConfig.color", - "type": "string", - "tags": [], - "label": "color", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-public.YConfig.icon", - "type": "string", - "tags": [], - "label": "icon", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-public.YConfig.lineWidth", - "type": "number", - "tags": [], - "label": "lineWidth", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-public.YConfig.lineStyle", - "type": "CompoundType", - "tags": [], - "label": "lineStyle", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.LineStyle", - "text": "LineStyle" - }, - " | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-public.YConfig.fill", - "type": "CompoundType", - "tags": [], - "label": "fill", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.FillStyle", - "text": "FillStyle" - }, - " | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-public.YConfig.iconPosition", - "type": "CompoundType", - "tags": [], - "label": "iconPosition", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.IconPosition", - "text": "IconPosition" - }, - " | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-public.YConfig.textVisibility", - "type": "CompoundType", - "tags": [], - "label": "textVisibility", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false - } - ], - "initialIsOpen": false } ], "enums": [], @@ -5533,12 +6398,13 @@ }, { "parentPluginId": "lens", - "id": "def-public.DataLayerConfigResult", + "id": "def-public.DataLayerConfig", "type": "Type", "tags": [], - "label": "DataLayerConfigResult", + "label": "DataLayerConfig", "description": [], "signature": [ + "Omit<", { "pluginId": "expressionXY", "scope": "common", @@ -5546,7 +6412,18 @@ "section": "def-common.DataLayerArgs", "text": "DataLayerArgs" }, - " & { type: \"dataLayer\"; layerType: \"data\"; }" + ", \"palette\"> & { type: \"dataLayer\"; layerType: \"data\"; palette: ", + "PaletteOutput", + "<{ [key: string]: unknown; }>; table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + "; } & ", + "WithLayerId" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, @@ -5616,6 +6493,27 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "lens", + "id": "def-public.ExtendedYConfigResult", + "type": "Type", + "tags": [], + "label": "ExtendedYConfigResult", + "description": [], + "signature": [ + { + "pluginId": "expressionXY", + "scope": "common", + "docId": "kibExpressionXYPluginApi", + "section": "def-common.ExtendedYConfig", + "text": "ExtendedYConfig" + }, + " & { type: \"extendedYConfig\"; }" + ], + "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "lens", "id": "def-public.FillStyle", @@ -5816,21 +6714,41 @@ }, " & { type: \"legendConfig\"; }" ], - "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, + "initialIsOpen": false + }, + { + "parentPluginId": "lens", + "id": "def-public.LensEmbeddableInput", + "type": "Type", + "tags": [], + "label": "LensEmbeddableInput", + "description": [], + "signature": [ + "LensByValueInput", + " | ", + "LensByReferenceInput" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "lens", - "id": "def-public.LensEmbeddableInput", + "id": "def-public.LensSavedObjectAttributes", "type": "Type", "tags": [], - "label": "LensEmbeddableInput", + "label": "LensSavedObjectAttributes", "description": [], "signature": [ - "LensByValueInput", - " | ", - "LensByReferenceInput" + "{ title: string; description?: string | undefined; state: { datasourceStates: Record; visualization: unknown; query: ", + "Query", + "; globalPalette?: { activePaletteId: string; state?: unknown; } | undefined; filters: ", + "Filter", + "[]; }; references: ", + "SavedObjectReference", + "[]; visualizationType: string | null; }" ], "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", "deprecated": false, @@ -6030,10 +6948,10 @@ }, { "parentPluginId": "lens", - "id": "def-public.ReferenceLineLayerConfigResult", + "id": "def-public.ReferenceLineLayerConfig", "type": "Type", "tags": [], - "label": "ReferenceLineLayerConfigResult", + "label": "ReferenceLineLayerConfig", "description": [], "signature": [ { @@ -6043,7 +6961,16 @@ "section": "def-common.ReferenceLineLayerArgs", "text": "ReferenceLineLayerArgs" }, - " & { type: \"referenceLineLayer\"; layerType: \"referenceLine\"; }" + " & { type: \"referenceLineLayer\"; layerType: \"referenceLine\"; table: ", + { + "pluginId": "expressions", + "scope": "common", + "docId": "kibExpressionsPluginApi", + "section": "def-common.Datatable", + "text": "Datatable" + }, + "; } & ", + "WithLayerId" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, @@ -6190,6 +7117,28 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "lens", + "id": "def-public.ValidLayer", + "type": "Type", + "tags": [], + "label": "ValidLayer", + "description": [], + "signature": [ + { + "pluginId": "lens", + "scope": "public", + "docId": "kibLensPluginApi", + "section": "def-public.XYReferenceLineLayerConfig", + "text": "XYReferenceLineLayerConfig" + }, + " | ", + "ValidXYDataLayerConfig" + ], + "path": "x-pack/plugins/lens/public/xy_visualization/types.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "lens", "id": "def-public.ValueLabelConfig", @@ -6198,7 +7147,7 @@ "label": "ValueLabelConfig", "description": [], "signature": [ - "\"hide\" | \"inside\" | \"outside\"" + "\"show\" | \"hide\"" ], "path": "x-pack/plugins/lens/common/types.ts", "deprecated": false, @@ -6212,7 +7161,7 @@ "label": "ValueLabelMode", "description": [], "signature": [ - "\"hide\" | \"inside\" | \"outside\"" + "\"show\" | \"hide\"" ], "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", "deprecated": false, @@ -6296,27 +7245,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "lens", - "id": "def-public.YConfigResult", - "type": "Type", - "tags": [], - "label": "YConfigResult", - "description": [], - "signature": [ - { - "pluginId": "expressionXY", - "scope": "common", - "docId": "kibExpressionXYPluginApi", - "section": "def-common.YConfig", - "text": "YConfig" - }, - " & { type: \"yConfig\"; }" - ], - "path": "src/plugins/chart_expressions/expression_xy/common/types/expression_functions.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "lens", "id": "def-public.YScaleType", @@ -6459,9 +7387,9 @@ ") => { lensEmbeddableFactory: () => ", { "pluginId": "embeddable", - "scope": "server", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-server.EmbeddableRegistryDefinition", + "section": "def-common.EmbeddableRegistryDefinition", "text": "EmbeddableRegistryDefinition" }, "<", @@ -7141,6 +8069,92 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "lens", + "id": "def-server.XYVisualizationState830", + "type": "Interface", + "tags": [], + "label": "XYVisualizationState830", + "description": [], + "signature": [ + { + "pluginId": "lens", + "scope": "server", + "docId": "kibLensPluginApi", + "section": "def-server.XYVisualizationState830", + "text": "XYVisualizationState830" + }, + " extends ", + { + "pluginId": "lens", + "scope": "server", + "docId": "kibLensPluginApi", + "section": "def-server.VisState820", + "text": "VisState820" + } + ], + "path": "x-pack/plugins/lens/server/migrations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-server.XYVisualizationState830.valueLabels", + "type": "CompoundType", + "tags": [], + "label": "valueLabels", + "description": [], + "signature": [ + "\"show\" | \"hide\"" + ], + "path": "x-pack/plugins/lens/server/migrations/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "lens", + "id": "def-server.XYVisualizationStatePre830", + "type": "Interface", + "tags": [], + "label": "XYVisualizationStatePre830", + "description": [], + "signature": [ + { + "pluginId": "lens", + "scope": "server", + "docId": "kibLensPluginApi", + "section": "def-server.XYVisualizationStatePre830", + "text": "XYVisualizationStatePre830" + }, + " extends ", + { + "pluginId": "lens", + "scope": "server", + "docId": "kibLensPluginApi", + "section": "def-server.VisState820", + "text": "VisState820" + } + ], + "path": "x-pack/plugins/lens/server/migrations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-server.XYVisualizationStatePre830.valueLabels", + "type": "CompoundType", + "tags": [], + "label": "valueLabels", + "description": [], + "signature": [ + "\"outside\" | \"hide\" | \"inside\"" + ], + "path": "x-pack/plugins/lens/server/migrations/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false } ], "enums": [], @@ -7301,7 +8315,49 @@ }, ", \"filters\" | \"state\"> & { filters: ", "Filter", - "[]; state: Omit<{ datasourceMetaData: { filterableIndexPatterns: { id: string; title: string; }[]; }; datasourceStates: { indexpattern: { currentIndexPatternId: string; layers: Record>; }>; }; }; visualization: unknown; query: ", + "[]; state: Omit<{ datasourceMetaData: { filterableIndexPatterns: { id: string; title: string; }[]; }; datasourceStates: { indexpattern: { currentIndexPatternId: string; layers: Record>; }>; }; }; visualization: VisualizationState; query: ", + "Query", + "; filters: ", + { + "pluginId": "lens", + "scope": "common", + "docId": "kibLensPluginApi", + "section": "def-common.PersistableFilter", + "text": "PersistableFilter" + }, + "[]; }, \"datasourceStates\"> & { datasourceStates: { indexpattern: Omit<{ currentIndexPatternId: string; layers: Record>; }>; }, \"layers\"> & { layers: Record>; }, \"columns\"> & { columns: Record; }>; }>; }; }; }; }" + ], + "path": "x-pack/plugins/lens/server/migrations/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "lens", + "id": "def-server.LensDocShape830", + "type": "Type", + "tags": [], + "label": "LensDocShape830", + "description": [], + "signature": [ + "Omit<", + { + "pluginId": "lens", + "scope": "server", + "docId": "kibLensPluginApi", + "section": "def-server.LensDocShape715", + "text": "LensDocShape715" + }, + ", \"filters\" | \"state\"> & { filters: ", + "Filter", + "[]; state: Omit<{ datasourceMetaData: { filterableIndexPatterns: { id: string; title: string; }[]; }; datasourceStates: { indexpattern: { currentIndexPatternId: string; layers: Record>; }>; }; }; visualization: VisualizationState; query: ", "Query", "; filters: ", { @@ -7375,6 +8431,26 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "lens", + "id": "def-server.VisState830", + "type": "Type", + "tags": [], + "label": "VisState830", + "description": [], + "signature": [ + { + "pluginId": "lens", + "scope": "server", + "docId": "kibLensPluginApi", + "section": "def-server.XYVisualizationState830", + "text": "XYVisualizationState830" + } + ], + "path": "x-pack/plugins/lens/server/migrations/types.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "lens", "id": "def-server.VisStatePost715", @@ -7402,6 +8478,26 @@ "path": "x-pack/plugins/lens/server/migrations/types.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "lens", + "id": "def-server.VisStatePre830", + "type": "Type", + "tags": [], + "label": "VisStatePre830", + "description": [], + "signature": [ + { + "pluginId": "lens", + "scope": "server", + "docId": "kibLensPluginApi", + "section": "def-server.XYVisualizationStatePre830", + "text": "XYVisualizationStatePre830" + } + ], + "path": "x-pack/plugins/lens/server/migrations/types.ts", + "deprecated": false, + "initialIsOpen": false } ], "objects": [], @@ -7428,9 +8524,9 @@ "() => ", { "pluginId": "embeddable", - "scope": "server", + "scope": "common", "docId": "kibEmbeddablePluginApi", - "section": "def-server.EmbeddableRegistryDefinition", + "section": "def-common.EmbeddableRegistryDefinition", "text": "EmbeddableRegistryDefinition" }, "<", @@ -7833,66 +8929,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "lens", - "id": "def-common.LensMultiTable", - "type": "Interface", - "tags": [], - "label": "LensMultiTable", - "description": [], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "lens", - "id": "def-common.LensMultiTable.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"lens_multitable\"" - ], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-common.LensMultiTable.tables", - "type": "Object", - "tags": [], - "label": "tables", - "description": [], - "signature": [ - "{ [x: string]: ", - { - "pluginId": "expressions", - "scope": "common", - "docId": "kibExpressionsPluginApi", - "section": "def-common.Datatable", - "text": "Datatable" - }, - "; }" - ], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "lens", - "id": "def-common.LensMultiTable.dateRange", - "type": "Object", - "tags": [], - "label": "dateRange", - "description": [], - "signature": [ - "{ fromDate: Date; toDate: Date; } | undefined" - ], - "path": "x-pack/plugins/lens/common/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "lens", "id": "def-common.MetricState", @@ -8377,12 +9413,19 @@ { "parentPluginId": "lens", "id": "def-common.SharedPieLayerState.legendSize", - "type": "number", + "type": "CompoundType", "tags": [], "label": "legendSize", "description": [], "signature": [ - "number | undefined" + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.LegendSize", + "text": "LegendSize" + }, + " | undefined" ], "path": "x-pack/plugins/lens/common/types.ts", "deprecated": false @@ -8777,7 +9820,7 @@ "label": "ValueLabelConfig", "description": [], "signature": [ - "\"hide\" | \"inside\" | \"outside\"" + "\"show\" | \"hide\"" ], "path": "x-pack/plugins/lens/common/types.ts", "deprecated": false, diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index 13b19ffe60e56..775282a3cc6b1 100644 --- a/api_docs/lens.mdx +++ b/api_docs/lens.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lens title: "lens" image: https://source.unsplash.com/400x175/?github summary: API docs for the lens plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,13 +18,16 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 527 | 0 | 452 | 30 | +| 574 | 0 | 497 | 35 | ## Client ### Objects +### Classes + + ### Interfaces diff --git a/api_docs/license_api_guard.devdocs.json b/api_docs/license_api_guard.devdocs.json index 06339738fe611..ea6f7bcd81800 100644 --- a/api_docs/license_api_guard.devdocs.json +++ b/api_docs/license_api_guard.devdocs.json @@ -104,7 +104,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | { message: string | Error; attributes?: ", + " | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -112,9 +114,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -223,6 +223,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -230,11 +232,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -254,9 +254,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -266,9 +266,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -278,9 +278,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -298,7 +298,9 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", response: { custom: | Error | { message: string | Error; attributes?: ", + ", response: { custom: | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -306,9 +308,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -417,6 +417,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -424,11 +426,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -448,9 +448,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -460,9 +460,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -472,9 +472,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -520,7 +520,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | { message: string | Error; attributes?: ", + " | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -528,9 +530,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -639,6 +639,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -646,11 +648,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -670,9 +670,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -682,9 +682,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -694,9 +694,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index 875d654c0267b..2cdf9aee5ef7c 100644 --- a/api_docs/license_api_guard.mdx +++ b/api_docs/license_api_guard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseApiGuard title: "licenseApiGuard" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseApiGuard plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseApiGuard'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/license_management.mdx b/api_docs/license_management.mdx index d81ae2975260d..aca09e5bba03f 100644 --- a/api_docs/license_management.mdx +++ b/api_docs/license_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseManagement title: "licenseManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseManagement plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/licensing.devdocs.json b/api_docs/licensing.devdocs.json index 264859dfa2e6a..8839d4fac6465 100644 --- a/api_docs/licensing.devdocs.json +++ b/api_docs/licensing.devdocs.json @@ -911,7 +911,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | { message: string | Error; attributes?: ", + " | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -919,9 +921,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -1030,6 +1030,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -1037,11 +1039,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -1061,9 +1061,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -1073,9 +1073,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -1085,9 +1085,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -1105,7 +1105,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | { message: string | Error; attributes?: ", + " | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -1113,9 +1115,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -1224,6 +1224,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -1231,11 +1233,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -1255,9 +1255,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -1267,9 +1267,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -1279,9 +1279,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", @@ -1331,7 +1331,9 @@ "section": "def-server.RequestHandler", "text": "RequestHandler" }, - " | Error | { message: string | Error; attributes?: ", + " | Error | ", + "Stream", + " | { message: string | Error; attributes?: ", { "pluginId": "core", "scope": "server", @@ -1339,9 +1341,7 @@ "section": "def-server.ResponseErrorAttributes", "text": "ResponseErrorAttributes" }, - " | undefined; } | Buffer | ", - "Stream", - " | undefined>(options: ", + " | undefined; } | Buffer | undefined>(options: ", { "pluginId": "core", "scope": "server", @@ -1450,6 +1450,8 @@ "text": "CustomHttpResponseOptions" }, "<", + "Stream", + " | ", { "pluginId": "core", "scope": "server", @@ -1457,11 +1459,11 @@ "section": "def-server.ResponseError", "text": "ResponseError" }, - " | Buffer | ", - "Stream", - ">) => ", + " | Buffer>) => ", "KibanaResponse", - "; redirected: (options: ", + " | undefined; } | Buffer>; redirected: (options: ", { "pluginId": "core", "scope": "server", @@ -1481,9 +1481,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; ok: (options?: ", + " | Buffer>; ok: (options?: ", { "pluginId": "core", "scope": "server", @@ -1493,9 +1493,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; accepted: (options?: ", + " | Buffer>; accepted: (options?: ", { "pluginId": "core", "scope": "server", @@ -1505,9 +1505,9 @@ }, ") => ", "KibanaResponse", - " | Buffer | ", + " | ", "Stream", - ">; noContent: (options?: ", + " | Buffer>; noContent: (options?: ", { "pluginId": "core", "scope": "server", diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index cb395af82c70a..1d642ed33498f 100644 --- a/api_docs/licensing.mdx +++ b/api_docs/licensing.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licensing title: "licensing" image: https://source.unsplash.com/400x175/?github summary: API docs for the licensing plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index d41261a0cd841..87a2b53d3c964 100644 --- a/api_docs/lists.mdx +++ b/api_docs/lists.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lists title: "lists" image: https://source.unsplash.com/400x175/?github summary: API docs for the lists plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/management.mdx b/api_docs/management.mdx index 30294c621c92c..0c62b6c8f41e2 100644 --- a/api_docs/management.mdx +++ b/api_docs/management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/management title: "management" image: https://source.unsplash.com/400x175/?github summary: API docs for the management plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/maps.devdocs.json b/api_docs/maps.devdocs.json index 63493ac786c58..98ffef54afa78 100644 --- a/api_docs/maps.devdocs.json +++ b/api_docs/maps.devdocs.json @@ -1168,6 +1168,16 @@ "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx", "deprecated": false }, + { + "parentPluginId": "maps", + "id": "def-public.BoundsRequestMeta.isFeatureEditorOpenForLayer", + "type": "boolean", + "tags": [], + "label": "isFeatureEditorOpenForLayer", + "description": [], + "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx", + "deprecated": false + }, { "parentPluginId": "maps", "id": "def-public.BoundsRequestMeta.joinKeyFilter", @@ -1473,7 +1483,9 @@ "label": "getExtendedStatsFieldMetaRequest", "description": [], "signature": [ - "() => Promise" + "() => Promise | null>" ], "path": "x-pack/plugins/maps/public/classes/fields/field.ts", "deprecated": false, @@ -1488,7 +1500,9 @@ "label": "getPercentilesFieldMetaRequest", "description": [], "signature": [ - "(percentiles: number[]) => Promise" + "(percentiles: number[]) => Promise | null>" ], "path": "x-pack/plugins/maps/public/classes/fields/field.ts", "deprecated": false, @@ -1518,7 +1532,9 @@ "label": "getCategoricalFieldMetaRequest", "description": [], "signature": [ - "(size: number) => Promise" + "(size: number) => Promise | null>" ], "path": "x-pack/plugins/maps/public/classes/fields/field.ts", "deprecated": false, @@ -1919,7 +1935,15 @@ "section": "def-common.VectorSourceRequestMeta", "text": "VectorSourceRequestMeta" }, - ", registerCancelCallback: (callback: () => void) => void, isRequestStillActive: () => boolean) => Promise<", + ", registerCancelCallback: (callback: () => void) => void, isRequestStillActive: () => boolean, inspectorAdapters: ", + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + }, + ") => Promise<", { "pluginId": "maps", "scope": "public", @@ -1993,6 +2017,26 @@ "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "maps", + "id": "def-public.IVectorSource.getGeoJsonWithMeta.$5", + "type": "Object", + "tags": [], + "label": "inspectorAdapters", + "description": [], + "signature": [ + { + "pluginId": "inspector", + "scope": "common", + "docId": "kibInspectorPluginApi", + "section": "def-common.Adapters", + "text": "Adapters" + } + ], + "path": "x-pack/plugins/maps/public/classes/sources/vector_source/vector_source.tsx", + "deprecated": false, + "isRequired": true } ], "returnComment": [] @@ -3543,7 +3587,7 @@ "TileMetaFeature", "[] | undefined; alpha?: number | undefined; attribution?: ", "Attribution", - " | undefined; id: string; label?: string | null | undefined; areLabelsOnTop?: boolean | undefined; minZoom?: number | undefined; maxZoom?: number | undefined; sourceDescriptor: ", + " | undefined; id: string; label?: string | null | undefined; locale?: string | null | undefined; areLabelsOnTop?: boolean | undefined; minZoom?: number | undefined; maxZoom?: number | undefined; sourceDescriptor: ", "AbstractSourceDescriptor", " | null; type?: string | undefined; visible?: boolean | undefined; style?: ", "StyleDescriptor", @@ -3679,7 +3723,7 @@ "DataFilters", " & { applyGlobalQuery: boolean; applyGlobalTime: boolean; applyForceRefresh: boolean; fieldNames: string[]; geogridPrecision?: number | undefined; timesliceMaskField?: string | undefined; sourceQuery?: ", "Query", - " | undefined; sourceMeta: object | null; isForceRefresh: boolean; }" + " | undefined; sourceMeta: object | null; isForceRefresh: boolean; isFeatureEditorOpenForLayer: boolean; }" ], "path": "x-pack/plugins/maps/common/descriptor_types/data_request_descriptor_types.ts", "deprecated": false, diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index 980ecd53f8ee9..70c0c168266f3 100644 --- a/api_docs/maps.mdx +++ b/api_docs/maps.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/maps title: "maps" image: https://source.unsplash.com/400x175/?github summary: API docs for the maps plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [GIS](https://github.com/orgs/elastic/teams/kibana-gis) for questions re | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 224 | 0 | 223 | 25 | +| 226 | 0 | 225 | 25 | ## Client diff --git a/api_docs/maps_ems.devdocs.json b/api_docs/maps_ems.devdocs.json index 0649ee441acdf..5b2e9c6e99c00 100644 --- a/api_docs/maps_ems.devdocs.json +++ b/api_docs/maps_ems.devdocs.json @@ -953,7 +953,7 @@ "label": "DEFAULT_EMS_LANDING_PAGE_URL", "description": [], "signature": [ - "\"https://maps.elastic.co/v8.2\"" + "\"https://maps.elastic.co/v8.3\"" ], "path": "src/plugins/maps_ems/common/ems_defaults.ts", "deprecated": false, diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index 5fc5483e9d64c..eb70963bb6e73 100644 --- a/api_docs/maps_ems.mdx +++ b/api_docs/maps_ems.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/mapsEms title: "mapsEms" image: https://source.unsplash.com/400x175/?github summary: API docs for the mapsEms plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ml.devdocs.json b/api_docs/ml.devdocs.json index bfcdfea604043..4eca0b6ef73f7 100644 --- a/api_docs/ml.devdocs.json +++ b/api_docs/ml.devdocs.json @@ -587,6 +587,21 @@ ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-public.AnomaliesTableRecord.isGeoRecord", + "type": "CompoundType", + "tags": [], + "label": "isGeoRecord", + "description": [ + "\nReturns true if the anomaly record represented by the table row can be shown in the maps plugin" + ], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomalies.ts", + "deprecated": false } ], "initialIsOpen": false @@ -804,7 +819,7 @@ "label": "capabilities", "description": [], "signature": [ - "{ canAccessML: boolean; canGetJobs: boolean; canGetDatafeeds: boolean; canGetCalendars: boolean; canFindFileStructure: boolean; canGetDataFrameAnalytics: boolean; canGetAnnotations: boolean; canCreateAnnotation: boolean; canDeleteAnnotation: boolean; canUseMlAlerts: boolean; canGetTrainedModels: boolean; } & { canCreateJob: boolean; canDeleteJob: boolean; canOpenJob: boolean; canCloseJob: boolean; canResetJob: boolean; canUpdateJob: boolean; canForecastJob: boolean; canCreateDatafeed: boolean; canDeleteDatafeed: boolean; canStartStopDatafeed: boolean; canUpdateDatafeed: boolean; canPreviewDatafeed: boolean; canGetFilters: boolean; canCreateCalendar: boolean; canDeleteCalendar: boolean; canCreateFilter: boolean; canDeleteFilter: boolean; canCreateDataFrameAnalytics: boolean; canDeleteDataFrameAnalytics: boolean; canStartStopDataFrameAnalytics: boolean; canCreateMlAlerts: boolean; canUseMlAlerts: boolean; canViewMlNodes: boolean; canCreateTrainedModels: boolean; canDeleteTrainedModels: boolean; canStartStopTrainedModels: boolean; }" + "{ canAccessML: boolean; canGetJobs: boolean; canGetDatafeeds: boolean; canGetCalendars: boolean; canFindFileStructure: boolean; canGetDataFrameAnalytics: boolean; canGetAnnotations: boolean; canCreateAnnotation: boolean; canDeleteAnnotation: boolean; canUseMlAlerts: boolean; canGetTrainedModels: boolean; canTestTrainedModels: boolean; } & { canCreateJob: boolean; canDeleteJob: boolean; canOpenJob: boolean; canCloseJob: boolean; canResetJob: boolean; canUpdateJob: boolean; canForecastJob: boolean; canCreateDatafeed: boolean; canDeleteDatafeed: boolean; canStartStopDatafeed: boolean; canUpdateDatafeed: boolean; canPreviewDatafeed: boolean; canGetFilters: boolean; canCreateCalendar: boolean; canDeleteCalendar: boolean; canCreateFilter: boolean; canDeleteFilter: boolean; canCreateDataFrameAnalytics: boolean; canDeleteDataFrameAnalytics: boolean; canStartStopDataFrameAnalytics: boolean; canCreateMlAlerts: boolean; canUseMlAlerts: boolean; canViewMlNodes: boolean; canCreateTrainedModels: boolean; canDeleteTrainedModels: boolean; canStartStopTrainedModels: boolean; }" ], "path": "x-pack/plugins/ml/common/types/capabilities.ts", "deprecated": false @@ -926,12 +941,17 @@ { "parentPluginId": "ml", "id": "def-public.MlSummaryJob.jobState", - "type": "string", + "type": "CompoundType", "tags": [], "label": "jobState", "description": [ "\nThe status of the job." ], + "signature": [ + "MlJobState", + " | ", + "JobActionState" + ], "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false }, @@ -1478,7 +1498,7 @@ "label": "ML_PAGES", "description": [], "signature": [ - "{ readonly ANOMALY_DETECTION_JOBS_MANAGE: \"jobs\"; readonly ANOMALY_EXPLORER: \"explorer\"; readonly SINGLE_METRIC_VIEWER: \"timeseriesexplorer\"; readonly DATA_FRAME_ANALYTICS_JOBS_MANAGE: \"data_frame_analytics\"; readonly DATA_FRAME_ANALYTICS_SOURCE_SELECTION: \"data_frame_analytics/source_selection\"; readonly DATA_FRAME_ANALYTICS_CREATE_JOB: \"data_frame_analytics/new_job\"; readonly TRAINED_MODELS_MANAGE: \"trained_models\"; readonly TRAINED_MODELS_NODES: \"trained_models/nodes\"; readonly DATA_FRAME_ANALYTICS_EXPLORATION: \"data_frame_analytics/exploration\"; readonly DATA_FRAME_ANALYTICS_MAP: \"data_frame_analytics/map\"; readonly DATA_VISUALIZER: \"datavisualizer\"; readonly DATA_VISUALIZER_INDEX_SELECT: \"datavisualizer_index_select\"; readonly DATA_VISUALIZER_FILE: \"filedatavisualizer\"; readonly DATA_VISUALIZER_INDEX_VIEWER: \"jobs/new_job/datavisualizer\"; readonly ANOMALY_DETECTION_CREATE_JOB: \"jobs/new_job\"; readonly ANOMALY_DETECTION_CREATE_JOB_ADVANCED: \"jobs/new_job/advanced\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_TYPE: \"jobs/new_job/step/job_type\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_INDEX: \"jobs/new_job/step/index_or_search\"; readonly SETTINGS: \"settings\"; readonly CALENDARS_MANAGE: \"settings/calendars_list\"; readonly CALENDARS_NEW: \"settings/calendars_list/new_calendar\"; readonly CALENDARS_EDIT: \"settings/calendars_list/edit_calendar\"; readonly FILTER_LISTS_MANAGE: \"settings/filter_lists\"; readonly FILTER_LISTS_NEW: \"settings/filter_lists/new_filter_list\"; readonly FILTER_LISTS_EDIT: \"settings/filter_lists/edit_filter_list\"; readonly ACCESS_DENIED: \"access-denied\"; readonly OVERVIEW: \"overview\"; }" + "{ readonly ANOMALY_DETECTION_JOBS_MANAGE: \"jobs\"; readonly ANOMALY_EXPLORER: \"explorer\"; readonly SINGLE_METRIC_VIEWER: \"timeseriesexplorer\"; readonly DATA_FRAME_ANALYTICS_JOBS_MANAGE: \"data_frame_analytics\"; readonly DATA_FRAME_ANALYTICS_SOURCE_SELECTION: \"data_frame_analytics/source_selection\"; readonly DATA_FRAME_ANALYTICS_CREATE_JOB: \"data_frame_analytics/new_job\"; readonly TRAINED_MODELS_MANAGE: \"trained_models\"; readonly TRAINED_MODELS_NODES: \"trained_models/nodes\"; readonly DATA_FRAME_ANALYTICS_EXPLORATION: \"data_frame_analytics/exploration\"; readonly DATA_FRAME_ANALYTICS_MAP: \"data_frame_analytics/map\"; readonly DATA_VISUALIZER: \"datavisualizer\"; readonly DATA_VISUALIZER_INDEX_SELECT: \"datavisualizer_index_select\"; readonly DATA_VISUALIZER_FILE: \"filedatavisualizer\"; readonly DATA_VISUALIZER_INDEX_VIEWER: \"jobs/new_job/datavisualizer\"; readonly ANOMALY_DETECTION_CREATE_JOB: \"jobs/new_job\"; readonly ANOMALY_DETECTION_CREATE_JOB_RECOGNIZER: \"jobs/new_job/recognize\"; readonly ANOMALY_DETECTION_CREATE_JOB_ADVANCED: \"jobs/new_job/advanced\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_TYPE: \"jobs/new_job/step/job_type\"; readonly ANOMALY_DETECTION_CREATE_JOB_SELECT_INDEX: \"jobs/new_job/step/index_or_search\"; readonly ANOMALY_DETECTION_CREATE_JOB_FROM_LENS: \"jobs/new_job/from_lens\"; readonly SETTINGS: \"settings\"; readonly CALENDARS_MANAGE: \"settings/calendars_list\"; readonly CALENDARS_NEW: \"settings/calendars_list/new_calendar\"; readonly CALENDARS_EDIT: \"settings/calendars_list/edit_calendar\"; readonly FILTER_LISTS_MANAGE: \"settings/filter_lists\"; readonly FILTER_LISTS_NEW: \"settings/filter_lists/new_filter_list\"; readonly FILTER_LISTS_EDIT: \"settings/filter_lists/edit_filter_list\"; readonly ACCESS_DENIED: \"access-denied\"; readonly OVERVIEW: \"overview\"; readonly AIOPS: \"aiops\"; readonly AIOPS_EXPLAIN_LOG_RATE_SPIKES: \"aiops/explain_log_rate_spikes\"; readonly AIOPS_EXPLAIN_LOG_RATE_SPIKES_INDEX_SELECT: \"aiops/explain_log_rate_spikes_index_select\"; }" ], "path": "x-pack/plugins/ml/common/constants/locator.ts", "deprecated": false, @@ -2026,6 +2046,21 @@ ], "path": "x-pack/plugins/ml/common/types/anomalies.ts", "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.AnomaliesTableRecord.isGeoRecord", + "type": "CompoundType", + "tags": [], + "label": "isGeoRecord", + "description": [ + "\nReturns true if the anomaly record represented by the table row can be shown in the maps plugin" + ], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomalies.ts", + "deprecated": false } ], "initialIsOpen": false @@ -2372,226 +2407,672 @@ } ], "initialIsOpen": false - } - ], - "enums": [], - "misc": [ - { - "parentPluginId": "ml", - "id": "def-server.AnomalyResultType", - "type": "Type", - "tags": [], - "label": "AnomalyResultType", - "description": [ - "\nThe type of the anomaly result, such as bucket, influencer or record." - ], - "signature": [ - "\"bucket\" | \"record\" | \"influencer\"" - ], - "path": "x-pack/plugins/ml/common/types/anomalies.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "ml", - "id": "def-server.DatafeedStats", - "type": "Type", - "tags": [], - "label": "DatafeedStats", - "description": [], - "signature": [ - "MlDatafeedStats" - ], - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed_stats.ts", - "deprecated": false, - "initialIsOpen": false }, { "parentPluginId": "ml", - "id": "def-server.Job", - "type": "Type", - "tags": [], - "label": "Job", - "description": [], - "signature": [ - "MlJob" - ], - "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [], - "setup": { - "parentPluginId": "ml", - "id": "def-server.MlPluginSetup", - "type": "Type", - "tags": [], - "label": "MlPluginSetup", - "description": [], - "signature": [ - "JobServiceProvider", - " & ", - "AnomalyDetectorsProvider", - " & ", - "MlSystemProvider", - " & ", - "ModulesProvider", - " & ", - "ResultsServiceProvider", - " & { alertingServiceProvider(savedObjectsClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ", request: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreHttpPluginApi", - "section": "def-server.KibanaRequest", - "text": "KibanaRequest" - }, - "): { preview: (args_0: Readonly<{} & { timeRange: string; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; sampleSize: number; }>) => Promise; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>, startedAt: Date, previousStartedAt: Date | null) => Promise<", - "AnomalyDetectionAlertContext", - " | undefined>; }; }" - ], - "path": "x-pack/plugins/ml/server/plugin.ts", - "deprecated": false, - "lifecycle": "setup", - "initialIsOpen": true - }, - "start": { - "parentPluginId": "ml", - "id": "def-server.MlPluginStart", - "type": "Type", - "tags": [], - "label": "MlPluginStart", - "description": [], - "signature": [ - "void" - ], - "path": "x-pack/plugins/ml/server/plugin.ts", - "deprecated": false, - "lifecycle": "start", - "initialIsOpen": true - } - }, - "common": { - "classes": [], - "functions": [ - { - "parentPluginId": "ml", - "id": "def-common.composeValidators", - "type": "Function", + "id": "def-server.MlSummaryJob", + "type": "Interface", "tags": [], - "label": "composeValidators", + "label": "MlSummaryJob", "description": [ - "\nComposes multiple validators into a single function" - ], - "signature": [ - "(validators: ((value: any) => { [key: string]: any; } | null)[]) => (value: any) => { [key: string]: any; } | null" + "\nA summary of an anomaly detection job." ], - "path": "x-pack/plugins/ml/common/util/validators.ts", + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", "deprecated": false, "children": [ { "parentPluginId": "ml", - "id": "def-common.composeValidators.$1", - "type": "Array", + "id": "def-server.MlSummaryJob.id", + "type": "string", "tags": [], - "label": "validators", - "description": [], - "signature": [ - "((value: any) => { [key: string]: any; } | null)[]" + "label": "id", + "description": [ + "\nThe identifier for the anomaly detection job." ], - "path": "x-pack/plugins/ml/common/util/validators.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "ml", - "id": "def-common.extractErrorMessage", - "type": "Function", - "tags": [], - "label": "extractErrorMessage", - "description": [], - "signature": [ - "(error: ", - "ErrorType", - ") => string" - ], - "path": "x-pack/plugins/ml/common/util/errors/process_errors.ts", - "deprecated": false, - "children": [ + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, { "parentPluginId": "ml", - "id": "def-common.extractErrorMessage.$1", - "type": "CompoundType", + "id": "def-server.MlSummaryJob.description", + "type": "string", "tags": [], - "label": "error", - "description": [], + "label": "description", + "description": [ + "\nA description of the job." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.groups", + "type": "Array", + "tags": [], + "label": "groups", + "description": [ + "\nA list of job groups. A job can belong to no groups, one or many." + ], "signature": [ - "ErrorType" + "string[]" ], - "path": "x-pack/plugins/ml/common/util/errors/process_errors.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "ml", - "id": "def-common.getDefaultCapabilities", - "type": "Function", - "tags": [], - "label": "getDefaultCapabilities", - "description": [], - "signature": [ - "() => ", - "MlCapabilities" - ], - "path": "x-pack/plugins/ml/common/types/capabilities.ts", - "deprecated": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "ml", - "id": "def-common.getSeverityColor", - "type": "Function", - "tags": [], - "label": "getSeverityColor", - "description": [ - "\nReturns a severity RGB color (one of critical, major, minor, warning, low or blank)\nfor the supplied normalized anomaly score (a value between 0 and 100)." - ], - "signature": [ - "(normalizedScore: number) => string" - ], - "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", - "deprecated": false, - "children": [ + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, { "parentPluginId": "ml", - "id": "def-common.getSeverityColor.$1", + "id": "def-server.MlSummaryJob.processed_record_count", "type": "number", "tags": [], - "label": "normalizedScore", + "label": "processed_record_count", "description": [ - "- A normalized score between 0-100, which is based on the probability of the anomalousness of this record" + "\nThe number of input documents that have been processed by the anomaly detection job.\nThis value includes documents with missing fields, since they are nonetheless analyzed." ], "signature": [ - "number" + "number | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.memory_status", + "type": "string", + "tags": [], + "label": "memory_status", + "description": [ + "\nThe status of the mathematical models, which can take the values ok, soft_limit or hard_limit." + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.jobState", + "type": "CompoundType", + "tags": [], + "label": "jobState", + "description": [ + "\nThe status of the job." + ], + "signature": [ + "MlJobState", + " | ", + "JobActionState" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.datafeedIndices", + "type": "Array", + "tags": [], + "label": "datafeedIndices", + "description": [ + "\nAn array of index names used by the datafeed. Wildcards are supported." + ], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.hasDatafeed", + "type": "boolean", + "tags": [], + "label": "hasDatafeed", + "description": [ + "\nFlag indicating whether a datafeed exists for the job." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.datafeedId", + "type": "string", + "tags": [], + "label": "datafeedId", + "description": [ + "\nThe identifier for the datafeed." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.datafeedState", + "type": "string", + "tags": [], + "label": "datafeedState", + "description": [ + "\nThe status of the datafeed." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.latestTimestampMs", + "type": "number", + "tags": [], + "label": "latestTimestampMs", + "description": [ + "\nThe timestamp of the latest chronologically input document." + ], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.earliestTimestampMs", + "type": "number", + "tags": [], + "label": "earliestTimestampMs", + "description": [ + "\nThe timestamp of the earliest chronologically input document." + ], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.latestResultsTimestampMs", + "type": "number", + "tags": [], + "label": "latestResultsTimestampMs", + "description": [ + "\nThe latest of the timestamp of the latest chronologically input document or the latest bucket that was processed." + ], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.fullJob", + "type": "Object", + "tags": [], + "label": "fullJob", + "description": [ + "\nUsed in older implementations of the job config, where the datafeed was placed inside the job for convenience.\nThis will be populated if the job's id has been passed to the /api/ml/jobs/jobs_summary endpoint." + ], + "signature": [ + "CombinedJob", + " | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.nodeName", + "type": "string", + "tags": [], + "label": "nodeName", + "description": [ + "\nThe name of the node that runs the job." + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.auditMessage", + "type": "Object", + "tags": [], + "label": "auditMessage", + "description": [ + "\nAudit message for the job." + ], + "signature": [ + "Partial<", + "AuditMessage", + "> | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.isSingleMetricViewerJob", + "type": "boolean", + "tags": [], + "label": "isSingleMetricViewerJob", + "description": [ + "\nFlag indicating whether results of the job can be viewed in the Single Metric Viewer." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.isNotSingleMetricViewerJobMessage", + "type": "string", + "tags": [], + "label": "isNotSingleMetricViewerJobMessage", + "description": [ + "\nFor jobs which cannot be viewed in the Single Metric Viewer, a message indicating the reason why\nresults for the job cannot be viewed in the Single Metric Viewer." + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.blocked", + "type": "Object", + "tags": [], + "label": "blocked", + "description": [ + "\nWhen present, it explains that a task is currently running on the job, which is stopping\nany other actions from being performed on the job." + ], + "signature": [ + "MlJobBlocked", + " | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.latestTimestampSortValue", + "type": "number", + "tags": [], + "label": "latestTimestampSortValue", + "description": [ + "\nValue of the latest timestamp for the job used for sorting." + ], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.earliestStartTimestampMs", + "type": "number", + "tags": [], + "label": "earliestStartTimestampMs", + "description": [ + "\nThe earlist of the timestamp of the earliest chronologically input document or the earliest bucket that was processed." + ], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.awaitingNodeAssignment", + "type": "boolean", + "tags": [], + "label": "awaitingNodeAssignment", + "description": [ + "\nIndicates whether the job is currently awaiting assignment to a node before opening." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.alertingRules", + "type": "Array", + "tags": [], + "label": "alertingRules", + "description": [ + "\nList of anomaly detection alerting rules configured for the job." + ], + "signature": [ + "MlAnomalyDetectionAlertRule", + "[] | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.jobTags", + "type": "Object", + "tags": [], + "label": "jobTags", + "description": [ + "\nList of tags that have been added to the job." + ], + "signature": [ + "{ [x: string]: string; }" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.bucketSpanSeconds", + "type": "number", + "tags": [], + "label": "bucketSpanSeconds", + "description": [ + "\nThe size of the interval that the analysis is aggregated into, typically between 5m and 1h." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-server.MlSummaryJob.customSettings", + "type": "Any", + "tags": [], + "label": "customSettings", + "description": [ + "\nAdvanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information." + ], + "signature": [ + "any" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "ml", + "id": "def-server.AnomalyResultType", + "type": "Type", + "tags": [], + "label": "AnomalyResultType", + "description": [ + "\nThe type of the anomaly result, such as bucket, influencer or record." + ], + "signature": [ + "\"bucket\" | \"record\" | \"influencer\"" + ], + "path": "x-pack/plugins/ml/common/types/anomalies.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "ml", + "id": "def-server.DatafeedStats", + "type": "Type", + "tags": [], + "label": "DatafeedStats", + "description": [], + "signature": [ + "MlDatafeedStats" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed_stats.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "ml", + "id": "def-server.Job", + "type": "Type", + "tags": [], + "label": "Job", + "description": [], + "signature": [ + "MlJob" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/job.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "ml", + "id": "def-server.SummaryJobState", + "type": "Type", + "tags": [], + "label": "SummaryJobState", + "description": [], + "signature": [ + "MlJobState", + " | ", + "JobActionState" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [], + "setup": { + "parentPluginId": "ml", + "id": "def-server.MlPluginSetup", + "type": "Type", + "tags": [], + "label": "MlPluginSetup", + "description": [], + "signature": [ + "JobServiceProvider", + " & ", + "AnomalyDetectorsProvider", + " & ", + "MlSystemProvider", + " & ", + "ModulesProvider", + " & ", + "ResultsServiceProvider", + " & { alertingServiceProvider(savedObjectsClient: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientContract", + "text": "SavedObjectsClientContract" + }, + ", request: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "): { preview: (args_0: Readonly<{} & { timeRange: string; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; sampleSize: number; }>) => Promise; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>) => Promise<{ context: ", + "AnomalyDetectionAlertContext", + "; name: string; isHealthy: boolean; } | undefined>; }; }" + ], + "path": "x-pack/plugins/ml/server/plugin.ts", + "deprecated": false, + "lifecycle": "setup", + "initialIsOpen": true + }, + "start": { + "parentPluginId": "ml", + "id": "def-server.MlPluginStart", + "type": "Type", + "tags": [], + "label": "MlPluginStart", + "description": [], + "signature": [ + "void" + ], + "path": "x-pack/plugins/ml/server/plugin.ts", + "deprecated": false, + "lifecycle": "start", + "initialIsOpen": true + } + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "ml", + "id": "def-common.composeValidators", + "type": "Function", + "tags": [], + "label": "composeValidators", + "description": [ + "\nComposes multiple validators into a single function" + ], + "signature": [ + "(validators: ((value: any) => { [key: string]: any; } | null)[]) => (value: any) => { [key: string]: any; } | null" + ], + "path": "x-pack/plugins/ml/common/util/validators.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "ml", + "id": "def-common.composeValidators.$1", + "type": "Array", + "tags": [], + "label": "validators", + "description": [], + "signature": [ + "((value: any) => { [key: string]: any; } | null)[]" + ], + "path": "x-pack/plugins/ml/common/util/validators.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "ml", + "id": "def-common.extractErrorMessage", + "type": "Function", + "tags": [], + "label": "extractErrorMessage", + "description": [], + "signature": [ + "(error: ", + "ErrorType", + ") => string" + ], + "path": "x-pack/plugins/ml/common/util/errors/process_errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "ml", + "id": "def-common.extractErrorMessage.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "ErrorType" + ], + "path": "x-pack/plugins/ml/common/util/errors/process_errors.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "ml", + "id": "def-common.getDefaultCapabilities", + "type": "Function", + "tags": [], + "label": "getDefaultCapabilities", + "description": [], + "signature": [ + "() => ", + "MlCapabilities" + ], + "path": "x-pack/plugins/ml/common/types/capabilities.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "ml", + "id": "def-common.getSeverityColor", + "type": "Function", + "tags": [], + "label": "getSeverityColor", + "description": [ + "\nReturns a severity RGB color (one of critical, major, minor, warning, low or blank)\nfor the supplied normalized anomaly score (a value between 0 and 100)." + ], + "signature": [ + "(normalizedScore: number) => string" + ], + "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "ml", + "id": "def-common.getSeverityColor.$1", + "type": "number", + "tags": [], + "label": "normalizedScore", + "description": [ + "- A normalized score between 0-100, which is based on the probability of the anomalousness of this record" + ], + "signature": [ + "number" + ], + "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "ml", + "id": "def-common.getSeverityType", + "type": "Function", + "tags": [], + "label": "getSeverityType", + "description": [ + "\nReturns a severity type (indicating a critical, major, minor, warning or low severity anomaly)\nfor the supplied normalized anomaly score (a value between 0 and 100)." + ], + "signature": [ + "(normalizedScore: number) => ", + { + "pluginId": "ml", + "scope": "common", + "docId": "kibMlPluginApi", + "section": "def-common.ANOMALY_SEVERITY", + "text": "ANOMALY_SEVERITY" + } + ], + "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "ml", + "id": "def-common.getSeverityType.$1", + "type": "number", + "tags": [], + "label": "normalizedScore", + "description": [ + "- A normalized score between 0-100, which is based on the probability of the anomalousness of this record" + ], + "signature": [ + "number" ], "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", "deprecated": false, @@ -2603,188 +3084,535 @@ }, { "parentPluginId": "ml", - "id": "def-common.getSeverityType", + "id": "def-common.isPopulatedObject", + "type": "Function", + "tags": [], + "label": "isPopulatedObject", + "description": [], + "signature": [ + "(arg: unknown, requiredAttributes?: U[]) => arg is Record" + ], + "path": "x-pack/plugins/ml/common/util/object_utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "ml", + "id": "def-common.isPopulatedObject.$1", + "type": "Unknown", + "tags": [], + "label": "arg", + "description": [], + "signature": [ + "unknown" + ], + "path": "x-pack/plugins/ml/common/util/object_utils.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "ml", + "id": "def-common.isPopulatedObject.$2", + "type": "Array", + "tags": [], + "label": "requiredAttributes", + "description": [], + "signature": [ + "U[]" + ], + "path": "x-pack/plugins/ml/common/util/object_utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "ml", + "id": "def-common.isRuntimeField", + "type": "Function", + "tags": [], + "label": "isRuntimeField", + "description": [], + "signature": [ + "(arg: unknown) => boolean" + ], + "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "ml", + "id": "def-common.isRuntimeField.$1", + "type": "Unknown", + "tags": [], + "label": "arg", + "description": [], + "signature": [ + "unknown" + ], + "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "ml", + "id": "def-common.isRuntimeMappings", + "type": "Function", + "tags": [], + "label": "isRuntimeMappings", + "description": [], + "signature": [ + "(arg: unknown) => boolean" + ], + "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "ml", + "id": "def-common.isRuntimeMappings.$1", + "type": "Unknown", + "tags": [], + "label": "arg", + "description": [], + "signature": [ + "unknown" + ], + "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "ml", + "id": "def-common.patternValidator", "type": "Function", "tags": [], - "label": "getSeverityType", + "label": "patternValidator", "description": [ - "\nReturns a severity type (indicating a critical, major, minor, warning or low severity anomaly)\nfor the supplied normalized anomaly score (a value between 0 and 100)." + "\nProvides a validator function for checking against pattern." ], "signature": [ - "(normalizedScore: number) => ", + "(pattern: RegExp) => (value: string) => { pattern: { matchPattern: string; }; } | null" + ], + "path": "x-pack/plugins/ml/common/util/validators.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "ml", + "id": "def-common.patternValidator.$1", + "type": "Object", + "tags": [], + "label": "pattern", + "description": [], + "signature": [ + "RegExp" + ], + "path": "x-pack/plugins/ml/common/util/validators.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob", + "type": "Interface", + "tags": [], + "label": "MlSummaryJob", + "description": [ + "\nA summary of an anomaly detection job." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nThe identifier for the anomaly detection job." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.description", + "type": "string", + "tags": [], + "label": "description", + "description": [ + "\nA description of the job." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.groups", + "type": "Array", + "tags": [], + "label": "groups", + "description": [ + "\nA list of job groups. A job can belong to no groups, one or many." + ], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.processed_record_count", + "type": "number", + "tags": [], + "label": "processed_record_count", + "description": [ + "\nThe number of input documents that have been processed by the anomaly detection job.\nThis value includes documents with missing fields, since they are nonetheless analyzed." + ], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.memory_status", + "type": "string", + "tags": [], + "label": "memory_status", + "description": [ + "\nThe status of the mathematical models, which can take the values ok, soft_limit or hard_limit." + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.jobState", + "type": "CompoundType", + "tags": [], + "label": "jobState", + "description": [ + "\nThe status of the job." + ], + "signature": [ + "MlJobState", + " | ", + "JobActionState" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.datafeedIndices", + "type": "Array", + "tags": [], + "label": "datafeedIndices", + "description": [ + "\nAn array of index names used by the datafeed. Wildcards are supported." + ], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.hasDatafeed", + "type": "boolean", + "tags": [], + "label": "hasDatafeed", + "description": [ + "\nFlag indicating whether a datafeed exists for the job." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.datafeedId", + "type": "string", + "tags": [], + "label": "datafeedId", + "description": [ + "\nThe identifier for the datafeed." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.datafeedState", + "type": "string", + "tags": [], + "label": "datafeedState", + "description": [ + "\nThe status of the datafeed." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.latestTimestampMs", + "type": "number", + "tags": [], + "label": "latestTimestampMs", + "description": [ + "\nThe timestamp of the latest chronologically input document." + ], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.earliestTimestampMs", + "type": "number", + "tags": [], + "label": "earliestTimestampMs", + "description": [ + "\nThe timestamp of the earliest chronologically input document." + ], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.latestResultsTimestampMs", + "type": "number", + "tags": [], + "label": "latestResultsTimestampMs", + "description": [ + "\nThe latest of the timestamp of the latest chronologically input document or the latest bucket that was processed." + ], + "signature": [ + "number | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.fullJob", + "type": "Object", + "tags": [], + "label": "fullJob", + "description": [ + "\nUsed in older implementations of the job config, where the datafeed was placed inside the job for convenience.\nThis will be populated if the job's id has been passed to the /api/ml/jobs/jobs_summary endpoint." + ], + "signature": [ + "CombinedJob", + " | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.nodeName", + "type": "string", + "tags": [], + "label": "nodeName", + "description": [ + "\nThe name of the node that runs the job." + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.auditMessage", + "type": "Object", + "tags": [], + "label": "auditMessage", + "description": [ + "\nAudit message for the job." + ], + "signature": [ + "Partial<", + "AuditMessage", + "> | undefined" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, { - "pluginId": "ml", - "scope": "common", - "docId": "kibMlPluginApi", - "section": "def-common.ANOMALY_SEVERITY", - "text": "ANOMALY_SEVERITY" - } - ], - "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", - "deprecated": false, - "children": [ + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.isSingleMetricViewerJob", + "type": "boolean", + "tags": [], + "label": "isSingleMetricViewerJob", + "description": [ + "\nFlag indicating whether results of the job can be viewed in the Single Metric Viewer." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, { "parentPluginId": "ml", - "id": "def-common.getSeverityType.$1", - "type": "number", + "id": "def-common.MlSummaryJob.isNotSingleMetricViewerJobMessage", + "type": "string", "tags": [], - "label": "normalizedScore", + "label": "isNotSingleMetricViewerJobMessage", "description": [ - "- A normalized score between 0-100, which is based on the probability of the anomalousness of this record" + "\nFor jobs which cannot be viewed in the Single Metric Viewer, a message indicating the reason why\nresults for the job cannot be viewed in the Single Metric Viewer." ], "signature": [ - "number" + "string | undefined" ], - "path": "x-pack/plugins/ml/common/util/anomaly_utils.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "ml", - "id": "def-common.isPopulatedObject", - "type": "Function", - "tags": [], - "label": "isPopulatedObject", - "description": [], - "signature": [ - "(arg: unknown, requiredAttributes?: U[]) => arg is Record" - ], - "path": "x-pack/plugins/ml/common/util/object_utils.ts", - "deprecated": false, - "children": [ + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, { "parentPluginId": "ml", - "id": "def-common.isPopulatedObject.$1", - "type": "Unknown", + "id": "def-common.MlSummaryJob.blocked", + "type": "Object", "tags": [], - "label": "arg", - "description": [], + "label": "blocked", + "description": [ + "\nWhen present, it explains that a task is currently running on the job, which is stopping\nany other actions from being performed on the job." + ], "signature": [ - "unknown" + "MlJobBlocked", + " | undefined" ], - "path": "x-pack/plugins/ml/common/util/object_utils.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false }, { "parentPluginId": "ml", - "id": "def-common.isPopulatedObject.$2", - "type": "Array", + "id": "def-common.MlSummaryJob.latestTimestampSortValue", + "type": "number", "tags": [], - "label": "requiredAttributes", - "description": [], + "label": "latestTimestampSortValue", + "description": [ + "\nValue of the latest timestamp for the job used for sorting." + ], "signature": [ - "U[]" + "number | undefined" ], - "path": "x-pack/plugins/ml/common/util/object_utils.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "ml", - "id": "def-common.isRuntimeField", - "type": "Function", - "tags": [], - "label": "isRuntimeField", - "description": [], - "signature": [ - "(arg: unknown) => boolean" - ], - "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", - "deprecated": false, - "children": [ + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, { "parentPluginId": "ml", - "id": "def-common.isRuntimeField.$1", - "type": "Unknown", + "id": "def-common.MlSummaryJob.earliestStartTimestampMs", + "type": "number", "tags": [], - "label": "arg", - "description": [], + "label": "earliestStartTimestampMs", + "description": [ + "\nThe earlist of the timestamp of the earliest chronologically input document or the earliest bucket that was processed." + ], "signature": [ - "unknown" + "number | undefined" ], - "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "ml", - "id": "def-common.isRuntimeMappings", - "type": "Function", - "tags": [], - "label": "isRuntimeMappings", - "description": [], - "signature": [ - "(arg: unknown) => boolean" - ], - "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", - "deprecated": false, - "children": [ + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, { "parentPluginId": "ml", - "id": "def-common.isRuntimeMappings.$1", - "type": "Unknown", + "id": "def-common.MlSummaryJob.awaitingNodeAssignment", + "type": "boolean", "tags": [], - "label": "arg", - "description": [], + "label": "awaitingNodeAssignment", + "description": [ + "\nIndicates whether the job is currently awaiting assignment to a node before opening." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.alertingRules", + "type": "Array", + "tags": [], + "label": "alertingRules", + "description": [ + "\nList of anomaly detection alerting rules configured for the job." + ], "signature": [ - "unknown" + "MlAnomalyDetectionAlertRule", + "[] | undefined" ], - "path": "x-pack/plugins/ml/common/util/runtime_field_utils.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "ml", - "id": "def-common.patternValidator", - "type": "Function", - "tags": [], - "label": "patternValidator", - "description": [ - "\nProvides a validator function for checking against pattern." - ], - "signature": [ - "(pattern: RegExp) => (value: string) => { pattern: { matchPattern: string; }; } | null" - ], - "path": "x-pack/plugins/ml/common/util/validators.ts", - "deprecated": false, - "children": [ + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, { "parentPluginId": "ml", - "id": "def-common.patternValidator.$1", + "id": "def-common.MlSummaryJob.jobTags", "type": "Object", "tags": [], - "label": "pattern", - "description": [], + "label": "jobTags", + "description": [ + "\nList of tags that have been added to the job." + ], "signature": [ - "RegExp" + "{ [x: string]: string; }" ], - "path": "x-pack/plugins/ml/common/util/validators.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.bucketSpanSeconds", + "type": "number", + "tags": [], + "label": "bucketSpanSeconds", + "description": [ + "\nThe size of the interval that the analysis is aggregated into, typically between 5m and 1h." + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false + }, + { + "parentPluginId": "ml", + "id": "def-common.MlSummaryJob.customSettings", + "type": "Any", + "tags": [], + "label": "customSettings", + "description": [ + "\nAdvanced configuration option. Contains custom meta data about the job. For example, it can contain custom URL information." + ], + "signature": [ + "any" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false } ], - "interfaces": [], "enums": [ { "parentPluginId": "ml", @@ -2897,6 +3725,22 @@ "path": "x-pack/plugins/ml/common/constants/anomalies.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "ml", + "id": "def-common.SummaryJobState", + "type": "Type", + "tags": [], + "label": "SummaryJobState", + "description": [], + "signature": [ + "MlJobState", + " | ", + "JobActionState" + ], + "path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/summary_job.ts", + "deprecated": false, + "initialIsOpen": false } ], "objects": [ diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index c53f258b23ce2..d7077b822f23f 100644 --- a/api_docs/ml.mdx +++ b/api_docs/ml.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ml title: "ml" image: https://source.unsplash.com/400x175/?github summary: API docs for the ml plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 196 | 8 | 79 | 30 | +| 254 | 10 | 81 | 31 | ## Client @@ -71,6 +71,9 @@ Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for q ### Functions +### Interfaces + + ### Enums diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx index f4ccaa0afb22f..2a7d8b6d02607 100644 --- a/api_docs/monitoring.mdx +++ b/api_docs/monitoring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoring title: "monitoring" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoring plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoring'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/monitoring_collection.mdx b/api_docs/monitoring_collection.mdx index 6862c66127338..f75527b21b635 100644 --- a/api_docs/monitoring_collection.mdx +++ b/api_docs/monitoring_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoringCollection title: "monitoringCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoringCollection plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoringCollection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/navigation.devdocs.json b/api_docs/navigation.devdocs.json index 8c183c4b321ad..e07b06a8b3e1e 100644 --- a/api_docs/navigation.devdocs.json +++ b/api_docs/navigation.devdocs.json @@ -679,7 +679,7 @@ "section": "def-public.UnifiedSearchPublicPluginStart", "text": "UnifiedSearchPublicPluginStart" }, - " | undefined; className?: string | undefined; setMenuMountPoint?: ((menuMount: ", + " | undefined; className?: string | undefined; visible?: boolean | undefined; setMenuMountPoint?: ((menuMount: ", { "pluginId": "core", "scope": "public", diff --git a/api_docs/navigation.mdx b/api_docs/navigation.mdx index a7aee0a91e834..bbe1bd669c088 100644 --- a/api_docs/navigation.mdx +++ b/api_docs/navigation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/navigation title: "navigation" image: https://source.unsplash.com/400x175/?github summary: API docs for the navigation plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'navigation'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/newsfeed.mdx b/api_docs/newsfeed.mdx index 9dc6262d29612..77621c025af10 100644 --- a/api_docs/newsfeed.mdx +++ b/api_docs/newsfeed.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/newsfeed title: "newsfeed" image: https://source.unsplash.com/400x175/?github summary: API docs for the newsfeed plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'newsfeed'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/observability.devdocs.json b/api_docs/observability.devdocs.json index 1167181e14f56..1c935afbcebc3 100644 --- a/api_docs/observability.devdocs.json +++ b/api_docs/observability.devdocs.json @@ -205,7 +205,7 @@ "section": "def-public.ObservabilityRuleTypeFormatter", "text": "ObservabilityRuleTypeFormatter" }, - " | undefined; } & { getFormatter: () => () => string; registerFormatter: () => void; }" + " | undefined; list: () => string[]; } & { getFormatter: () => () => string; registerFormatter: () => void; }" ], "path": "x-pack/plugins/observability/public/rules/observability_rule_type_registry_mock.ts", "deprecated": false, @@ -676,7 +676,7 @@ "section": "def-public.ObservabilityRuleTypeFormatter", "text": "ObservabilityRuleTypeFormatter" }, - " | undefined; }; selectedAlertId?: string | undefined; } & ", + " | undefined; list: () => string[]; }; selectedAlertId?: string | undefined; } & ", "CommonProps", " & { as?: \"div\" | undefined; } & _EuiFlyoutProps & Omit, HTMLDivElement>, keyof _EuiFlyoutProps> & Omit, HTMLDivElement>, \"key\" | \"css\" | keyof React.HTMLAttributes> & { ref?: React.RefObject | ((instance: HTMLDivElement | null) => void) | null | undefined; }, \"children\" | \"color\" | \"title\" | \"onChange\" | \"onKeyDown\" | \"onClick\" | \"id\" | \"security\" | \"defaultValue\" | \"hidden\" | \"defaultChecked\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"lang\" | \"placeholder\" | \"slot\" | \"spellCheck\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"as\" | keyof ", "CommonProps", @@ -1750,7 +1750,7 @@ "label": "unsafe", "description": [], "signature": [ - "{ alertingExperience: { enabled: boolean; }; rules: { enabled: boolean; }; cases: { enabled: boolean; }; overviewNext: { enabled: boolean; }; }" + "{ alertingExperience: { enabled: boolean; }; rules: { enabled: boolean; }; cases: { enabled: boolean; }; }" ], "path": "x-pack/plugins/observability/public/index.ts", "deprecated": false @@ -3137,6 +3137,25 @@ ], "path": "x-pack/plugins/observability/public/plugin.ts", "deprecated": false + }, + { + "parentPluginId": "observability", + "id": "def-public.ObservabilityPublicPluginsSetup.usageCollection", + "type": "Object", + "tags": [], + "label": "usageCollection", + "description": [], + "signature": [ + { + "pluginId": "usageCollection", + "scope": "public", + "docId": "kibUsageCollectionPluginApi", + "section": "def-public.UsageCollectionSetup", + "text": "UsageCollectionSetup" + } + ], + "path": "x-pack/plugins/observability/public/plugin.ts", + "deprecated": false } ], "initialIsOpen": false @@ -3151,6 +3170,25 @@ "path": "x-pack/plugins/observability/public/plugin.ts", "deprecated": false, "children": [ + { + "parentPluginId": "observability", + "id": "def-public.ObservabilityPublicPluginsStart.usageCollection", + "type": "Object", + "tags": [], + "label": "usageCollection", + "description": [], + "signature": [ + { + "pluginId": "usageCollection", + "scope": "public", + "docId": "kibUsageCollectionPluginApi", + "section": "def-public.UsageCollectionSetup", + "text": "UsageCollectionSetup" + } + ], + "path": "x-pack/plugins/observability/public/plugin.ts", + "deprecated": false + }, { "parentPluginId": "observability", "id": "def-public.ObservabilityPublicPluginsStart.cases", @@ -3714,8 +3752,8 @@ "pluginId": "expressionXY", "scope": "common", "docId": "kibExpressionXYPluginApi", - "section": "def-common.YConfig", - "text": "YConfig" + "section": "def-common.ExtendedYConfig", + "text": "ExtendedYConfig" }, "[] | undefined" ], @@ -4496,6 +4534,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "observability", + "id": "def-public.enableNewSyntheticsView", + "type": "string", + "tags": [], + "label": "enableNewSyntheticsView", + "description": [], + "signature": [ + "\"observability:enableNewSyntheticsView\"" + ], + "path": "x-pack/plugins/observability/common/ui_settings_keys.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-public.enableServiceGroups", @@ -4719,7 +4771,7 @@ "section": "def-public.ObservabilityRuleTypeFormatter", "text": "ObservabilityRuleTypeFormatter" }, - " | undefined; }" + " | undefined; list: () => string[]; }" ], "path": "x-pack/plugins/observability/public/rules/create_observability_rule_type_registry.ts", "deprecated": false, @@ -4926,7 +4978,7 @@ "section": "def-public.ObservabilityRuleTypeFormatter", "text": "ObservabilityRuleTypeFormatter" }, - " | undefined; }; isAlertingExperienceEnabled: () => boolean; navigation: { registerSections: (sections$: ", + " | undefined; list: () => string[]; }; isAlertingExperienceEnabled: () => boolean; navigation: { registerSections: (sections$: ", "Observable", "<", "NavigationSection", @@ -7275,6 +7327,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "observability", + "id": "def-common.apmTraceExplorerTab", + "type": "string", + "tags": [], + "label": "apmTraceExplorerTab", + "description": [], + "signature": [ + "\"observability:apmTraceExplorerTab\"" + ], + "path": "x-pack/plugins/observability/common/ui_settings_keys.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "observability", "id": "def-common.AsDuration", diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index 958f5d5f0f061..0050a336bfec4 100644 --- a/api_docs/observability.mdx +++ b/api_docs/observability.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/observability title: "observability" image: https://source.unsplash.com/400x175/?github summary: API docs for the observability plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observability'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Observability UI](https://github.com/orgs/elastic/teams/observability-u | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 373 | 2 | 370 | 30 | +| 377 | 2 | 374 | 30 | ## Client diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index e5785b58293ea..b965ea5c2de6d 100644 --- a/api_docs/osquery.mdx +++ b/api_docs/osquery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/osquery title: "osquery" image: https://source.unsplash.com/400x175/?github summary: API docs for the osquery plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx index f43ac68f5f298..4100d2e76ad44 100644 --- a/api_docs/plugin_directory.mdx +++ b/api_docs/plugin_directory.mdx @@ -3,7 +3,7 @@ id: kibDevDocsPluginDirectory slug: /kibana-dev-docs/api-meta/plugin-api-directory title: Directory summary: Directory of public APIs available through plugins or packages. -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -12,123 +12,123 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Count | Plugins or Packages with a
public API | Number of teams | |--------------|----------|------------------------| -| 247 | 201 | 35 | +| 259 | 210 | 35 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 25958 | 170 | 19687 | 1153 | +| 26298 | 171 | 19826 | 1223 | ## Plugin Directory | Plugin name           | Maintaining team | Description | API Cnt | Any Cnt | Missing
comments | Missing
exports | |--------------|----------------|-----------|--------------|----------|---------------|--------| -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 195 | 0 | 191 | 11 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 240 | 0 | 235 | 19 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 23 | 0 | 19 | 1 | -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 325 | 0 | 316 | 19 | -| | [APM UI](https://github.com/orgs/elastic/teams/apm-ui) | The user interface for Elastic APM | 40 | 0 | 40 | 50 | +| | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | AIOps plugin maintained by ML team. | 11 | 0 | 0 | 0 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 359 | 0 | 350 | 19 | +| | [APM UI](https://github.com/orgs/elastic/teams/apm-ui) | The user interface for Elastic APM | 40 | 0 | 40 | 52 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 9 | 0 | 9 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Considering using bfetch capabilities when fetching large amounts of data. This services supports batching HTTP requests and streaming responses back. | 78 | 1 | 69 | 2 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Canvas application to Kibana | 9 | 0 | 8 | 3 | -| | [ResponseOps](https://github.com/orgs/elastic/teams/response-ops) | The Case management system in Kibana | 71 | 0 | 57 | 19 | +| | [ResponseOps](https://github.com/orgs/elastic/teams/response-ops) | The Case management system in Kibana | 66 | 0 | 52 | 22 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 272 | 2 | 253 | 9 | -| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 28 | 0 | 23 | 0 | +| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 29 | 0 | 24 | 0 | | | [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-posture-security) | The cloud security posture plugin | 14 | 0 | 14 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 13 | 0 | 13 | 1 | -| | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | 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 | 203 | 0 | 197 | 6 | -| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2524 | 15 | 977 | 33 | +| | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | 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 | 205 | 0 | 199 | 7 | +| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2541 | 15 | 977 | 33 | | crossClusterReplication | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | -| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 98 | 0 | 79 | 1 | -| | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 142 | 0 | 140 | 12 | +| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 101 | 0 | 82 | 1 | +| | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 143 | 0 | 141 | 12 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 52 | 0 | 51 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | 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. | 3414 | 38 | 2802 | 18 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Enhanced data plugin. (See src/plugins/data.) Enhances the main data plugin with a search session management UI. Includes a reusable search session indicator component to use in other applications. Exposes routes for managing search sessions. Includes a service that monitors, updates, and cleans up search session saved objects. | 16 | 0 | 16 | 2 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | This plugin provides the ability to create data views via a modal flyout from any kibana app | 13 | 0 | 7 | 0 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | 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. | 3489 | 38 | 2874 | 20 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | This plugin provides the ability to create data views via a modal flyout from any kibana app | 14 | 0 | 7 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Reusable data view field editor across Kibana | 42 | 0 | 37 | 3 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data view management app | 2 | 0 | 2 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | 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. | 862 | 3 | 710 | 15 | -| | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The Data Visualizer tools help you understand your data, by analyzing the metrics and fields in a log file or an existing Elasticsearch index. | 23 | 2 | 19 | 1 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | 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. | 866 | 3 | 714 | 15 | +| | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The Data Visualizer tools help you understand your data, by analyzing the metrics and fields in a log file or an existing Elasticsearch index. | 28 | 3 | 24 | 1 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 10 | 0 | 8 | 2 | -| | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the Discover application and the saved search embeddable. | 76 | 0 | 60 | 7 | +| | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the Discover application and the saved search embeddable. | 78 | 0 | 62 | 7 | | | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 37 | 0 | 35 | 2 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds embeddables service to Kibana | 476 | 0 | 386 | 4 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds embeddables service to Kibana | 486 | 0 | 396 | 3 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Extends embeddable plugin with more functionality | 14 | 0 | 14 | 0 | -| | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides encryption and decryption utilities for saved objects containing sensitive information. | 48 | 0 | 44 | 0 | +| | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides encryption and decryption utilities for saved objects containing sensitive information. | 51 | 0 | 44 | 0 | | | [Enterprise Search](https://github.com/orgs/elastic/teams/enterprise-search-frontend) | Adds dashboards for discovering and managing Enterprise Search products. | 2 | 0 | 2 | 0 | -| | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 112 | 3 | 108 | 3 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | The Event Annotation service contains expressions for event annotations | 49 | 0 | 49 | 3 | -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 91 | 0 | 91 | 9 | +| | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 114 | 3 | 110 | 3 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | The Event Annotation service contains expressions for event annotations | 90 | 0 | 90 | 5 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 100 | 0 | 100 | 9 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'error' renderer to expressions | 17 | 0 | 15 | 2 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Gauge plugin adds a `gauge` renderer and function to the expression plugin. The renderer will display the `gauge` chart. | 61 | 0 | 61 | 2 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Heatmap plugin adds a `heatmap` renderer and function to the expression plugin. The renderer will display the `heatmap` chart. | 104 | 0 | 100 | 3 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Heatmap plugin adds a `heatmap` renderer and function to the expression plugin. The renderer will display the `heatmap` chart. | 107 | 0 | 103 | 3 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'image' function and renderer to expressions | 26 | 0 | 26 | 0 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'metric' function and renderer to expressions | 32 | 0 | 27 | 0 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression MetricVis plugin adds a `metric` renderer and function to the expression plugin. The renderer will display the `metric` chart. | 46 | 0 | 46 | 1 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression MetricVis plugin adds a `metric` renderer and function to the expression plugin. The renderer will display the `metric` chart. | 48 | 0 | 48 | 1 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | 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. | 70 | 0 | 70 | 2 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'repeatImage' function and renderer to expressions | 32 | 0 | 32 | 0 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'revealImage' function and renderer to expressions | 14 | 0 | 14 | 3 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'shape' function and renderer to expressions | 148 | 0 | 146 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Tagcloud plugin adds a `tagcloud` renderer and function to the expression plugin. The renderer will display the `Wordcloud` chart. | 7 | 0 | 7 | 0 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression XY plugin adds a `xy` renderer and function to the expression plugin. The renderer will display the `xy` chart. | 473 | 0 | 463 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds expression runtime to Kibana | 2158 | 17 | 1713 | 5 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression XY plugin adds a `xy` renderer and function to the expression plugin. The renderer will display the `xy` chart. | 143 | 0 | 133 | 14 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds expression runtime to Kibana | 2176 | 17 | 1722 | 5 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 222 | 0 | 95 | 2 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Index pattern fields and ambiguous values formatters | 286 | 6 | 247 | 3 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Index pattern fields and ambiguous values formatters | 290 | 6 | 251 | 3 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | 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. | 62 | 0 | 62 | 2 | -| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1385 | 8 | 1268 | 10 | +| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1404 | 8 | 1282 | 10 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 68 | 0 | 14 | 5 | | globalSearchBar | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | | globalSearchProviders | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | | graph | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 0 | 0 | 0 | 0 | | grokdebugger | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | -| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 140 | 0 | 102 | 0 | +| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 141 | 0 | 102 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 4 | 0 | 4 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 175 | 0 | 170 | 3 | -| | [Logs and Metrics UI](https://github.com/orgs/elastic/teams/logs-metrics-ui) | This plugin visualizes data from Filebeat and Metricbeat, and integrates with other Observability solutions | 31 | 0 | 28 | 5 | +| | [Logs and Metrics UI](https://github.com/orgs/elastic/teams/logs-metrics-ui) | This plugin visualizes data from Filebeat and Metricbeat, and integrates with other Observability solutions | 42 | 0 | 39 | 8 | | ingestPipelines | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | inputControlVis | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Input Control visualization to Kibana | 0 | 0 | 0 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 123 | 2 | 96 | 4 | | | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides UI and APIs for the interactive setup mode. | 28 | 0 | 18 | 0 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 6 | 0 | 6 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 240 | 0 | 204 | 5 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 250 | 0 | 213 | 5 | | kibanaUsageCollection | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 0 | 0 | 0 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 615 | 3 | 420 | 9 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 527 | 0 | 452 | 30 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 574 | 0 | 497 | 35 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 8 | 0 | 8 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 3 | 0 | 3 | 0 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 117 | 0 | 42 | 10 | | | [Security detections response](https://github.com/orgs/elastic/teams/security-detections-response) | - | 198 | 0 | 90 | 49 | | logstash | [Logstash](https://github.com/orgs/elastic/teams/logstash) | - | 0 | 0 | 0 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 41 | 0 | 41 | 6 | -| | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 224 | 0 | 223 | 25 | +| | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 226 | 0 | 225 | 25 | | | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 67 | 0 | 67 | 0 | -| | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the machine learning features provided by Elastic. | 196 | 8 | 79 | 30 | +| | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the machine learning features provided by Elastic. | 254 | 10 | 81 | 31 | | | [Stack Monitoring](https://github.com/orgs/elastic/teams/stack-monitoring-ui) | - | 11 | 0 | 9 | 1 | | | [Stack Monitoring](https://github.com/orgs/elastic/teams/stack-monitoring-ui) | - | 9 | 0 | 9 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 34 | 0 | 34 | 2 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 17 | 0 | 17 | 0 | -| | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 373 | 2 | 370 | 30 | +| | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 377 | 2 | 374 | 30 | | | [Security asset management](https://github.com/orgs/elastic/teams/security-asset-management) | - | 13 | 0 | 13 | 0 | | painlessLab | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 228 | 2 | 177 | 11 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 4 | 0 | 4 | 0 | | | [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Reporting Services enables applications to feature reports that the user can automate with Watcher and download later. | 36 | 0 | 16 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 21 | 0 | 21 | 0 | -| | [RAC](https://github.com/orgs/elastic/teams/rac) | - | 194 | 0 | 167 | 8 | +| | [RAC](https://github.com/orgs/elastic/teams/rac) | - | 202 | 0 | 174 | 9 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 24 | 0 | 19 | 2 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 192 | 2 | 151 | 5 | -| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 110 | 0 | 97 | 0 | -| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 54 | 0 | 50 | 0 | +| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 125 | 0 | 112 | 0 | +| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 76 | 0 | 70 | 3 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 90 | 0 | 45 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 32 | 0 | 13 | 0 | -| | [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Kibana Screenshotting Plugin | 27 | 0 | 7 | 4 | +| | [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Kibana Screenshotting Plugin | 28 | 0 | 8 | 4 | | searchprofiler | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | -| | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides authentication and authorization features, and exposes functionality to understand the capabilities of the currently authenticated user. | 183 | 0 | 103 | 0 | -| | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 46 | 0 | 46 | 19 | +| | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides authentication and authorization features, and exposes functionality to understand the capabilities of the currently authenticated user. | 179 | 0 | 99 | 0 | +| | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 49 | 0 | 49 | 21 | | | [Security Team](https://github.com/orgs/elastic/teams/security-team) | - | 3 | 0 | 3 | 1 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds URL Service and sharing capabilities to Kibana | 113 | 0 | 54 | 10 | | | [Shared UX](https://github.com/orgs/elastic/teams/shared-ux) | A plugin providing components and services for shared user experiences in Kibana. | 4 | 0 | 0 | 0 | -| | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 21 | 1 | 21 | 1 | +| | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 22 | 1 | 22 | 1 | | | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides the Spaces feature, which allows saved objects to be organized into meaningful categories. | 260 | 0 | 64 | 0 | | | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 4 | 0 | 4 | 0 | | synthetics | [Uptime](https://github.com/orgs/elastic/teams/uptime) | This plugin visualizes data from Synthetics and Heartbeat, and integrates with other Observability solutions. | 0 | 0 | 0 | 0 | @@ -137,13 +137,13 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 32 | 0 | 32 | 6 | | | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 1 | 0 | 1 | 0 | | | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 11 | 0 | 10 | 0 | -| | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 434 | 1 | 330 | 35 | +| | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 436 | 1 | 332 | 35 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the transforms features provided by Elastic. Transforms enable you to convert existing Elasticsearch indices into summarized indices, which provide opportunities for new insights and analytics. | 4 | 0 | 4 | 1 | | translations | [Kibana Localization](https://github.com/orgs/elastic/teams/kibana-localization) | - | 0 | 0 | 0 | 0 | -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 321 | 0 | 307 | 25 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 374 | 0 | 360 | 34 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds UI Actions service to Kibana | 130 | 0 | 91 | 11 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Extends UI Actions plugin with more functionality | 203 | 0 | 141 | 9 | -| | [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-services) | Contains all the key functionality of Kibana's unified search experience.Contains all the key functionality of Kibana's unified search experience. | 79 | 2 | 75 | 11 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Extends UI Actions plugin with more functionality | 205 | 0 | 142 | 9 | +| | [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-services) | Contains all the key functionality of Kibana's unified search experience.Contains all the key functionality of Kibana's unified search experience. | 82 | 2 | 78 | 13 | | upgradeAssistant | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | urlDrilldown | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds drilldown implementations to Kibana | 0 | 0 | 0 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 12 | 0 | 12 | 0 | @@ -162,35 +162,41 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Registers the vega visualization. Is the elastic version of vega and vega-lite libraries. | 2 | 0 | 2 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the vislib visualizations. These are the classical area/line/bar, pie, gauge/goal and heatmap charts. We want to replace them with elastic-charts. | 26 | 0 | 25 | 1 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the new xy-axis chart using the elastic-charts library, which will eventually replace the vislib xy-axis charts including bar, area, and line. | 57 | 0 | 51 | 5 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 365 | 12 | 344 | 14 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Contains the shared architecture among all the legacy visualizations, e.g. the visualization type registry or the visualization embeddable. | 372 | 12 | 351 | 14 | | watcher | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | ## Package Directory | Package name           | Maintaining team | Description | API Cnt | Any Cnt | Missing
comments | Missing
exports | |--------------|----------------|-----------|--------------|----------|---------------|--------| -| | [Owner missing] | Elastic APM trace data generator | 70 | 0 | 70 | 10 | +| | [Owner missing] | Elastic APM trace data generator | 74 | 0 | 74 | 11 | | | [Owner missing] | - | 11 | 5 | 11 | 0 | +| | [Owner missing] | - | 35 | 0 | 18 | 0 | | | [Owner missing] | Alerts components and hooks | 9 | 1 | 9 | 0 | | | Ahmad Bamieh ahmadbamieh@gmail.com | Kibana Analytics tool | 69 | 0 | 69 | 2 | -| | [Owner missing] | - | 88 | 1 | 10 | 0 | -| | [Owner missing] | - | 18 | 0 | 13 | 0 | +| | [Owner missing] | - | 95 | 0 | 7 | 0 | +| | [Owner missing] | - | 18 | 0 | 13 | 0 | +| | [Owner missing] | - | 22 | 0 | 13 | 0 | +| | [Owner missing] | - | 18 | 0 | 13 | 0 | +| | [Owner missing] | - | 20 | 0 | 4 | 0 | | | [Owner missing] | - | 16 | 0 | 16 | 0 | | | [Owner missing] | - | 11 | 0 | 11 | 0 | | | [Owner missing] | - | 10 | 0 | 10 | 0 | | | [Owner missing] | - | 18 | 0 | 9 | 1 | | | [Owner missing] | - | 4 | 0 | 4 | 0 | -| | [Owner missing] | - | 8 | 0 | 7 | 0 | | | [Owner missing] | - | 7 | 0 | 2 | 0 | -| | [Owner missing] | - | 59 | 0 | 15 | 0 | +| | [Owner missing] | - | 60 | 0 | 15 | 0 | | | [Owner missing] | - | 2 | 0 | 2 | 0 | | | [Owner missing] | - | 106 | 0 | 80 | 1 | -| | [Owner missing] | - | 64 | 0 | 44 | 2 | +| | [Owner missing] | - | 65 | 0 | 44 | 2 | | | [Owner missing] | - | 129 | 3 | 127 | 17 | | | [Owner missing] | - | 13 | 0 | 7 | 0 | | | [Owner missing] | elasticsearch datemath parser, used in kibana | 44 | 0 | 43 | 0 | -| | [Owner missing] | - | 120 | 3 | 109 | 0 | -| | [Owner missing] | - | 64 | 0 | 64 | 2 | +| | [Owner missing] | - | 9 | 1 | 9 | 0 | +| | [Owner missing] | - | 65 | 0 | 64 | 0 | +| | [Owner missing] | - | 15 | 0 | 9 | 0 | +| | [Owner missing] | - | 31 | 2 | 27 | 0 | +| | [Owner missing] | - | 65 | 0 | 65 | 2 | | | [Owner missing] | - | 1 | 0 | 1 | 0 | | | [Owner missing] | - | 27 | 0 | 14 | 1 | | | [Owner missing] | - | 213 | 1 | 159 | 11 | @@ -198,6 +204,7 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 20 | 0 | 16 | 0 | | | [Owner missing] | - | 2 | 0 | 0 | 0 | | | [Owner missing] | - | 1 | 0 | 0 | 0 | +| | [Owner missing] | - | 6 | 0 | 0 | 0 | | | [Owner missing] | - | 51 | 0 | 48 | 0 | | | [Owner missing] | - | 43 | 0 | 36 | 0 | | | App Services | - | 35 | 4 | 35 | 0 | @@ -208,16 +215,17 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 8 | 0 | 8 | 0 | | | [Owner missing] | - | 494 | 1 | 1 | 0 | | | [Owner missing] | - | 55 | 0 | 55 | 2 | -| | [Owner missing] | - | 45 | 0 | 45 | 10 | +| | [Owner missing] | - | 47 | 0 | 46 | 10 | +| | [Owner missing] | A library to convert APM traces into JSON format for performance testing. | 3 | 0 | 3 | 0 | | | [Owner missing] | - | 30 | 0 | 29 | 0 | | | [Owner missing] | - | 1 | 0 | 1 | 0 | | | [Owner missing] | Just some helpers for kibana plugin devs. | 1 | 0 | 1 | 0 | -| | [Owner missing] | - | 47 | 0 | 35 | 5 | +| | [Owner missing] | - | 45 | 0 | 33 | 5 | | | [Owner missing] | - | 21 | 0 | 10 | 0 | | | [Owner missing] | - | 74 | 0 | 71 | 0 | | | [Owner missing] | Security Solution auto complete | 50 | 1 | 35 | 0 | | | [Owner missing] | security solution elastic search utilities to use across plugins such lists, security_solution, cases, etc... | 57 | 0 | 51 | 1 | -| | [Owner missing] | Security Solution utilities for React hooks | 14 | 0 | 6 | 0 | +| | [Owner missing] | Security Solution utilities for React hooks | 15 | 0 | 7 | 0 | | | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 148 | 0 | 129 | 0 | | | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 458 | 1 | 446 | 0 | | | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 48 | 0 | 26 | 0 | @@ -232,21 +240,22 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 53 | 0 | 50 | 1 | | | [Owner missing] | - | 25 | 0 | 24 | 1 | | | [Owner missing] | - | 12 | 0 | 2 | 3 | -| | [Owner missing] | - | 34 | 0 | 6 | 6 | -| | [Owner missing] | - | 67 | 0 | 43 | 0 | -| | [Owner missing] | - | 10 | 0 | 2 | 0 | +| | [Owner missing] | - | 23 | 0 | 6 | 3 | +| | [Owner missing] | - | 8 | 0 | 2 | 3 | +| | [Owner missing] | - | 78 | 0 | 49 | 2 | +| | [Owner missing] | - | 16 | 0 | 7 | 0 | | | [Owner missing] | - | 9 | 0 | 3 | 0 | | | [Owner missing] | - | 2 | 0 | 2 | 0 | | | [Owner missing] | - | 92 | 1 | 59 | 1 | | | [Owner missing] | - | 4 | 0 | 2 | 0 | -| | Operations | - | 22 | 2 | 21 | 0 | +| | Operations | - | 38 | 2 | 21 | 0 | | | [Owner missing] | - | 2 | 0 | 2 | 0 | -| | Operations | - | 252 | 6 | 214 | 9 | -| | [Owner missing] | - | 132 | 8 | 103 | 2 | +| | Operations | - | 240 | 5 | 201 | 9 | +| | [Owner missing] | - | 135 | 8 | 103 | 2 | | | [Owner missing] | - | 72 | 0 | 55 | 0 | | | [Owner missing] | - | 29 | 0 | 2 | 0 | | | [Owner missing] | - | 83 | 0 | 83 | 1 | | | [Owner missing] | - | 7 | 0 | 6 | 0 | -| | [Owner missing] | - | 28 | 0 | 10 | 1 | +| | [Owner missing] | - | 29 | 0 | 10 | 1 | | | [Owner missing] | - | 31 | 1 | 21 | 0 | diff --git a/api_docs/presentation_util.devdocs.json b/api_docs/presentation_util.devdocs.json index d90f46c200913..9ba20e6b5d151 100644 --- a/api_docs/presentation_util.devdocs.json +++ b/api_docs/presentation_util.devdocs.json @@ -1819,8 +1819,8 @@ "\nThe CodeEditor requires a set height, either on itself, or set to 100% with the parent\ncontainer controlling the height. This prop is required so consumers understand this\nlimitation and are intentional in using the component." ], "signature": [ - "HeightProperty", - " | undefined" + "Property", + ".Height | undefined" ], "path": "src/plugins/presentation_util/public/components/types.ts", "deprecated": false @@ -2229,7 +2229,7 @@ "label": "getProjects", "description": [], "signature": [ - "(solutions?: (\"dashboard\" | \"canvas\" | \"presentation\")[] | undefined) => Record<\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\" | \"labs:canvas:byValueEmbeddable\", ", + "(solutions?: (\"dashboard\" | \"presentation\" | \"canvas\")[] | undefined) => Record<\"labs:dashboard:deferBelowFold\" | \"labs:dashboard:dashboardControls\" | \"labs:canvas:byValueEmbeddable\", ", { "pluginId": "presentationUtil", "scope": "common", @@ -2250,7 +2250,7 @@ "label": "solutions", "description": [], "signature": [ - "(\"dashboard\" | \"canvas\" | \"presentation\")[] | undefined" + "(\"dashboard\" | \"presentation\" | \"canvas\")[] | undefined" ], "path": "src/plugins/presentation_util/public/services/labs.ts", "deprecated": false, @@ -2752,7 +2752,7 @@ "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, - ">, \"untilEmbeddableLoaded\" | \"removeEmbeddable\" | \"addNewEmbeddable\" | \"updateInputForChild\">; }" + ">, \"untilEmbeddableLoaded\" | \"removeEmbeddable\" | \"addNewEmbeddable\" | \"updateInputForChild\" | \"replaceEmbeddable\">; }" ], "path": "src/plugins/presentation_util/public/components/redux_embeddables/types.ts", "deprecated": false, @@ -3320,7 +3320,7 @@ "label": "solutions", "description": [], "signature": [ - "(\"dashboard\" | \"canvas\" | \"presentation\")[]" + "(\"dashboard\" | \"presentation\" | \"canvas\")[]" ], "path": "src/plugins/presentation_util/common/labs.ts", "deprecated": false @@ -3531,7 +3531,7 @@ "label": "SolutionName", "description": [], "signature": [ - "\"dashboard\" | \"canvas\" | \"presentation\"" + "\"dashboard\" | \"presentation\" | \"canvas\"" ], "path": "src/plugins/presentation_util/common/labs.ts", "deprecated": false, @@ -3707,7 +3707,7 @@ "label": "isActive", "description": [], "signature": [ - "false" + "true" ], "path": "src/plugins/presentation_util/common/labs.ts", "deprecated": false diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index edceb320dace9..c96b93d968cea 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/presentationUtil title: "presentationUtil" image: https://source.unsplash.com/400x175/?github summary: API docs for the presentationUtil plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx index a05a7407d5658..68f021c05e83a 100644 --- a/api_docs/remote_clusters.mdx +++ b/api_docs/remote_clusters.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/remoteClusters title: "remoteClusters" image: https://source.unsplash.com/400x175/?github summary: API docs for the remoteClusters plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'remoteClusters'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/reporting.mdx b/api_docs/reporting.mdx index 185a48b5d4218..ae135b6c79a23 100644 --- a/api_docs/reporting.mdx +++ b/api_docs/reporting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/reporting title: "reporting" image: https://source.unsplash.com/400x175/?github summary: API docs for the reporting plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reporting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/rollup.mdx b/api_docs/rollup.mdx index b9e0c8be22113..300dae7ca04e6 100644 --- a/api_docs/rollup.mdx +++ b/api_docs/rollup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/rollup title: "rollup" image: https://source.unsplash.com/400x175/?github summary: API docs for the rollup plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'rollup'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/rule_registry.devdocs.json b/api_docs/rule_registry.devdocs.json index 194d13b78917a..32b84823f28d3 100644 --- a/api_docs/rule_registry.devdocs.json +++ b/api_docs/rule_registry.devdocs.json @@ -190,7 +190,9 @@ "section": "def-common.RuleTypeParams", "text": "RuleTypeParams" }, - " = never>({ query, aggs, _source, track_total_hits: trackTotalHits, size, index, }: { query?: object | undefined; aggs?: object | undefined; index: string | undefined; track_total_hits?: boolean | undefined; _source?: string[] | undefined; size?: number | undefined; }) => Promise<", + " = never>({ query, aggs, _source, track_total_hits: trackTotalHits, size, index, sort, search_after: searchAfter, }: { query?: object | undefined; aggs?: object | undefined; index: string | undefined; track_total_hits?: boolean | undefined; _source?: string[] | undefined; size?: number | undefined; sort?: ", + "SortOptions", + "[] | undefined; search_after?: (string | number)[] | undefined; }) => Promise<", "SearchResponse", ">, unknown>>" ], @@ -202,7 +204,7 @@ "id": "def-server.AlertsClient.find.$1", "type": "Object", "tags": [], - "label": "{\n query,\n aggs,\n _source,\n track_total_hits: trackTotalHits,\n size,\n index,\n }", + "label": "{\n query,\n aggs,\n _source,\n track_total_hits: trackTotalHits,\n size,\n index,\n sort,\n search_after: searchAfter,\n }", "description": [], "path": "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts", "deprecated": false, @@ -284,6 +286,33 @@ ], "path": "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts", "deprecated": false + }, + { + "parentPluginId": "ruleRegistry", + "id": "def-server.AlertsClient.find.$1.sort", + "type": "Array", + "tags": [], + "label": "sort", + "description": [], + "signature": [ + "SortOptions", + "[] | undefined" + ], + "path": "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts", + "deprecated": false + }, + { + "parentPluginId": "ruleRegistry", + "id": "def-server.AlertsClient.find.$1.search_after", + "type": "Array", + "tags": [], + "label": "search_after", + "description": [], + "signature": [ + "(string | number)[] | undefined" + ], + "path": "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts", + "deprecated": false } ] } @@ -319,6 +348,36 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "ruleRegistry", + "id": "def-server.AlertsClient.getFeatureIdsByRegistrationContexts", + "type": "Function", + "tags": [], + "label": "getFeatureIdsByRegistrationContexts", + "description": [], + "signature": [ + "(RegistrationContexts: string[]) => Promise" + ], + "path": "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "ruleRegistry", + "id": "def-server.AlertsClient.getFeatureIdsByRegistrationContexts.$1", + "type": "Array", + "tags": [], + "label": "RegistrationContexts", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/rule_registry/server/alert_data_client/alerts_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -859,15 +918,45 @@ }, { "parentPluginId": "ruleRegistry", - "id": "def-server.RuleDataService.findIndicesByFeature", + "id": "def-server.RuleDataService.findFeatureIdsByRegistrationContexts", "type": "Function", "tags": [], - "label": "findIndicesByFeature", + "label": "findFeatureIdsByRegistrationContexts", + "description": [], + "signature": [ + "(registrationContexts: string[]) => string[]" + ], + "path": "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "ruleRegistry", + "id": "def-server.RuleDataService.findFeatureIdsByRegistrationContexts.$1", + "type": "Array", + "tags": [], + "label": "registrationContexts", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "ruleRegistry", + "id": "def-server.RuleDataService.findIndexByFeature", + "type": "Function", + "tags": [], + "label": "findIndexByFeature", "description": [], "signature": [ "(featureId: ", "AlertConsumers", - ", dataset?: ", + ", dataset: ", { "pluginId": "ruleRegistry", "scope": "server", @@ -875,16 +964,16 @@ "section": "def-server.Dataset", "text": "Dataset" }, - " | undefined) => ", + ") => ", "IndexInfo", - "[]" + " | null" ], "path": "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts", "deprecated": false, "children": [ { "parentPluginId": "ruleRegistry", - "id": "def-server.RuleDataService.findIndicesByFeature.$1", + "id": "def-server.RuleDataService.findIndexByFeature.$1", "type": "CompoundType", "tags": [], "label": "featureId", @@ -898,8 +987,8 @@ }, { "parentPluginId": "ruleRegistry", - "id": "def-server.RuleDataService.findIndicesByFeature.$2", - "type": "CompoundType", + "id": "def-server.RuleDataService.findIndexByFeature.$2", + "type": "Enum", "tags": [], "label": "dataset", "description": [], @@ -910,12 +999,11 @@ "docId": "kibRuleRegistryPluginApi", "section": "def-server.Dataset", "text": "Dataset" - }, - " | undefined" + } ], "path": "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] @@ -2312,17 +2400,17 @@ }, { "parentPluginId": "ruleRegistry", - "id": "def-server.IRuleDataService.findIndicesByFeature", + "id": "def-server.IRuleDataService.findIndexByFeature", "type": "Function", "tags": [], - "label": "findIndicesByFeature", + "label": "findIndexByFeature", "description": [ "\nLooks up the index information associated with the given Kibana \"feature\".\nNote: features are used in RBAC." ], "signature": [ "(featureId: ", "AlertConsumers", - ", dataset?: ", + ", dataset: ", { "pluginId": "ruleRegistry", "scope": "server", @@ -2330,16 +2418,16 @@ "section": "def-server.Dataset", "text": "Dataset" }, - " | undefined) => ", + ") => ", "IndexInfo", - "[]" + " | null" ], "path": "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts", "deprecated": false, "children": [ { "parentPluginId": "ruleRegistry", - "id": "def-server.IRuleDataService.findIndicesByFeature.$1", + "id": "def-server.IRuleDataService.findIndexByFeature.$1", "type": "CompoundType", "tags": [], "label": "featureId", @@ -2353,8 +2441,8 @@ }, { "parentPluginId": "ruleRegistry", - "id": "def-server.IRuleDataService.findIndicesByFeature.$2", - "type": "CompoundType", + "id": "def-server.IRuleDataService.findIndexByFeature.$2", + "type": "Enum", "tags": [], "label": "dataset", "description": [], @@ -2365,12 +2453,43 @@ "docId": "kibRuleRegistryPluginApi", "section": "def-server.Dataset", "text": "Dataset" - }, - " | undefined" + } ], "path": "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts", "deprecated": false, - "isRequired": false + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "ruleRegistry", + "id": "def-server.IRuleDataService.findFeatureIdsByRegistrationContexts", + "type": "Function", + "tags": [], + "label": "findFeatureIdsByRegistrationContexts", + "description": [ + "\nLooks up Kibana \"feature\" associated with the given registration context.\nNote: features are used in RBAC." + ], + "signature": [ + "(registrationContexts: string[]) => string[]" + ], + "path": "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "ruleRegistry", + "id": "def-server.IRuleDataService.findFeatureIdsByRegistrationContexts.$1", + "type": "Array", + "tags": [], + "label": "registrationContexts", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/rule_registry/server/rule_data_plugin_service/rule_data_plugin_service.ts", + "deprecated": false, + "isRequired": true } ], "returnComment": [] @@ -3590,9 +3709,11 @@ }, " & { featureIds: ", "AlertConsumers", - "[]; query?: { bool: ", - "QueryDslBoolQuery", - "; } | undefined; sort?: ", + "[]; fields?: ", + "QueryDslFieldAndFormat", + "[] | undefined; query?: Pick<", + "QueryDslQueryContainer", + ", \"ids\" | \"bool\"> | undefined; sort?: ", "SortCombinations", "[] | undefined; pagination?: ", { @@ -3625,7 +3746,9 @@ }, "<", "SearchResponse", - ">>" ], diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index e9a4921bf6d5a..0b8eda4b842f4 100644 --- a/api_docs/rule_registry.mdx +++ b/api_docs/rule_registry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ruleRegistry title: "ruleRegistry" image: https://source.unsplash.com/400x175/?github summary: API docs for the ruleRegistry plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [RAC](https://github.com/orgs/elastic/teams/rac) for questions regarding | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 194 | 0 | 167 | 8 | +| 202 | 0 | 174 | 9 | ## Server diff --git a/api_docs/runtime_fields.mdx b/api_docs/runtime_fields.mdx index f582632ea2d18..6048f91c0ec53 100644 --- a/api_docs/runtime_fields.mdx +++ b/api_docs/runtime_fields.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/runtimeFields title: "runtimeFields" image: https://source.unsplash.com/400x175/?github summary: API docs for the runtimeFields plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'runtimeFields'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects.mdx b/api_docs/saved_objects.mdx index 204b0f19f5d68..c3bc4af35e706 100644 --- a/api_docs/saved_objects.mdx +++ b/api_docs/saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjects title: "savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjects plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjects'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/saved_objects_management.devdocs.json b/api_docs/saved_objects_management.devdocs.json index baa484f82f10d..fd286b0782e6d 100644 --- a/api_docs/saved_objects_management.devdocs.json +++ b/api_docs/saved_objects_management.devdocs.json @@ -286,7 +286,7 @@ "section": "def-public.SavedObjectsManagementRecord", "text": "SavedObjectsManagementRecord" }, - "; defaultValue?: string | number | string[] | undefined; hidden?: boolean | undefined; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; lang?: string | undefined; placeholder?: string | undefined; slot?: string | undefined; spellCheck?: Booleanish | undefined; style?: React.CSSProperties | undefined; tabIndex?: number | undefined; translate?: \"yes\" | \"no\" | undefined; radioGroup?: string | undefined; role?: string | undefined; about?: string | undefined; datatype?: string | undefined; inlist?: any; prefix?: string | undefined; property?: string | undefined; resource?: string | undefined; typeof?: string | undefined; vocab?: string | undefined; autoCapitalize?: string | undefined; autoCorrect?: string | undefined; autoSave?: string | undefined; itemProp?: string | undefined; itemScope?: boolean | undefined; itemType?: string | undefined; itemID?: string | undefined; itemRef?: string | undefined; results?: number | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"none\" | \"email\" | \"search\" | \"text\" | \"tel\" | \"url\" | \"numeric\" | \"decimal\" | undefined; is?: string | undefined; 'aria-activedescendant'?: string | undefined; 'aria-atomic'?: boolean | \"true\" | \"false\" | undefined; 'aria-autocomplete'?: \"none\" | \"list\" | \"inline\" | \"both\" | undefined; 'aria-busy'?: boolean | \"true\" | \"false\" | undefined; 'aria-checked'?: boolean | \"mixed\" | \"true\" | \"false\" | undefined; 'aria-colcount'?: number | undefined; 'aria-colindex'?: number | undefined; 'aria-colspan'?: number | undefined; 'aria-controls'?: string | undefined; 'aria-current'?: boolean | \"date\" | \"page\" | \"time\" | \"true\" | \"false\" | \"step\" | \"location\" | undefined; 'aria-describedby'?: string | undefined; 'aria-details'?: string | undefined; 'aria-disabled'?: boolean | \"true\" | \"false\" | undefined; 'aria-dropeffect'?: \"none\" | \"copy\" | \"link\" | \"execute\" | \"move\" | \"popup\" | undefined; 'aria-errormessage'?: string | undefined; 'aria-expanded'?: boolean | \"true\" | \"false\" | undefined; 'aria-flowto'?: string | undefined; 'aria-grabbed'?: boolean | \"true\" | \"false\" | undefined; 'aria-haspopup'?: boolean | \"grid\" | \"menu\" | \"true\" | \"false\" | \"listbox\" | \"tree\" | \"dialog\" | undefined; 'aria-hidden'?: boolean | \"true\" | \"false\" | undefined; 'aria-invalid'?: boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" | undefined; 'aria-keyshortcuts'?: string | undefined; 'aria-label'?: string | undefined; 'aria-labelledby'?: string | undefined; 'aria-level'?: number | undefined; 'aria-live'?: \"off\" | \"assertive\" | \"polite\" | undefined; 'aria-modal'?: boolean | \"true\" | \"false\" | undefined; 'aria-multiline'?: boolean | \"true\" | \"false\" | undefined; 'aria-multiselectable'?: boolean | \"true\" | \"false\" | undefined; 'aria-orientation'?: \"horizontal\" | \"vertical\" | undefined; 'aria-owns'?: string | undefined; 'aria-placeholder'?: string | undefined; 'aria-posinset'?: number | undefined; 'aria-pressed'?: boolean | \"mixed\" | \"true\" | \"false\" | undefined; 'aria-readonly'?: boolean | \"true\" | \"false\" | undefined; 'aria-relevant'?: \"all\" | \"text\" | \"additions\" | \"additions text\" | \"removals\" | undefined; 'aria-required'?: boolean | \"true\" | \"false\" | undefined; 'aria-roledescription'?: string | undefined; 'aria-rowcount'?: number | undefined; 'aria-rowindex'?: number | undefined; 'aria-rowspan'?: number | undefined; 'aria-selected'?: boolean | \"true\" | \"false\" | undefined; 'aria-setsize'?: number | undefined; 'aria-sort'?: \"none\" | \"other\" | \"ascending\" | \"descending\" | undefined; 'aria-valuemax'?: number | undefined; 'aria-valuemin'?: number | undefined; 'aria-valuenow'?: number | undefined; 'aria-valuetext'?: string | undefined; dangerouslySetInnerHTML?: { __html: string; } | undefined; onCopy?: React.ClipboardEventHandler | undefined; onCopyCapture?: React.ClipboardEventHandler | undefined; onCut?: React.ClipboardEventHandler | undefined; onCutCapture?: React.ClipboardEventHandler | undefined; onPaste?: React.ClipboardEventHandler | undefined; onPasteCapture?: React.ClipboardEventHandler | undefined; onCompositionEnd?: React.CompositionEventHandler | undefined; onCompositionEndCapture?: React.CompositionEventHandler | undefined; onCompositionStart?: React.CompositionEventHandler | undefined; onCompositionStartCapture?: React.CompositionEventHandler | undefined; onCompositionUpdate?: React.CompositionEventHandler | undefined; onCompositionUpdateCapture?: React.CompositionEventHandler | undefined; onFocus?: React.FocusEventHandler | undefined; onFocusCapture?: React.FocusEventHandler | undefined; onBlur?: React.FocusEventHandler | undefined; onBlurCapture?: React.FocusEventHandler | undefined; onChangeCapture?: React.FormEventHandler | undefined; onBeforeInput?: React.FormEventHandler | undefined; onBeforeInputCapture?: React.FormEventHandler | undefined; onInput?: React.FormEventHandler | undefined; onInputCapture?: React.FormEventHandler | undefined; onReset?: React.FormEventHandler | undefined; onResetCapture?: React.FormEventHandler | undefined; onSubmit?: React.FormEventHandler | undefined; onSubmitCapture?: React.FormEventHandler | undefined; onInvalid?: React.FormEventHandler | undefined; onInvalidCapture?: React.FormEventHandler | undefined; onLoad?: React.ReactEventHandler | undefined; onLoadCapture?: React.ReactEventHandler | undefined; onError?: React.ReactEventHandler | undefined; onErrorCapture?: React.ReactEventHandler | undefined; onKeyDownCapture?: React.KeyboardEventHandler | undefined; onKeyPress?: React.KeyboardEventHandler | undefined; onKeyPressCapture?: React.KeyboardEventHandler | undefined; onKeyUp?: React.KeyboardEventHandler | undefined; onKeyUpCapture?: React.KeyboardEventHandler | undefined; onAbort?: React.ReactEventHandler | undefined; onAbortCapture?: React.ReactEventHandler | undefined; onCanPlay?: React.ReactEventHandler | undefined; onCanPlayCapture?: React.ReactEventHandler | undefined; onCanPlayThrough?: React.ReactEventHandler | undefined; onCanPlayThroughCapture?: React.ReactEventHandler | undefined; onDurationChange?: React.ReactEventHandler | undefined; onDurationChangeCapture?: React.ReactEventHandler | undefined; onEmptied?: React.ReactEventHandler | undefined; onEmptiedCapture?: React.ReactEventHandler | undefined; onEncrypted?: React.ReactEventHandler | undefined; onEncryptedCapture?: React.ReactEventHandler | undefined; onEnded?: React.ReactEventHandler | undefined; onEndedCapture?: React.ReactEventHandler | undefined; onLoadedData?: React.ReactEventHandler | undefined; onLoadedDataCapture?: React.ReactEventHandler | undefined; onLoadedMetadata?: React.ReactEventHandler | undefined; onLoadedMetadataCapture?: React.ReactEventHandler | undefined; onLoadStart?: React.ReactEventHandler | undefined; onLoadStartCapture?: React.ReactEventHandler | undefined; onPause?: React.ReactEventHandler | undefined; onPauseCapture?: React.ReactEventHandler | undefined; onPlay?: React.ReactEventHandler | undefined; onPlayCapture?: React.ReactEventHandler | undefined; onPlaying?: React.ReactEventHandler | undefined; onPlayingCapture?: React.ReactEventHandler | undefined; onProgress?: React.ReactEventHandler | undefined; onProgressCapture?: React.ReactEventHandler | undefined; onRateChange?: React.ReactEventHandler | undefined; onRateChangeCapture?: React.ReactEventHandler | undefined; onSeeked?: React.ReactEventHandler | undefined; onSeekedCapture?: React.ReactEventHandler | undefined; onSeeking?: React.ReactEventHandler | undefined; onSeekingCapture?: React.ReactEventHandler | undefined; onStalled?: React.ReactEventHandler | undefined; onStalledCapture?: React.ReactEventHandler | undefined; onSuspend?: React.ReactEventHandler | undefined; onSuspendCapture?: React.ReactEventHandler | undefined; onTimeUpdate?: React.ReactEventHandler | undefined; onTimeUpdateCapture?: React.ReactEventHandler | undefined; onVolumeChange?: React.ReactEventHandler | undefined; onVolumeChangeCapture?: React.ReactEventHandler | undefined; onWaiting?: React.ReactEventHandler | undefined; onWaitingCapture?: React.ReactEventHandler | undefined; onAuxClick?: React.MouseEventHandler | undefined; onAuxClickCapture?: React.MouseEventHandler | undefined; onClickCapture?: React.MouseEventHandler | undefined; onContextMenu?: React.MouseEventHandler | undefined; onContextMenuCapture?: React.MouseEventHandler | undefined; onDoubleClick?: React.MouseEventHandler | undefined; onDoubleClickCapture?: React.MouseEventHandler | undefined; onDrag?: React.DragEventHandler | undefined; onDragCapture?: React.DragEventHandler | undefined; onDragEnd?: React.DragEventHandler | undefined; onDragEndCapture?: React.DragEventHandler | undefined; onDragEnter?: React.DragEventHandler | undefined; onDragEnterCapture?: React.DragEventHandler | undefined; onDragExit?: React.DragEventHandler | undefined; onDragExitCapture?: React.DragEventHandler | undefined; onDragLeave?: React.DragEventHandler | undefined; onDragLeaveCapture?: React.DragEventHandler | undefined; onDragOver?: React.DragEventHandler | undefined; onDragOverCapture?: React.DragEventHandler | undefined; onDragStart?: React.DragEventHandler | undefined; onDragStartCapture?: React.DragEventHandler | undefined; onDrop?: React.DragEventHandler | undefined; onDropCapture?: React.DragEventHandler | undefined; onMouseDown?: React.MouseEventHandler | undefined; onMouseDownCapture?: React.MouseEventHandler | undefined; onMouseEnter?: React.MouseEventHandler | undefined; onMouseLeave?: React.MouseEventHandler | undefined; onMouseMove?: React.MouseEventHandler | undefined; onMouseMoveCapture?: React.MouseEventHandler | undefined; onMouseOut?: React.MouseEventHandler | undefined; onMouseOutCapture?: React.MouseEventHandler | undefined; onMouseOver?: React.MouseEventHandler | undefined; onMouseOverCapture?: React.MouseEventHandler | undefined; onMouseUp?: React.MouseEventHandler | undefined; onMouseUpCapture?: React.MouseEventHandler | undefined; onSelect?: React.ReactEventHandler | undefined; onSelectCapture?: React.ReactEventHandler | undefined; onTouchCancel?: React.TouchEventHandler | undefined; onTouchCancelCapture?: React.TouchEventHandler | undefined; onTouchEnd?: React.TouchEventHandler | undefined; onTouchEndCapture?: React.TouchEventHandler | undefined; onTouchMove?: React.TouchEventHandler | undefined; onTouchMoveCapture?: React.TouchEventHandler | undefined; onTouchStart?: React.TouchEventHandler | undefined; onTouchStartCapture?: React.TouchEventHandler | undefined; onPointerDown?: React.PointerEventHandler | undefined; onPointerDownCapture?: React.PointerEventHandler | undefined; onPointerMove?: React.PointerEventHandler | undefined; onPointerMoveCapture?: React.PointerEventHandler | undefined; onPointerUp?: React.PointerEventHandler | undefined; onPointerUpCapture?: React.PointerEventHandler | undefined; onPointerCancel?: React.PointerEventHandler | undefined; onPointerCancelCapture?: React.PointerEventHandler | undefined; onPointerEnter?: React.PointerEventHandler | undefined; onPointerEnterCapture?: React.PointerEventHandler | undefined; onPointerLeave?: React.PointerEventHandler | undefined; onPointerLeaveCapture?: React.PointerEventHandler | undefined; onPointerOver?: React.PointerEventHandler | undefined; onPointerOverCapture?: React.PointerEventHandler | undefined; onPointerOut?: React.PointerEventHandler | undefined; onPointerOutCapture?: React.PointerEventHandler | undefined; onGotPointerCapture?: React.PointerEventHandler | undefined; onGotPointerCaptureCapture?: React.PointerEventHandler | undefined; onLostPointerCapture?: React.PointerEventHandler | undefined; onLostPointerCaptureCapture?: React.PointerEventHandler | undefined; onScroll?: React.UIEventHandler | undefined; onScrollCapture?: React.UIEventHandler | undefined; onWheel?: React.WheelEventHandler | undefined; onWheelCapture?: React.WheelEventHandler | undefined; onAnimationStart?: React.AnimationEventHandler | undefined; onAnimationStartCapture?: React.AnimationEventHandler | undefined; onAnimationEnd?: React.AnimationEventHandler | undefined; onAnimationEndCapture?: React.AnimationEventHandler | undefined; onAnimationIteration?: React.AnimationEventHandler | undefined; onAnimationIterationCapture?: React.AnimationEventHandler | undefined; onTransitionEnd?: React.TransitionEventHandler | undefined; onTransitionEndCapture?: React.TransitionEventHandler | undefined; 'data-test-subj'?: string | undefined; render?: ((value: any, record: ", + "; defaultValue?: string | number | readonly string[] | undefined; hidden?: boolean | undefined; defaultChecked?: boolean | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; contentEditable?: Booleanish | \"inherit\" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: Booleanish | undefined; lang?: string | undefined; placeholder?: string | undefined; slot?: string | undefined; spellCheck?: Booleanish | undefined; style?: React.CSSProperties | undefined; tabIndex?: number | undefined; translate?: \"yes\" | \"no\" | undefined; radioGroup?: string | undefined; role?: React.AriaRole | undefined; about?: string | undefined; datatype?: string | undefined; inlist?: any; prefix?: string | undefined; property?: string | undefined; resource?: string | undefined; typeof?: string | undefined; vocab?: string | undefined; autoCapitalize?: string | undefined; autoCorrect?: string | undefined; autoSave?: string | undefined; itemProp?: string | undefined; itemScope?: boolean | undefined; itemType?: string | undefined; itemID?: string | undefined; itemRef?: string | undefined; results?: number | undefined; unselectable?: \"on\" | \"off\" | undefined; inputMode?: \"none\" | \"email\" | \"search\" | \"text\" | \"tel\" | \"url\" | \"numeric\" | \"decimal\" | undefined; is?: string | undefined; 'aria-activedescendant'?: string | undefined; 'aria-atomic'?: boolean | \"true\" | \"false\" | undefined; 'aria-autocomplete'?: \"none\" | \"list\" | \"inline\" | \"both\" | undefined; 'aria-busy'?: boolean | \"true\" | \"false\" | undefined; 'aria-checked'?: boolean | \"mixed\" | \"true\" | \"false\" | undefined; 'aria-colcount'?: number | undefined; 'aria-colindex'?: number | undefined; 'aria-colspan'?: number | undefined; 'aria-controls'?: string | undefined; 'aria-current'?: boolean | \"date\" | \"page\" | \"time\" | \"true\" | \"false\" | \"step\" | \"location\" | undefined; 'aria-describedby'?: string | undefined; 'aria-details'?: string | undefined; 'aria-disabled'?: boolean | \"true\" | \"false\" | undefined; 'aria-dropeffect'?: \"none\" | \"copy\" | \"link\" | \"execute\" | \"move\" | \"popup\" | undefined; 'aria-errormessage'?: string | undefined; 'aria-expanded'?: boolean | \"true\" | \"false\" | undefined; 'aria-flowto'?: string | undefined; 'aria-grabbed'?: boolean | \"true\" | \"false\" | undefined; 'aria-haspopup'?: boolean | \"grid\" | \"menu\" | \"true\" | \"false\" | \"dialog\" | \"listbox\" | \"tree\" | undefined; 'aria-hidden'?: boolean | \"true\" | \"false\" | undefined; 'aria-invalid'?: boolean | \"true\" | \"false\" | \"grammar\" | \"spelling\" | undefined; 'aria-keyshortcuts'?: string | undefined; 'aria-label'?: string | undefined; 'aria-labelledby'?: string | undefined; 'aria-level'?: number | undefined; 'aria-live'?: \"off\" | \"assertive\" | \"polite\" | undefined; 'aria-modal'?: boolean | \"true\" | \"false\" | undefined; 'aria-multiline'?: boolean | \"true\" | \"false\" | undefined; 'aria-multiselectable'?: boolean | \"true\" | \"false\" | undefined; 'aria-orientation'?: \"horizontal\" | \"vertical\" | undefined; 'aria-owns'?: string | undefined; 'aria-placeholder'?: string | undefined; 'aria-posinset'?: number | undefined; 'aria-pressed'?: boolean | \"mixed\" | \"true\" | \"false\" | undefined; 'aria-readonly'?: boolean | \"true\" | \"false\" | undefined; 'aria-relevant'?: \"all\" | \"text\" | \"additions\" | \"additions removals\" | \"additions text\" | \"removals\" | \"removals additions\" | \"removals text\" | \"text additions\" | \"text removals\" | undefined; 'aria-required'?: boolean | \"true\" | \"false\" | undefined; 'aria-roledescription'?: string | undefined; 'aria-rowcount'?: number | undefined; 'aria-rowindex'?: number | undefined; 'aria-rowspan'?: number | undefined; 'aria-selected'?: boolean | \"true\" | \"false\" | undefined; 'aria-setsize'?: number | undefined; 'aria-sort'?: \"none\" | \"other\" | \"ascending\" | \"descending\" | undefined; 'aria-valuemax'?: number | undefined; 'aria-valuemin'?: number | undefined; 'aria-valuenow'?: number | undefined; 'aria-valuetext'?: string | undefined; dangerouslySetInnerHTML?: { __html: string; } | undefined; onCopy?: React.ClipboardEventHandler | undefined; onCopyCapture?: React.ClipboardEventHandler | undefined; onCut?: React.ClipboardEventHandler | undefined; onCutCapture?: React.ClipboardEventHandler | undefined; onPaste?: React.ClipboardEventHandler | undefined; onPasteCapture?: React.ClipboardEventHandler | undefined; onCompositionEnd?: React.CompositionEventHandler | undefined; onCompositionEndCapture?: React.CompositionEventHandler | undefined; onCompositionStart?: React.CompositionEventHandler | undefined; onCompositionStartCapture?: React.CompositionEventHandler | undefined; onCompositionUpdate?: React.CompositionEventHandler | undefined; onCompositionUpdateCapture?: React.CompositionEventHandler | undefined; onFocus?: React.FocusEventHandler | undefined; onFocusCapture?: React.FocusEventHandler | undefined; onBlur?: React.FocusEventHandler | undefined; onBlurCapture?: React.FocusEventHandler | undefined; onChangeCapture?: React.FormEventHandler | undefined; onBeforeInput?: React.FormEventHandler | undefined; onBeforeInputCapture?: React.FormEventHandler | undefined; onInput?: React.FormEventHandler | undefined; onInputCapture?: React.FormEventHandler | undefined; onReset?: React.FormEventHandler | undefined; onResetCapture?: React.FormEventHandler | undefined; onSubmit?: React.FormEventHandler | undefined; onSubmitCapture?: React.FormEventHandler | undefined; onInvalid?: React.FormEventHandler | undefined; onInvalidCapture?: React.FormEventHandler | undefined; onLoad?: React.ReactEventHandler | undefined; onLoadCapture?: React.ReactEventHandler | undefined; onError?: React.ReactEventHandler | undefined; onErrorCapture?: React.ReactEventHandler | undefined; onKeyDownCapture?: React.KeyboardEventHandler | undefined; onKeyPress?: React.KeyboardEventHandler | undefined; onKeyPressCapture?: React.KeyboardEventHandler | undefined; onKeyUp?: React.KeyboardEventHandler | undefined; onKeyUpCapture?: React.KeyboardEventHandler | undefined; onAbort?: React.ReactEventHandler | undefined; onAbortCapture?: React.ReactEventHandler | undefined; onCanPlay?: React.ReactEventHandler | undefined; onCanPlayCapture?: React.ReactEventHandler | undefined; onCanPlayThrough?: React.ReactEventHandler | undefined; onCanPlayThroughCapture?: React.ReactEventHandler | undefined; onDurationChange?: React.ReactEventHandler | undefined; onDurationChangeCapture?: React.ReactEventHandler | undefined; onEmptied?: React.ReactEventHandler | undefined; onEmptiedCapture?: React.ReactEventHandler | undefined; onEncrypted?: React.ReactEventHandler | undefined; onEncryptedCapture?: React.ReactEventHandler | undefined; onEnded?: React.ReactEventHandler | undefined; onEndedCapture?: React.ReactEventHandler | undefined; onLoadedData?: React.ReactEventHandler | undefined; onLoadedDataCapture?: React.ReactEventHandler | undefined; onLoadedMetadata?: React.ReactEventHandler | undefined; onLoadedMetadataCapture?: React.ReactEventHandler | undefined; onLoadStart?: React.ReactEventHandler | undefined; onLoadStartCapture?: React.ReactEventHandler | undefined; onPause?: React.ReactEventHandler | undefined; onPauseCapture?: React.ReactEventHandler | undefined; onPlay?: React.ReactEventHandler | undefined; onPlayCapture?: React.ReactEventHandler | undefined; onPlaying?: React.ReactEventHandler | undefined; onPlayingCapture?: React.ReactEventHandler | undefined; onProgress?: React.ReactEventHandler | undefined; onProgressCapture?: React.ReactEventHandler | undefined; onRateChange?: React.ReactEventHandler | undefined; onRateChangeCapture?: React.ReactEventHandler | undefined; onSeeked?: React.ReactEventHandler | undefined; onSeekedCapture?: React.ReactEventHandler | undefined; onSeeking?: React.ReactEventHandler | undefined; onSeekingCapture?: React.ReactEventHandler | undefined; onStalled?: React.ReactEventHandler | undefined; onStalledCapture?: React.ReactEventHandler | undefined; onSuspend?: React.ReactEventHandler | undefined; onSuspendCapture?: React.ReactEventHandler | undefined; onTimeUpdate?: React.ReactEventHandler | undefined; onTimeUpdateCapture?: React.ReactEventHandler | undefined; onVolumeChange?: React.ReactEventHandler | undefined; onVolumeChangeCapture?: React.ReactEventHandler | undefined; onWaiting?: React.ReactEventHandler | undefined; onWaitingCapture?: React.ReactEventHandler | undefined; onAuxClick?: React.MouseEventHandler | undefined; onAuxClickCapture?: React.MouseEventHandler | undefined; onClickCapture?: React.MouseEventHandler | undefined; onContextMenu?: React.MouseEventHandler | undefined; onContextMenuCapture?: React.MouseEventHandler | undefined; onDoubleClick?: React.MouseEventHandler | undefined; onDoubleClickCapture?: React.MouseEventHandler | undefined; onDrag?: React.DragEventHandler | undefined; onDragCapture?: React.DragEventHandler | undefined; onDragEnd?: React.DragEventHandler | undefined; onDragEndCapture?: React.DragEventHandler | undefined; onDragEnter?: React.DragEventHandler | undefined; onDragEnterCapture?: React.DragEventHandler | undefined; onDragExit?: React.DragEventHandler | undefined; onDragExitCapture?: React.DragEventHandler | undefined; onDragLeave?: React.DragEventHandler | undefined; onDragLeaveCapture?: React.DragEventHandler | undefined; onDragOver?: React.DragEventHandler | undefined; onDragOverCapture?: React.DragEventHandler | undefined; onDragStart?: React.DragEventHandler | undefined; onDragStartCapture?: React.DragEventHandler | undefined; onDrop?: React.DragEventHandler | undefined; onDropCapture?: React.DragEventHandler | undefined; onMouseDown?: React.MouseEventHandler | undefined; onMouseDownCapture?: React.MouseEventHandler | undefined; onMouseEnter?: React.MouseEventHandler | undefined; onMouseLeave?: React.MouseEventHandler | undefined; onMouseMove?: React.MouseEventHandler | undefined; onMouseMoveCapture?: React.MouseEventHandler | undefined; onMouseOut?: React.MouseEventHandler | undefined; onMouseOutCapture?: React.MouseEventHandler | undefined; onMouseOver?: React.MouseEventHandler | undefined; onMouseOverCapture?: React.MouseEventHandler | undefined; onMouseUp?: React.MouseEventHandler | undefined; onMouseUpCapture?: React.MouseEventHandler | undefined; onSelect?: React.ReactEventHandler | undefined; onSelectCapture?: React.ReactEventHandler | undefined; onTouchCancel?: React.TouchEventHandler | undefined; onTouchCancelCapture?: React.TouchEventHandler | undefined; onTouchEnd?: React.TouchEventHandler | undefined; onTouchEndCapture?: React.TouchEventHandler | undefined; onTouchMove?: React.TouchEventHandler | undefined; onTouchMoveCapture?: React.TouchEventHandler | undefined; onTouchStart?: React.TouchEventHandler | undefined; onTouchStartCapture?: React.TouchEventHandler | undefined; onPointerDown?: React.PointerEventHandler | undefined; onPointerDownCapture?: React.PointerEventHandler | undefined; onPointerMove?: React.PointerEventHandler | undefined; onPointerMoveCapture?: React.PointerEventHandler | undefined; onPointerUp?: React.PointerEventHandler | undefined; onPointerUpCapture?: React.PointerEventHandler | undefined; onPointerCancel?: React.PointerEventHandler | undefined; onPointerCancelCapture?: React.PointerEventHandler | undefined; onPointerEnter?: React.PointerEventHandler | undefined; onPointerEnterCapture?: React.PointerEventHandler | undefined; onPointerLeave?: React.PointerEventHandler | undefined; onPointerLeaveCapture?: React.PointerEventHandler | undefined; onPointerOver?: React.PointerEventHandler | undefined; onPointerOverCapture?: React.PointerEventHandler | undefined; onPointerOut?: React.PointerEventHandler | undefined; onPointerOutCapture?: React.PointerEventHandler | undefined; onGotPointerCapture?: React.PointerEventHandler | undefined; onGotPointerCaptureCapture?: React.PointerEventHandler | undefined; onLostPointerCapture?: React.PointerEventHandler | undefined; onLostPointerCaptureCapture?: React.PointerEventHandler | undefined; onScroll?: React.UIEventHandler | undefined; onScrollCapture?: React.UIEventHandler | undefined; onWheel?: React.WheelEventHandler | undefined; onWheelCapture?: React.WheelEventHandler | undefined; onAnimationStart?: React.AnimationEventHandler | undefined; onAnimationStartCapture?: React.AnimationEventHandler | undefined; onAnimationEnd?: React.AnimationEventHandler | undefined; onAnimationEndCapture?: React.AnimationEventHandler | undefined; onAnimationIteration?: React.AnimationEventHandler | undefined; onAnimationIterationCapture?: React.AnimationEventHandler | undefined; onTransitionEnd?: React.TransitionEventHandler | undefined; onTransitionEndCapture?: React.TransitionEventHandler | undefined; 'data-test-subj'?: string | undefined; render?: ((value: any, record: ", { "pluginId": "savedObjectsManagement", "scope": "public", @@ -294,7 +294,7 @@ "section": "def-public.SavedObjectsManagementRecord", "text": "SavedObjectsManagementRecord" }, - ") => React.ReactNode) | undefined; width?: string | undefined; readOnly?: boolean | undefined; align?: ", + ") => React.ReactNode) | undefined; height?: string | number | undefined; width?: string | undefined; readOnly?: boolean | undefined; align?: ", "HorizontalAlignment", " | undefined; abbr?: string | undefined; footer?: string | React.ReactElement> | ((props: ", "EuiTableFooterProps", @@ -669,6 +669,62 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectManagementTypeInfo", + "type": "Interface", + "tags": [], + "label": "SavedObjectManagementTypeInfo", + "description": [], + "path": "src/plugins/saved_objects_management/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectManagementTypeInfo.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "src/plugins/saved_objects_management/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectManagementTypeInfo.namespaceType", + "type": "CompoundType", + "tags": [], + "label": "namespaceType", + "description": [], + "signature": [ + "\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\"" + ], + "path": "src/plugins/saved_objects_management/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectManagementTypeInfo.hidden", + "type": "boolean", + "tags": [], + "label": "hidden", + "description": [], + "path": "src/plugins/saved_objects_management/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectManagementTypeInfo.displayName", + "type": "string", + "tags": [], + "label": "displayName", + "description": [], + "path": "src/plugins/saved_objects_management/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "savedObjectsManagement", "id": "def-public.SavedObjectMetadata", @@ -1272,6 +1328,178 @@ ], "path": "src/plugins/saved_objects_management/public/plugin.ts", "deprecated": false + }, + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectsManagementPluginStart.getAllowedTypes", + "type": "Function", + "tags": [], + "label": "getAllowedTypes", + "description": [], + "signature": [ + "() => Promise<", + { + "pluginId": "savedObjectsManagement", + "scope": "common", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-common.SavedObjectManagementTypeInfo", + "text": "SavedObjectManagementTypeInfo" + }, + "[]>" + ], + "path": "src/plugins/saved_objects_management/public/plugin.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectsManagementPluginStart.getRelationships", + "type": "Function", + "tags": [], + "label": "getRelationships", + "description": [], + "signature": [ + "(type: string, id: string, savedObjectTypes: string[]) => Promise<", + { + "pluginId": "savedObjectsManagement", + "scope": "common", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-common.SavedObjectGetRelationshipsResponse", + "text": "SavedObjectGetRelationshipsResponse" + }, + ">" + ], + "path": "src/plugins/saved_objects_management/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectsManagementPluginStart.getRelationships.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/saved_objects_management/public/plugin.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectsManagementPluginStart.getRelationships.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/saved_objects_management/public/plugin.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectsManagementPluginStart.getRelationships.$3", + "type": "Array", + "tags": [], + "label": "savedObjectTypes", + "description": [], + "signature": [ + "string[]" + ], + "path": "src/plugins/saved_objects_management/public/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectsManagementPluginStart.getSavedObjectLabel", + "type": "Function", + "tags": [], + "label": "getSavedObjectLabel", + "description": [], + "signature": [ + "(type: string, types: ", + { + "pluginId": "savedObjectsManagement", + "scope": "common", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-common.SavedObjectManagementTypeInfo", + "text": "SavedObjectManagementTypeInfo" + }, + "[]) => string" + ], + "path": "src/plugins/saved_objects_management/public/plugin.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectsManagementPluginStart.getSavedObjectLabel.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "src/plugins/saved_objects_management/public/lib/get_saved_object_label.ts", + "deprecated": false + }, + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectsManagementPluginStart.getSavedObjectLabel.$2", + "type": "Array", + "tags": [], + "label": "types", + "description": [], + "signature": [ + { + "pluginId": "savedObjectsManagement", + "scope": "common", + "docId": "kibSavedObjectsManagementPluginApi", + "section": "def-common.SavedObjectManagementTypeInfo", + "text": "SavedObjectManagementTypeInfo" + }, + "[]" + ], + "path": "src/plugins/saved_objects_management/public/lib/get_saved_object_label.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectsManagementPluginStart.getDefaultTitle", + "type": "Function", + "tags": [], + "label": "getDefaultTitle", + "description": [], + "signature": [ + "(object: { id: string; type: string; }) => string" + ], + "path": "src/plugins/saved_objects_management/public/plugin.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "savedObjectsManagement", + "id": "def-public.SavedObjectsManagementPluginStart.getDefaultTitle.$1", + "type": "Object", + "tags": [], + "label": "object", + "description": [], + "signature": [ + "{ id: string; type: string; }" + ], + "path": "src/plugins/saved_objects_management/public/lib/get_default_title.ts", + "deprecated": false + } + ] } ], "lifecycle": "start", diff --git a/api_docs/saved_objects_management.mdx b/api_docs/saved_objects_management.mdx index 0f610adb83a73..195617e70af50 100644 --- a/api_docs/saved_objects_management.mdx +++ b/api_docs/saved_objects_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsManagement title: "savedObjectsManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsManagement plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsManagement'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 110 | 0 | 97 | 0 | +| 125 | 0 | 112 | 0 | ## Client diff --git a/api_docs/saved_objects_tagging.devdocs.json b/api_docs/saved_objects_tagging.devdocs.json index 59c5af0040df1..0500a6eb89beb 100644 --- a/api_docs/saved_objects_tagging.devdocs.json +++ b/api_docs/saved_objects_tagging.devdocs.json @@ -86,10 +86,1104 @@ "server": { "classes": [], "functions": [], - "interfaces": [], + "interfaces": [ + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.CreateTagAssignmentServiceOptions", + "type": "Interface", + "tags": [], + "label": "CreateTagAssignmentServiceOptions", + "description": [], + "path": "x-pack/plugins/saved_objects_tagging/server/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.CreateTagAssignmentServiceOptions.client", + "type": "Object", + "tags": [], + "label": "client", + "description": [], + "signature": [ + "{ create: (type: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + "SavedObject", + ">; bulkCreate: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">; checkConflicts: (objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsResponse", + "text": "SavedObjectsCheckConflictsResponse" + }, + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; find: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">; bulkGet: (objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">; bulkResolve: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResolveObject", + "text": "SavedObjectsBulkResolveObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResolveResponse", + "text": "SavedObjectsBulkResolveResponse" + }, + ">; get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; resolve: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + ">; update: (type: string, id: string, attributes: Partial, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + ">; collectMultiNamespaceReferences: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", + "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" + }, + ">; updateObjectsSpaces: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "text": "SavedObjectsUpdateObjectsSpacesObject" + }, + "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "text": "SavedObjectsUpdateObjectsSpacesResponse" + }, + ">; bulkUpdate: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" + }, + ">; removeReferencesTo: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + ">; openPointInTimeForType: (type: string | string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeResponse", + "text": "SavedObjectsOpenPointInTimeResponse" + }, + ">; closePointInTime: (id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" + }, + ">; createPointInTimeFinder: (findOptions: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "text": "SavedObjectsCreatePointInTimeFinderOptions" + }, + ", dependencies?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectsPointInTimeFinder", + "text": "ISavedObjectsPointInTimeFinder" + }, + "; errors: typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + "; }" + ], + "path": "x-pack/plugins/saved_objects_tagging/server/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.CreateTagClientOptions", + "type": "Interface", + "tags": [], + "label": "CreateTagClientOptions", + "description": [], + "path": "x-pack/plugins/saved_objects_tagging/server/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.CreateTagClientOptions.client", + "type": "Object", + "tags": [], + "label": "client", + "description": [], + "signature": [ + "{ create: (type: string, attributes: T, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + "SavedObject", + ">; bulkCreate: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">; checkConflicts: (objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCheckConflictsResponse", + "text": "SavedObjectsCheckConflictsResponse" + }, + ">; delete: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + ") => Promise<{}>; find: (options: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">; bulkGet: (objects?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">; bulkResolve: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResolveObject", + "text": "SavedObjectsBulkResolveObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkResolveResponse", + "text": "SavedObjectsBulkResolveResponse" + }, + ">; get: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + "SavedObject", + ">; resolve: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + ">; update: (type: string, id: string, attributes: Partial, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + ">; collectMultiNamespaceReferences: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", + "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" + }, + ">; updateObjectsSpaces: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "text": "SavedObjectsUpdateObjectsSpacesObject" + }, + "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "text": "SavedObjectsUpdateObjectsSpacesResponse" + }, + ">; bulkUpdate: (objects: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" + }, + ">; removeReferencesTo: (type: string, id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + ">; openPointInTimeForType: (type: string | string[], options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + ") => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeResponse", + "text": "SavedObjectsOpenPointInTimeResponse" + }, + ">; closePointInTime: (id: string, options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" + }, + ">; createPointInTimeFinder: (findOptions: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "text": "SavedObjectsCreatePointInTimeFinderOptions" + }, + ", dependencies?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" + }, + " | undefined) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectsPointInTimeFinder", + "text": "ISavedObjectsPointInTimeFinder" + }, + "; errors: typeof ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsErrorHelpers", + "text": "SavedObjectsErrorHelpers" + }, + "; }" + ], + "path": "x-pack/plugins/saved_objects_tagging/server/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.ITagsClient", + "type": "Interface", + "tags": [], + "label": "ITagsClient", + "description": [], + "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.ITagsClient.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "(attributes: ", + { + "pluginId": "savedObjectsTaggingOss", + "scope": "common", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-common.TagAttributes", + "text": "TagAttributes" + }, + ") => Promise<", + { + "pluginId": "savedObjectsTaggingOss", + "scope": "common", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-common.Tag", + "text": "Tag" + }, + ">" + ], + "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.ITagsClient.create.$1", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + { + "pluginId": "savedObjectsTaggingOss", + "scope": "common", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-common.TagAttributes", + "text": "TagAttributes" + } + ], + "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.ITagsClient.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "(id: string) => Promise<", + { + "pluginId": "savedObjectsTaggingOss", + "scope": "common", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-common.Tag", + "text": "Tag" + }, + ">" + ], + "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.ITagsClient.get.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.ITagsClient.getAll", + "type": "Function", + "tags": [], + "label": "getAll", + "description": [], + "signature": [ + "(options?: ", + { + "pluginId": "savedObjectsTaggingOss", + "scope": "common", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-common.GetAllTagsOptions", + "text": "GetAllTagsOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "savedObjectsTaggingOss", + "scope": "common", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-common.Tag", + "text": "Tag" + }, + "[]>" + ], + "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.ITagsClient.getAll.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "savedObjectsTaggingOss", + "scope": "common", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-common.GetAllTagsOptions", + "text": "GetAllTagsOptions" + }, + " | undefined" + ], + "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.ITagsClient.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [], + "signature": [ + "(id: string) => Promise" + ], + "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.ITagsClient.delete.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.ITagsClient.update", + "type": "Function", + "tags": [], + "label": "update", + "description": [], + "signature": [ + "(id: string, attributes: ", + { + "pluginId": "savedObjectsTaggingOss", + "scope": "common", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-common.TagAttributes", + "text": "TagAttributes" + }, + ") => Promise<", + { + "pluginId": "savedObjectsTaggingOss", + "scope": "common", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-common.Tag", + "text": "Tag" + }, + ">" + ], + "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.ITagsClient.update.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.ITagsClient.update.$2", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + { + "pluginId": "savedObjectsTaggingOss", + "scope": "common", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-common.TagAttributes", + "text": "TagAttributes" + } + ], + "path": "src/plugins/saved_objects_tagging_oss/common/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], "enums": [], - "misc": [], - "objects": [] + "misc": [ + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.IAssignmentService", + "type": "Type", + "tags": [], + "label": "IAssignmentService", + "description": [], + "signature": [ + "{ findAssignableObjects: ({ search, types, maxResults, }: ", + "FindAssignableObjectsOptions", + ") => Promise<", + "AssignableObject", + "[]>; getAssignableTypes: (types?: string[] | undefined) => Promise; updateTagAssignments: ({ tags, assign, unassign }: ", + "UpdateTagAssignmentsOptions", + ") => Promise; }" + ], + "path": "x-pack/plugins/saved_objects_tagging/server/services/assignments/assignment_service.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [], + "start": { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.SavedObjectTaggingStart", + "type": "Interface", + "tags": [], + "label": "SavedObjectTaggingStart", + "description": [], + "path": "x-pack/plugins/saved_objects_tagging/server/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.SavedObjectTaggingStart.createTagClient", + "type": "Function", + "tags": [], + "label": "createTagClient", + "description": [ + "\nCreates a TagClient bound to the provided SavedObject client." + ], + "signature": [ + "(options: ", + { + "pluginId": "savedObjectsTagging", + "scope": "server", + "docId": "kibSavedObjectsTaggingPluginApi", + "section": "def-server.CreateTagClientOptions", + "text": "CreateTagClientOptions" + }, + ") => ", + { + "pluginId": "savedObjectsTaggingOss", + "scope": "common", + "docId": "kibSavedObjectsTaggingOssPluginApi", + "section": "def-common.ITagsClient", + "text": "ITagsClient" + } + ], + "path": "x-pack/plugins/saved_objects_tagging/server/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.SavedObjectTaggingStart.createTagClient.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "savedObjectsTagging", + "scope": "server", + "docId": "kibSavedObjectsTaggingPluginApi", + "section": "def-server.CreateTagClientOptions", + "text": "CreateTagClientOptions" + } + ], + "path": "x-pack/plugins/saved_objects_tagging/server/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.SavedObjectTaggingStart.createInternalAssignmentService", + "type": "Function", + "tags": [], + "label": "createInternalAssignmentService", + "description": [ + "\nCreates an internal AssignmentService bound to the provided SavedObject client.\n" + ], + "signature": [ + "(options: ", + { + "pluginId": "savedObjectsTagging", + "scope": "server", + "docId": "kibSavedObjectsTaggingPluginApi", + "section": "def-server.CreateTagAssignmentServiceOptions", + "text": "CreateTagAssignmentServiceOptions" + }, + ") => ", + { + "pluginId": "savedObjectsTagging", + "scope": "server", + "docId": "kibSavedObjectsTaggingPluginApi", + "section": "def-server.IAssignmentService", + "text": "IAssignmentService" + } + ], + "path": "x-pack/plugins/saved_objects_tagging/server/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "savedObjectsTagging", + "id": "def-server.SavedObjectTaggingStart.createInternalAssignmentService.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "savedObjectsTagging", + "scope": "server", + "docId": "kibSavedObjectsTaggingPluginApi", + "section": "def-server.CreateTagAssignmentServiceOptions", + "text": "CreateTagAssignmentServiceOptions" + } + ], + "path": "x-pack/plugins/saved_objects_tagging/server/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "lifecycle": "start", + "initialIsOpen": true + } }, "common": { "classes": [], diff --git a/api_docs/saved_objects_tagging.mdx b/api_docs/saved_objects_tagging.mdx index e8b5d1d6a8d6b..7df65d6384cba 100644 --- a/api_docs/saved_objects_tagging.mdx +++ b/api_docs/saved_objects_tagging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTagging title: "savedObjectsTagging" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTagging plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTagging'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 54 | 0 | 50 | 0 | +| 76 | 0 | 70 | 3 | ## Client @@ -28,6 +28,17 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que ### Interfaces +## Server + +### Start + + +### Interfaces + + +### Consts, variables and types + + ## Common ### Functions diff --git a/api_docs/saved_objects_tagging_oss.mdx b/api_docs/saved_objects_tagging_oss.mdx index ed29900a22d7a..9098ec908eb52 100644 --- a/api_docs/saved_objects_tagging_oss.mdx +++ b/api_docs/saved_objects_tagging_oss.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTaggingOss title: "savedObjectsTaggingOss" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTaggingOss plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTaggingOss'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/screenshot_mode.mdx b/api_docs/screenshot_mode.mdx index 5782e32098b7f..5b05c998cb210 100644 --- a/api_docs/screenshot_mode.mdx +++ b/api_docs/screenshot_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotMode title: "screenshotMode" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotMode plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotMode'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/screenshotting.devdocs.json b/api_docs/screenshotting.devdocs.json index 7b1a506b3accb..61fae68af4724 100644 --- a/api_docs/screenshotting.devdocs.json +++ b/api_docs/screenshotting.devdocs.json @@ -518,6 +518,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "screenshotting", + "id": "def-common.PLUGIN_ID", + "type": "string", + "tags": [], + "label": "PLUGIN_ID", + "description": [], + "signature": [ + "\"screenshotting\"" + ], + "path": "x-pack/plugins/screenshotting/common/index.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "screenshotting", "id": "def-common.SCREENSHOTTING_APP_ID", diff --git a/api_docs/screenshotting.mdx b/api_docs/screenshotting.mdx index c61700bd608f0..69bd8874e10a6 100644 --- a/api_docs/screenshotting.mdx +++ b/api_docs/screenshotting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotting title: "screenshotting" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotting plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotting'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 27 | 0 | 7 | 4 | +| 28 | 0 | 8 | 4 | ## Client diff --git a/api_docs/security.devdocs.json b/api_docs/security.devdocs.json index 0ec0a8dd5653a..ba359731956a5 100644 --- a/api_docs/security.devdocs.json +++ b/api_docs/security.devdocs.json @@ -1214,7 +1214,7 @@ "section": "def-server.KibanaRequest", "text": "KibanaRequest" }, - ", params: ", + ", createParams: ", { "pluginId": "security", "scope": "server", @@ -1394,70 +1394,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "security", - "id": "def-server.CreateAPIKeyParams", - "type": "Interface", - "tags": [], - "label": "CreateAPIKeyParams", - "description": [ - "\nRepresents the params for creating an API key" - ], - "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "security", - "id": "def-server.CreateAPIKeyParams.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts", - "deprecated": false - }, - { - "parentPluginId": "security", - "id": "def-server.CreateAPIKeyParams.role_descriptors", - "type": "Object", - "tags": [], - "label": "role_descriptors", - "description": [], - "signature": [ - "{ [x: string]: any; }" - ], - "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts", - "deprecated": false - }, - { - "parentPluginId": "security", - "id": "def-server.CreateAPIKeyParams.expiration", - "type": "string", - "tags": [], - "label": "expiration", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts", - "deprecated": false - }, - { - "parentPluginId": "security", - "id": "def-server.CreateAPIKeyParams.metadata", - "type": "Object", - "tags": [], - "label": "metadata", - "description": [], - "signature": [ - "Record | undefined" - ], - "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "security", "id": "def-server.CreateAPIKeyResult", @@ -1701,6 +1637,22 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "security", + "id": "def-server.CreateAPIKeyParams", + "type": "Type", + "tags": [], + "label": "CreateAPIKeyParams", + "description": [ + "\nRepresents the params for creating an API key" + ], + "signature": [ + "Omit & ((Pick, \"role_descriptors\"> & { kibana_role_descriptors?: undefined; }) | (Pick, \"kibana_role_descriptors\"> & { role_descriptors?: undefined; }))" + ], + "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "security", "id": "def-server.ROUTE_TAG_CAN_REDIRECT", @@ -1774,6 +1726,10 @@ "plugin": "actions", "path": "x-pack/plugins/actions/server/plugin.ts" }, + { + "plugin": "data", + "path": "src/plugins/data/server/search/session/session_service.ts" + }, { "plugin": "cloud", "path": "x-pack/plugins/cloud/server/routes/chat.ts" @@ -1782,10 +1738,6 @@ "plugin": "ml", "path": "x-pack/plugins/ml/server/routes/annotations.ts" }, - { - "plugin": "dataEnhanced", - "path": "x-pack/plugins/data_enhanced/server/search/session/session_service.ts" - }, { "plugin": "logstash", "path": "x-pack/plugins/logstash/server/routes/pipeline/save.ts" diff --git a/api_docs/security.mdx b/api_docs/security.mdx index bcb2ef6b82133..66e878e0ee30e 100644 --- a/api_docs/security.mdx +++ b/api_docs/security.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/security title: "security" image: https://source.unsplash.com/400x175/?github summary: API docs for the security plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'security'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Platform Security](https://github.com/orgs/elastic/teams/kibana-securit | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 183 | 0 | 103 | 0 | +| 179 | 0 | 99 | 0 | ## Client diff --git a/api_docs/security_solution.devdocs.json b/api_docs/security_solution.devdocs.json index 07770d1883ef0..b510d12d18d8f 100644 --- a/api_docs/security_solution.devdocs.json +++ b/api_docs/security_solution.devdocs.json @@ -62,7 +62,7 @@ "label": "experimentalFeatures", "description": [], "signature": [ - "{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly usersEnabled: boolean; readonly detectionResponseEnabled: boolean; readonly disableIsolationUIPendingStatuses: boolean; readonly riskyHostsEnabled: boolean; readonly riskyUsersEnabled: boolean; readonly pendingActionResponsesWithAck: boolean; readonly policyListEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly responseActionsConsoleEnabled: boolean; }" + "{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly usersEnabled: boolean; readonly detectionResponseEnabled: boolean; readonly disableIsolationUIPendingStatuses: boolean; readonly riskyHostsEnabled: boolean; readonly riskyUsersEnabled: boolean; readonly pendingActionResponsesWithAck: boolean; readonly policyListEnabled: boolean; readonly groupedNavigation: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly responseActionsConsoleEnabled: boolean; }" ], "path": "x-pack/plugins/security_solution/public/plugin.tsx", "deprecated": false @@ -876,6 +876,68 @@ "deprecated": false, "children": [], "returnComment": [] + }, + { + "parentPluginId": "securitySolution", + "id": "def-server.SecuritySolutionApiRequestHandlerContext.getInternalFleetServices", + "type": "Function", + "tags": [], + "label": "getInternalFleetServices", + "description": [], + "signature": [ + "() => ", + "EndpointInternalFleetServicesInterface" + ], + "path": "x-pack/plugins/security_solution/server/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "securitySolution", + "id": "def-server.SecuritySolutionApiRequestHandlerContext.getScopedFleetServices", + "type": "Function", + "tags": [], + "label": "getScopedFleetServices", + "description": [], + "signature": [ + "(req: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + ") => ", + "EndpointScopedFleetServicesInterface" + ], + "path": "x-pack/plugins/security_solution/server/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-server.SecuritySolutionApiRequestHandlerContext.getScopedFleetServices.$1", + "type": "Object", + "tags": [], + "label": "req", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreHttpPluginApi", + "section": "def-server.KibanaRequest", + "text": "KibanaRequest" + }, + "" + ], + "path": "x-pack/plugins/security_solution/server/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -891,7 +953,7 @@ "label": "ConfigType", "description": [], "signature": [ - "Readonly<{} & { signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; alertIgnoreFields: string[]; enableExperimental: string[]; packagerTaskInterval: string; prebuiltRulesFromFileSystem: boolean; prebuiltRulesFromSavedObjects: boolean; }> & { experimentalFeatures: Readonly<{ tGridEnabled: boolean; tGridEventRenderedViewEnabled: boolean; excludePoliciesInFilterEnabled: boolean; usersEnabled: boolean; detectionResponseEnabled: boolean; disableIsolationUIPendingStatuses: boolean; riskyHostsEnabled: boolean; riskyUsersEnabled: boolean; pendingActionResponsesWithAck: boolean; policyListEnabled: boolean; previewTelemetryUrlEnabled: boolean; responseActionsConsoleEnabled: boolean; }>; }" + "Readonly<{} & { signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; alertIgnoreFields: string[]; enableExperimental: string[]; packagerTaskInterval: string; prebuiltRulesFromFileSystem: boolean; prebuiltRulesFromSavedObjects: boolean; }> & { experimentalFeatures: Readonly<{ tGridEnabled: boolean; tGridEventRenderedViewEnabled: boolean; excludePoliciesInFilterEnabled: boolean; usersEnabled: boolean; detectionResponseEnabled: boolean; disableIsolationUIPendingStatuses: boolean; riskyHostsEnabled: boolean; riskyUsersEnabled: boolean; pendingActionResponsesWithAck: boolean; policyListEnabled: boolean; groupedNavigation: boolean; previewTelemetryUrlEnabled: boolean; responseActionsConsoleEnabled: boolean; }>; }" ], "path": "x-pack/plugins/security_solution/server/config.ts", "deprecated": false, diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index 12032a091582a..a37edc96d2060 100644 --- a/api_docs/security_solution.mdx +++ b/api_docs/security_solution.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/securitySolution title: "securitySolution" image: https://source.unsplash.com/400x175/?github summary: API docs for the securitySolution plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolution'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Security solution](https://github.com/orgs/elastic/teams/security-solut | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 46 | 0 | 46 | 19 | +| 49 | 0 | 49 | 21 | ## Client diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx index 86ade737ae827..d3b6d17e7624d 100644 --- a/api_docs/session_view.mdx +++ b/api_docs/session_view.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sessionView title: "sessionView" image: https://source.unsplash.com/400x175/?github summary: API docs for the sessionView plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sessionView'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/share.mdx b/api_docs/share.mdx index 571fa5d590783..7b69549f62cf1 100644 --- a/api_docs/share.mdx +++ b/api_docs/share.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/share title: "share" image: https://source.unsplash.com/400x175/?github summary: API docs for the share plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'share'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/shared_u_x.mdx b/api_docs/shared_u_x.mdx index d255d87e8bd8e..a2d2fbc185419 100644 --- a/api_docs/shared_u_x.mdx +++ b/api_docs/shared_u_x.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sharedUX title: "sharedUX" image: https://source.unsplash.com/400x175/?github summary: API docs for the sharedUX plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sharedUX'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/snapshot_restore.devdocs.json b/api_docs/snapshot_restore.devdocs.json index 871ad98b1c9f9..17f513fb71474 100644 --- a/api_docs/snapshot_restore.devdocs.json +++ b/api_docs/snapshot_restore.devdocs.json @@ -90,6 +90,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "snapshotRestore", + "id": "def-common.FEATURE_STATES_NONE_OPTION", + "type": "string", + "tags": [], + "label": "FEATURE_STATES_NONE_OPTION", + "description": [], + "signature": [ + "\"none\"" + ], + "path": "x-pack/plugins/snapshot_restore/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "snapshotRestore", "id": "def-common.MAJOR_VERSION", diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx index ee9d6cb524f39..25e2f00a1770c 100644 --- a/api_docs/snapshot_restore.mdx +++ b/api_docs/snapshot_restore.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/snapshotRestore title: "snapshotRestore" image: https://source.unsplash.com/400x175/?github summary: API docs for the snapshotRestore plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'snapshotRestore'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-ma | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 21 | 1 | 21 | 1 | +| 22 | 1 | 22 | 1 | ## Common diff --git a/api_docs/spaces.mdx b/api_docs/spaces.mdx index 6c7d81d1ad99c..4156c70193c83 100644 --- a/api_docs/spaces.mdx +++ b/api_docs/spaces.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/spaces title: "spaces" image: https://source.unsplash.com/400x175/?github summary: API docs for the spaces plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'spaces'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/stack_alerts.mdx b/api_docs/stack_alerts.mdx index dedfaf95ecd53..1137da3a6a530 100644 --- a/api_docs/stack_alerts.mdx +++ b/api_docs/stack_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/stackAlerts title: "stackAlerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the stackAlerts plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackAlerts'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/task_manager.devdocs.json b/api_docs/task_manager.devdocs.json index 2782bb48ff857..2f1b6c646980b 100644 --- a/api_docs/task_manager.devdocs.json +++ b/api_docs/task_manager.devdocs.json @@ -1054,7 +1054,7 @@ "\nA task instance that has an id and is ready for storage." ], "signature": [ - "{ params: Record; scope?: string[] | undefined; state: Record; taskType: string; }" + "{ params: Record; state: Record; scope?: string[] | undefined; taskType: string; }" ], "path": "x-pack/plugins/task_manager/server/task.ts", "deprecated": false, @@ -1340,7 +1340,7 @@ "TaskScheduling", ", \"schedule\" | \"runNow\" | \"ephemeralRunNow\" | \"ensureScheduled\"> & Pick<", "TaskStore", - ", \"remove\" | \"fetch\" | \"get\"> & { removeIfExists: (id: string) => Promise; } & { supportsEphemeralTasks: () => boolean; }" + ", \"fetch\" | \"get\" | \"remove\"> & { removeIfExists: (id: string) => Promise; } & { supportsEphemeralTasks: () => boolean; }" ], "path": "x-pack/plugins/task_manager/server/plugin.ts", "deprecated": false, diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index 87ff82d41875d..efaf83f850bb4 100644 --- a/api_docs/task_manager.mdx +++ b/api_docs/task_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/taskManager title: "taskManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the taskManager plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index 29c538adcdd73..5fb46d9a614fd 100644 --- a/api_docs/telemetry.mdx +++ b/api_docs/telemetry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetry title: "telemetry" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetry plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetry'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx index 2b4bb32e9071a..866ba5d473b01 100644 --- a/api_docs/telemetry_collection_manager.mdx +++ b/api_docs/telemetry_collection_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionManager title: "telemetryCollectionManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionManager plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionManager'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_collection_xpack.mdx b/api_docs/telemetry_collection_xpack.mdx index dae291cc27ca0..e2a078c59465f 100644 --- a/api_docs/telemetry_collection_xpack.mdx +++ b/api_docs/telemetry_collection_xpack.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionXpack title: "telemetryCollectionXpack" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionXpack plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionXpack'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/telemetry_management_section.mdx b/api_docs/telemetry_management_section.mdx index 0d8f8313d1651..257046f752eca 100644 --- a/api_docs/telemetry_management_section.mdx +++ b/api_docs/telemetry_management_section.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryManagementSection title: "telemetryManagementSection" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryManagementSection plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryManagementSection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/timelines.devdocs.json b/api_docs/timelines.devdocs.json index aa0ca4894966c..f84f20b573e88 100644 --- a/api_docs/timelines.devdocs.json +++ b/api_docs/timelines.devdocs.json @@ -527,7 +527,7 @@ "section": "def-common.ColumnHeaderType", "text": "ColumnHeaderType" }, - "; description?: string | null | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", + "; description?: string | null | undefined; esTypes?: string[] | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", "IFieldSubType", " | undefined; type?: string | undefined; })[]; isLoading: boolean; filterManager: ", { @@ -559,7 +559,7 @@ "section": "def-common.ColumnHeaderType", "text": "ColumnHeaderType" }, - "; description?: string | null | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", + "; description?: string | null | undefined; esTypes?: string[] | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", "IFieldSubType", " | undefined; type?: string | undefined; })[]; isLoading: boolean; filterManager: ", { @@ -1979,30 +1979,30 @@ }, { "parentPluginId": "timelines", - "id": "def-public.useStatusBulkActionItems", + "id": "def-public.useBulkActionItems", "type": "Function", "tags": [], - "label": "useStatusBulkActionItems", + "label": "useBulkActionItems", "description": [], "signature": [ - "({ eventIds, currentStatus, query, indexName, setEventsLoading, setEventsDeleted, onUpdateSuccess, onUpdateFailure, timelineId, }: ", - "StatusBulkActionsProps", + "({ eventIds, currentStatus, query, indexName, setEventsLoading, showAlertStatusActions, setEventsDeleted, onUpdateSuccess, onUpdateFailure, customBulkActions, timelineId, }: ", + "BulkActionsProps", ") => JSX.Element[]" ], - "path": "x-pack/plugins/timelines/public/hooks/use_status_bulk_action_items.tsx", + "path": "x-pack/plugins/timelines/public/hooks/use_bulk_action_items.tsx", "deprecated": false, "children": [ { "parentPluginId": "timelines", - "id": "def-public.useStatusBulkActionItems.$1", + "id": "def-public.useBulkActionItems.$1", "type": "Object", "tags": [], - "label": "{\n eventIds,\n currentStatus,\n query,\n indexName,\n setEventsLoading,\n setEventsDeleted,\n onUpdateSuccess,\n onUpdateFailure,\n timelineId,\n}", + "label": "{\n eventIds,\n currentStatus,\n query,\n indexName,\n setEventsLoading,\n showAlertStatusActions = true,\n setEventsDeleted,\n onUpdateSuccess,\n onUpdateFailure,\n customBulkActions,\n timelineId,\n}", "description": [], "signature": [ - "StatusBulkActionsProps" + "BulkActionsProps" ], - "path": "x-pack/plugins/timelines/public/hooks/use_status_bulk_action_items.tsx", + "path": "x-pack/plugins/timelines/public/hooks/use_bulk_action_items.tsx", "deprecated": false, "isRequired": true } @@ -2057,7 +2057,7 @@ "section": "def-common.ColumnHeaderType", "text": "ColumnHeaderType" }, - "; description?: string | null | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", + "; description?: string | null | undefined; esTypes?: string[] | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", "IFieldSubType", " | undefined; type?: string | undefined; })[]" ], @@ -2608,7 +2608,7 @@ "section": "def-common.ColumnHeaderType", "text": "ColumnHeaderType" }, - "; description?: string | null | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", + "; description?: string | null | undefined; esTypes?: string[] | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", "IFieldSubType", " | undefined; type?: string | undefined; })[]; id: string; filters?: ", "Filter", @@ -2636,7 +2636,7 @@ "section": "def-common.ColumnHeaderType", "text": "ColumnHeaderType" }, - "; description?: string | null | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", + "; description?: string | null | undefined; esTypes?: string[] | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", "IFieldSubType", " | undefined; type?: string | undefined; })[]; savedObjectId: string | null; isLoading: boolean; dataProviders: ", { @@ -3570,6 +3570,19 @@ "path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts", "deprecated": false }, + { + "parentPluginId": "timelines", + "id": "def-common.BrowserField.esTypes", + "type": "Array", + "tags": [], + "label": "esTypes", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts", + "deprecated": false + }, { "parentPluginId": "timelines", "id": "def-common.BrowserField.subType", @@ -3757,7 +3770,7 @@ "section": "def-common.ColumnHeaderType", "text": "ColumnHeaderType" }, - "; description?: string | null | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", + "; description?: string | null | undefined; esTypes?: string[] | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", "IFieldSubType", " | undefined; type?: string | undefined; }" ], @@ -6212,6 +6225,17 @@ "path": "x-pack/plugins/timelines/common/types/timeline/index.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "timelines", + "id": "def-common.TimelineType", + "type": "Enum", + "tags": [], + "label": "TimelineType", + "description": [], + "path": "x-pack/plugins/timelines/common/types/timeline/index.ts", + "deprecated": false, + "initialIsOpen": false } ], "misc": [ @@ -6348,7 +6372,7 @@ "section": "def-common.ColumnHeaderType", "text": "ColumnHeaderType" }, - "; description?: string | null | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", + "; description?: string | null | undefined; esTypes?: string[] | undefined; example?: string | number | null | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ", "IFieldSubType", " | undefined; type?: string | undefined; }" ], @@ -6504,7 +6528,7 @@ "label": "EntityType", "description": [], "signature": [ - "\"alerts\" | \"events\" | \"sessions\"" + "\"sessions\" | \"alerts\" | \"events\"" ], "path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/index.ts", "deprecated": false, diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx index c0002d87729aa..0bcefaf0d0c03 100644 --- a/api_docs/timelines.mdx +++ b/api_docs/timelines.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/timelines title: "timelines" image: https://source.unsplash.com/400x175/?github summary: API docs for the timelines plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'timelines'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Security solution](https://github.com/orgs/elastic/teams/security-solut | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 434 | 1 | 330 | 35 | +| 436 | 1 | 332 | 35 | ## Client diff --git a/api_docs/transform.mdx b/api_docs/transform.mdx index fe76107b5c7af..e347e792da4df 100644 --- a/api_docs/transform.mdx +++ b/api_docs/transform.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/transform title: "transform" image: https://source.unsplash.com/400x175/?github summary: API docs for the transform plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'transform'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/triggers_actions_ui.devdocs.json b/api_docs/triggers_actions_ui.devdocs.json index 5c5963cb8c7bd..66cfb23af2a45 100644 --- a/api_docs/triggers_actions_ui.devdocs.json +++ b/api_docs/triggers_actions_ui.devdocs.json @@ -54,7 +54,7 @@ "label": "experimentalFeatures", "description": [], "signature": [ - "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly internalShareableComponentsSandbox: boolean; readonly rulesDetailLogs: boolean; }" + "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly internalShareableComponentsSandbox: boolean; readonly ruleTagFilter: boolean; readonly ruleStatusFilter: boolean; readonly rulesDetailLogs: boolean; }" ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "deprecated": false @@ -685,13 +685,7 @@ "text": "HttpSetup" }, ", pattern: string) => Promise<", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.IOption", - "text": "IOption" - }, + "IOption", "[]>" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", @@ -766,45 +760,6 @@ "returnComment": [], "initialIsOpen": false }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.getTimeOptions", - "type": "Function", - "tags": [], - "label": "getTimeOptions", - "description": [], - "signature": [ - "(unitSize: number) => { text: string; value: ", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.TIME_UNITS", - "text": "TIME_UNITS" - }, - "; }[]" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_options.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.getTimeOptions.$1", - "type": "number", - "tags": [], - "label": "unitSize", - "description": [], - "signature": [ - "number" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/common/lib/get_time_options.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, { "parentPluginId": "triggersActionsUi", "id": "def-public.getTimeUnitLabel", @@ -962,13 +917,13 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRuleAggregations", + "id": "def-public.loadAllActions", "type": "Function", "tags": [], - "label": "loadRuleAggregations", + "label": "loadAllActions", "description": [], "signature": [ - "({\n http,\n searchText,\n typesFilter,\n actionTypesFilter,\n ruleStatusesFilter,\n}: { http: ", + "({ http }: { http: ", { "pluginId": "core", "scope": "public", @@ -976,26 +931,32 @@ "section": "def-public.HttpSetup", "text": "HttpSetup" }, - "; searchText?: string | undefined; typesFilter?: string[] | undefined; actionTypesFilter?: string[] | undefined; ruleStatusesFilter?: string[] | undefined; }) => Promise<", - "RuleAggregations", - ">" + "; }) => Promise<", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.ActionConnector", + "text": "ActionConnector" + }, + ", Record>[]>" ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connectors.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRuleAggregations.$1", + "id": "def-public.loadAllActions.$1", "type": "Object", "tags": [], - "label": "{\n http,\n searchText,\n typesFilter,\n actionTypesFilter,\n ruleStatusesFilter,\n}", + "label": "{ http }", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connectors.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRuleAggregations.$1.http", + "id": "def-public.loadAllActions.$1.http", "type": "Object", "tags": [], "label": "http", @@ -1009,59 +970,7 @@ "text": "HttpSetup" } ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts", - "deprecated": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRuleAggregations.$1.searchText", - "type": "string", - "tags": [], - "label": "searchText", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts", - "deprecated": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRuleAggregations.$1.typesFilter", - "type": "Array", - "tags": [], - "label": "typesFilter", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts", - "deprecated": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRuleAggregations.$1.actionTypesFilter", - "type": "Array", - "tags": [], - "label": "actionTypesFilter", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts", - "deprecated": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRuleAggregations.$1.ruleStatusesFilter", - "type": "Array", - "tags": [], - "label": "ruleStatusesFilter", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connectors.ts", "deprecated": false } ] @@ -1072,13 +981,71 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRules", + "id": "def-public.loadExecutionLogAggregations", "type": "Function", "tags": [], - "label": "loadRules", + "label": "loadExecutionLogAggregations", + "description": [], + "signature": [ + "({ id, http, dateStart, dateEnd, filter, perPage, page, sort, }: ", + "LoadExecutionLogAggregationsProps", + " & { http: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + }, + "; }) => Promise<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IExecutionLogWithErrorsResult", + "text": "IExecutionLogWithErrorsResult" + }, + ">" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/load_execution_log_aggregations.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.loadExecutionLogAggregations.$1", + "type": "CompoundType", + "tags": [], + "label": "{\n id,\n http,\n dateStart,\n dateEnd,\n filter,\n perPage = 10,\n page = 0,\n sort = [],\n}", + "description": [], + "signature": [ + "LoadExecutionLogAggregationsProps", + " & { http: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + }, + "; }" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/load_execution_log_aggregations.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.loadRule", + "type": "Function", + "tags": [], + "label": "loadRule", "description": [], "signature": [ - "({\n http,\n page,\n searchText,\n typesFilter,\n actionTypesFilter,\n ruleStatusesFilter,\n sort = { field: 'name', direction: 'asc' },\n}: { http: ", + "({\n http,\n ruleId,\n}: { http: ", { "pluginId": "core", "scope": "public", @@ -1086,11 +1053,7 @@ "section": "def-public.HttpSetup", "text": "HttpSetup" }, - "; page: ", - "Pagination", - "; searchText?: string | undefined; typesFilter?: string[] | undefined; actionTypesFilter?: string[] | undefined; ruleStatusesFilter?: string[] | undefined; sort?: ", - "Sorting", - " | undefined; }) => Promise<{ page: number; perPage: number; total: number; data: ", + "; ruleId: string; }) => Promise<", { "pluginId": "triggersActionsUi", "scope": "public", @@ -1106,24 +1069,24 @@ "section": "def-common.RuleTypeParams", "text": "RuleTypeParams" }, - ">[]; }>" + ">>" ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rules.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/get_rule.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRules.$1", + "id": "def-public.loadRule.$1", "type": "Object", "tags": [], - "label": "{\n http,\n page,\n searchText,\n typesFilter,\n actionTypesFilter,\n ruleStatusesFilter,\n sort = { field: 'name', direction: 'asc' },\n}", + "label": "{\n http,\n ruleId,\n}", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rules.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/get_rule.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRules.$1.http", + "id": "def-public.loadRule.$1.http", "type": "Object", "tags": [], "label": "http", @@ -1137,86 +1100,17 @@ "text": "HttpSetup" } ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rules.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/get_rule.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRules.$1.page", - "type": "Object", - "tags": [], - "label": "page", - "description": [], - "signature": [ - "Pagination" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rules.ts", - "deprecated": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRules.$1.searchText", + "id": "def-public.loadRule.$1.ruleId", "type": "string", "tags": [], - "label": "searchText", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rules.ts", - "deprecated": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRules.$1.typesFilter", - "type": "Array", - "tags": [], - "label": "typesFilter", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rules.ts", - "deprecated": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRules.$1.actionTypesFilter", - "type": "Array", - "tags": [], - "label": "actionTypesFilter", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rules.ts", - "deprecated": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRules.$1.ruleStatusesFilter", - "type": "Array", - "tags": [], - "label": "ruleStatusesFilter", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rules.ts", - "deprecated": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.loadRules.$1.sort", - "type": "Object", - "tags": [], - "label": "sort", + "label": "ruleId", "description": [], - "signature": [ - "Sorting", - " | undefined" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rules.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/get_rule.ts", "deprecated": false } ] @@ -1227,65 +1121,34 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.muteRule", + "id": "def-public.loadRuleAggregations", "type": "Function", "tags": [], - "label": "muteRule", + "label": "loadRuleAggregations", "description": [], "signature": [ - "({ id, http }: { id: string; http: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - }, - "; }) => Promise" + "({\n http,\n searchText,\n typesFilter,\n actionTypesFilter,\n ruleExecutionStatusesFilter,\n ruleStatusesFilter,\n tagsFilter,\n}: ", + "LoadRuleAggregationsProps", + ") => Promise<", + "RuleAggregations", + ">" ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.muteRule.$1", + "id": "def-public.loadRuleAggregations.$1", "type": "Object", "tags": [], - "label": "{ id, http }", + "label": "{\n http,\n searchText,\n typesFilter,\n actionTypesFilter,\n ruleExecutionStatusesFilter,\n ruleStatusesFilter,\n tagsFilter,\n}", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", + "signature": [ + "LoadRuleAggregationsProps" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.muteRule.$1.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", - "deprecated": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.muteRule.$1.http", - "type": "Object", - "tags": [], - "label": "http", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } - ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", - "deprecated": false - } - ] + "isRequired": true } ], "returnComment": [], @@ -1293,45 +1156,62 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.OfExpression", + "id": "def-public.loadRules", "type": "Function", "tags": [], - "label": "OfExpression", + "label": "loadRules", "description": [], "signature": [ - "(props: ", - "OfExpressionProps", - ") => JSX.Element" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts", + "({\n http,\n page,\n searchText,\n typesFilter,\n actionTypesFilter,\n ruleExecutionStatusesFilter,\n ruleStatusesFilter,\n tagsFilter,\n sort = { field: 'name', direction: 'asc' },\n}: ", + "LoadRulesProps", + ") => Promise<{ page: number; perPage: number; total: number; data: ", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.Rule", + "text": "Rule" + }, + "<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.RuleTypeParams", + "text": "RuleTypeParams" + }, + ">[]; }>" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rules.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.OfExpression.$1", - "type": "Uncategorized", + "id": "def-public.loadRules.$1", + "type": "Object", "tags": [], - "label": "props", + "label": "{\n http,\n page,\n searchText,\n typesFilter,\n actionTypesFilter,\n ruleExecutionStatusesFilter,\n ruleStatusesFilter,\n tagsFilter,\n sort = { field: 'name', direction: 'asc' },\n}", "description": [], "signature": [ - "T" + "LoadRulesProps" ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx", - "deprecated": false + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rules.ts", + "deprecated": false, + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.snoozeRule", + "id": "def-public.loadRuleSummary", "type": "Function", "tags": [], - "label": "snoozeRule", + "label": "loadRuleSummary", "description": [], "signature": [ - "({\n id,\n snoozeEndTime,\n http,\n}: { id: string; snoozeEndTime: string | -1; http: ", + "({\n http,\n ruleId,\n numberOfExecutions,\n}: { http: ", { "pluginId": "core", "scope": "public", @@ -1339,61 +1219,69 @@ "section": "def-public.HttpSetup", "text": "HttpSetup" }, - "; }) => Promise" + "; ruleId: string; numberOfExecutions?: number | undefined; }) => Promise<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertSummary", + "text": "AlertSummary" + }, + ">" ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rule_summary.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.snoozeRule.$1", + "id": "def-public.loadRuleSummary.$1", "type": "Object", "tags": [], - "label": "{\n id,\n snoozeEndTime,\n http,\n}", + "label": "{\n http,\n ruleId,\n numberOfExecutions,\n}", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rule_summary.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.snoozeRule.$1.id", - "type": "string", + "id": "def-public.loadRuleSummary.$1.http", + "type": "Object", "tags": [], - "label": "id", + "label": "http", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rule_summary.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.snoozeRule.$1.snoozeEndTime", - "type": "CompoundType", + "id": "def-public.loadRuleSummary.$1.ruleId", + "type": "string", "tags": [], - "label": "snoozeEndTime", + "label": "ruleId", "description": [], - "signature": [ - "string | -1" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rule_summary.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.snoozeRule.$1.http", - "type": "Object", + "id": "def-public.loadRuleSummary.$1.numberOfExecutions", + "type": "number", "tags": [], - "label": "http", + "label": "numberOfExecutions", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreHttpPluginApi", - "section": "def-public.HttpSetup", - "text": "HttpSetup" - } + "number | undefined" ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rule_summary.ts", "deprecated": false } ] @@ -1404,45 +1292,71 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.ThresholdExpression", + "id": "def-public.loadRuleTags", "type": "Function", "tags": [], - "label": "ThresholdExpression", + "label": "loadRuleTags", "description": [], "signature": [ - "(props: ", - "ThresholdExpressionProps", - ") => JSX.Element" + "({ http }: { http: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + }, + "; }) => Promise<", + "RuleTagsAggregations", + ">" ], - "path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.ThresholdExpression.$1", - "type": "Uncategorized", + "id": "def-public.loadRuleTags.$1", + "type": "Object", "tags": [], - "label": "props", + "label": "{ http }", "description": [], - "signature": [ - "T" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx", - "deprecated": false + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.loadRuleTags.$1.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/aggregate.ts", + "deprecated": false + } + ] } ], + "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.unmuteRule", + "id": "def-public.loadRuleTypes", "type": "Function", "tags": [], - "label": "unmuteRule", + "label": "loadRuleTypes", "description": [], "signature": [ - "({ id, http }: { id: string; http: ", + "({ http }: { http: ", { "pluginId": "core", "scope": "public", @@ -1450,34 +1364,32 @@ "section": "def-public.HttpSetup", "text": "HttpSetup" }, - "; }) => Promise" + "; }) => Promise<", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.RuleType", + "text": "RuleType" + }, + "[]>" ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rule_types.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.unmuteRule.$1", + "id": "def-public.loadRuleTypes.$1", "type": "Object", "tags": [], - "label": "{ id, http }", + "label": "{ http }", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rule_types.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.unmuteRule.$1.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", - "deprecated": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.unmuteRule.$1.http", + "id": "def-public.loadRuleTypes.$1.http", "type": "Object", "tags": [], "label": "http", @@ -1491,7 +1403,7 @@ "text": "HttpSetup" } ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/rule_types.ts", "deprecated": false } ] @@ -1502,10 +1414,10 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.unsnoozeRule", + "id": "def-public.muteRule", "type": "Function", "tags": [], - "label": "unsnoozeRule", + "label": "muteRule", "description": [], "signature": [ "({ id, http }: { id: string; http: ", @@ -1518,32 +1430,32 @@ }, "; }) => Promise" ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.unsnoozeRule.$1", + "id": "def-public.muteRule.$1", "type": "Object", "tags": [], "label": "{ id, http }", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.unsnoozeRule.$1.id", + "id": "def-public.muteRule.$1.id", "type": "string", "tags": [], "label": "id", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.unsnoozeRule.$1.http", + "id": "def-public.muteRule.$1.http", "type": "Object", "tags": [], "label": "http", @@ -1557,7 +1469,7 @@ "text": "HttpSetup" } ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/mute.ts", "deprecated": false } ] @@ -1568,244 +1480,1028 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.useLoadRuleTypes", + "id": "def-public.OfExpression", "type": "Function", "tags": [], - "label": "useLoadRuleTypes", + "label": "OfExpression", "description": [], "signature": [ - "({ filteredSolutions }: RuleTypesProps) => { ruleTypes: ", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.RuleType", - "text": "RuleType" - }, - "[]; error: string | null; ruleTypeIndex: ", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.RuleTypeIndex", - "text": "RuleTypeIndex" - }, - "; }" + "(props: ", + "OfExpressionProps", + ") => JSX.Element" ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/hooks/use_load_rule_types.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts", "deprecated": false, + "returnComment": [], "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.useLoadRuleTypes.$1", - "type": "Object", + "id": "def-public.OfExpression.$1", + "type": "Uncategorized", "tags": [], - "label": "{ filteredSolutions }", + "label": "props", "description": [], "signature": [ - "RuleTypesProps" + "T" ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/hooks/use_load_rule_types.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.ValueExpression", + "id": "def-public.snoozeRule", "type": "Function", "tags": [], - "label": "ValueExpression", + "label": "snoozeRule", "description": [], "signature": [ - "(props: ", - "ValueExpressionProps", - ") => JSX.Element" + "({\n id,\n snoozeEndTime,\n http,\n}: { id: string; snoozeEndTime: string | -1; http: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + }, + "; }) => Promise" ], - "path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.ValueExpression.$1", - "type": "Uncategorized", + "id": "def-public.snoozeRule.$1", + "type": "Object", "tags": [], - "label": "props", + "label": "{\n id,\n snoozeEndTime,\n http,\n}", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.snoozeRule.$1.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.snoozeRule.$1.snoozeEndTime", + "type": "CompoundType", + "tags": [], + "label": "snoozeEndTime", + "description": [], + "signature": [ + "string | -1" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.snoozeRule.$1.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/snooze.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.suspendedComponentWithProps", + "type": "Function", + "tags": [], + "label": "suspendedComponentWithProps", + "description": [], + "signature": [ + "(ComponentToSuspend: React.ComponentType, size: \"m\" | \"s\" | \"l\" | \"xl\" | \"xxl\" | undefined) => (props: T) => JSX.Element" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.suspendedComponentWithProps.$1", + "type": "CompoundType", + "tags": [], + "label": "ComponentToSuspend", + "description": [], + "signature": [ + "React.ComponentType" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.suspendedComponentWithProps.$2", + "type": "CompoundType", + "tags": [], + "label": "size", + "description": [], + "signature": [ + "\"m\" | \"s\" | \"l\" | \"xl\" | \"xxl\" | undefined" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.ThresholdExpression", + "type": "Function", + "tags": [], + "label": "ThresholdExpression", + "description": [], + "signature": [ + "(props: ", + "ThresholdExpressionProps", + ") => JSX.Element" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.ThresholdExpression.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "T" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unmuteRule", + "type": "Function", + "tags": [], + "label": "unmuteRule", + "description": [], + "signature": [ + "({ id, http }: { id: string; http: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + }, + "; }) => Promise" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unmuteRule.$1", + "type": "Object", + "tags": [], + "label": "{ id, http }", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unmuteRule.$1.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unmuteRule.$1.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unmute.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unsnoozeRule", + "type": "Function", + "tags": [], + "label": "unsnoozeRule", + "description": [], + "signature": [ + "({ id, http }: { id: string; http: ", + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + }, + "; }) => Promise" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unsnoozeRule.$1", + "type": "Object", + "tags": [], + "label": "{ id, http }", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unsnoozeRule.$1.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.unsnoozeRule.$1.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "public", + "docId": "kibCoreHttpPluginApi", + "section": "def-public.HttpSetup", + "text": "HttpSetup" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/rule_api/unsnooze.ts", + "deprecated": false + } + ] + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.useLoadRuleTypes", + "type": "Function", + "tags": [], + "label": "useLoadRuleTypes", + "description": [], + "signature": [ + "({ filteredSolutions }: RuleTypesProps) => { ruleTypes: ", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.RuleType", + "text": "RuleType" + }, + "[]; error: string | null; ruleTypeIndex: ", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.RuleTypeIndex", + "text": "RuleTypeIndex" + }, + "; }" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/hooks/use_load_rule_types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.useLoadRuleTypes.$1", + "type": "Object", + "tags": [], + "label": "{ filteredSolutions }", + "description": [], + "signature": [ + "RuleTypesProps" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/hooks/use_load_rule_types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.ValueExpression", + "type": "Function", + "tags": [], + "label": "ValueExpression", + "description": [], + "signature": [ + "(props: ", + "ValueExpressionProps", + ") => JSX.Element" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.ValueExpression.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "T" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.WhenExpression", + "type": "Function", + "tags": [], + "label": "WhenExpression", + "description": [], + "signature": [ + "(props: ", + "WhenExpressionProps", + ") => JSX.Element" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.WhenExpression.$1", + "type": "Uncategorized", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "T" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.ActionType", + "type": "Interface", + "tags": [], + "label": "ActionType", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.ActionType.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.ActionType.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.ActionType.enabled", + "type": "boolean", + "tags": [], + "label": "enabled", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.ActionType.enabledInConfig", + "type": "boolean", + "tags": [], + "label": "enabledInConfig", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.ActionType.enabledInLicense", + "type": "boolean", + "tags": [], + "label": "enabledInLicense", + "description": [], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.ActionType.minimumLicenseRequired", + "type": "CompoundType", + "tags": [], + "label": "minimumLicenseRequired", + "description": [], + "signature": [ + "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + ], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AggregationType", + "type": "Interface", + "tags": [], + "label": "AggregationType", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AggregationType.text", + "type": "string", + "tags": [], + "label": "text", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AggregationType.fieldRequired", + "type": "boolean", + "tags": [], + "label": "fieldRequired", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AggregationType.value", + "type": "string", + "tags": [], + "label": "value", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AggregationType.validNormalizedTypes", + "type": "Array", + "tags": [], + "label": "validNormalizedTypes", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps", + "type": "Interface", + "tags": [], + "label": "AlertsTableProps", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.columns", + "type": "Array", + "tags": [], + "label": "columns", + "description": [], + "signature": [ + "EuiDataGridColumn", + "[]" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.bulkActions", + "type": "Object", + "tags": [], + "label": "bulkActions", + "description": [], + "signature": [ + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.BulkActionsObjectProp", + "text": "BulkActionsObjectProp" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.deletedEventIds", + "type": "Array", + "tags": [], + "label": "deletedEventIds", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.disabledCellActions", + "type": "Array", + "tags": [], + "label": "disabledCellActions", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.pageSize", + "type": "number", + "tags": [], + "label": "pageSize", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.pageSizeOptions", + "type": "Array", + "tags": [], + "label": "pageSizeOptions", + "description": [], + "signature": [ + "number[]" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.leadingControlColumns", + "type": "Array", + "tags": [], + "label": "leadingControlColumns", + "description": [], + "signature": [ + "EuiDataGridControlColumn", + "[]" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.renderCellValue", + "type": "Function", + "tags": [], + "label": "renderCellValue", + "description": [], + "signature": [ + "(props: ", + "RenderCellValueProps", + ") => React.ReactNode" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.renderCellValue.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "RenderCellValueProps" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.showCheckboxes", + "type": "boolean", + "tags": [], + "label": "showCheckboxes", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.trailingControlColumns", + "type": "Array", + "tags": [], + "label": "trailingControlColumns", + "description": [], + "signature": [ + "EuiDataGridControlColumn", + "[]" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.useFetchAlertsData", + "type": "Function", + "tags": [], + "label": "useFetchAlertsData", + "description": [], + "signature": [ + "() => ", + "FetchAlertData" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.datatestsubj", + "type": "string", + "tags": [], + "label": "'data-test-subj'", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertStatus", + "type": "Interface", + "tags": [], + "label": "AlertStatus", + "description": [], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertStatus.status", + "type": "CompoundType", + "tags": [], + "label": "status", + "description": [], + "signature": [ + "\"OK\" | \"Active\"" + ], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertStatus.muted", + "type": "boolean", + "tags": [], + "label": "muted", + "description": [], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertStatus.actionGroupId", + "type": "string", + "tags": [], + "label": "actionGroupId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertStatus.actionSubgroup", + "type": "string", + "tags": [], + "label": "actionSubgroup", "description": [], "signature": [ - "T" + "string | undefined" ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.WhenExpression", - "type": "Function", - "tags": [], - "label": "WhenExpression", - "description": [], - "signature": [ - "(props: ", - "WhenExpressionProps", - ") => JSX.Element" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/common/expression_items/index.ts", - "deprecated": false, - "returnComment": [], - "children": [ + }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.WhenExpression.$1", - "type": "Uncategorized", + "id": "def-public.AlertStatus.activeStartDate", + "type": "string", "tags": [], - "label": "props", + "label": "activeStartDate", "description": [], "signature": [ - "T" + "string | undefined" ], - "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false } ], "initialIsOpen": false - } - ], - "interfaces": [ + }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.ActionType", + "id": "def-public.AlertSummary", "type": "Interface", "tags": [], - "label": "ActionType", + "label": "AlertSummary", "description": [], - "path": "x-pack/plugins/actions/common/types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.ActionType.id", + "id": "def-public.AlertSummary.id", "type": "string", "tags": [], "label": "id", "description": [], - "path": "x-pack/plugins/actions/common/types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.ActionType.name", + "id": "def-public.AlertSummary.name", "type": "string", "tags": [], "label": "name", "description": [], - "path": "x-pack/plugins/actions/common/types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.ActionType.enabled", - "type": "boolean", + "id": "def-public.AlertSummary.tags", + "type": "Array", "tags": [], - "label": "enabled", + "label": "tags", "description": [], - "path": "x-pack/plugins/actions/common/types.ts", + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.ActionType.enabledInConfig", - "type": "boolean", + "id": "def-public.AlertSummary.ruleTypeId", + "type": "string", "tags": [], - "label": "enabledInConfig", + "label": "ruleTypeId", "description": [], - "path": "x-pack/plugins/actions/common/types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.ActionType.enabledInLicense", + "id": "def-public.AlertSummary.consumer", + "type": "string", + "tags": [], + "label": "consumer", + "description": [], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertSummary.muteAll", "type": "boolean", "tags": [], - "label": "enabledInLicense", + "label": "muteAll", "description": [], - "path": "x-pack/plugins/actions/common/types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.ActionType.minimumLicenseRequired", + "id": "def-public.AlertSummary.throttle", "type": "CompoundType", "tags": [], - "label": "minimumLicenseRequired", + "label": "throttle", "description": [], "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" + "string | null" ], - "path": "x-pack/plugins/actions/common/types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.AggregationType", - "type": "Interface", - "tags": [], - "label": "AggregationType", - "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.AggregationType.text", + "id": "def-public.AlertSummary.enabled", + "type": "boolean", + "tags": [], + "label": "enabled", + "description": [], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertSummary.statusStartDate", "type": "string", "tags": [], - "label": "text", + "label": "statusStartDate", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.AggregationType.fieldRequired", - "type": "boolean", + "id": "def-public.AlertSummary.statusEndDate", + "type": "string", "tags": [], - "label": "fieldRequired", + "label": "statusEndDate", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.AggregationType.value", + "id": "def-public.AlertSummary.status", + "type": "CompoundType", + "tags": [], + "label": "status", + "description": [], + "signature": [ + "\"OK\" | \"Active\" | \"Error\"" + ], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertSummary.lastRun", "type": "string", "tags": [], - "label": "value", + "label": "lastRun", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.AggregationType.validNormalizedTypes", + "id": "def-public.AlertSummary.errorMessages", "type": "Array", "tags": [], - "label": "validNormalizedTypes", + "label": "errorMessages", "description": [], "signature": [ - "string[]" + "{ date: string; message: string; }[]" ], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertSummary.alerts", + "type": "Object", + "tags": [], + "label": "alerts", + "description": [], + "signature": [ + "{ [x: string]: ", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.AlertStatus", + "text": "AlertStatus" + }, + "; }" + ], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", + "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertSummary.executionDuration", + "type": "Object", + "tags": [], + "label": "executionDuration", + "description": [], + "signature": [ + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.ExecutionDuration", + "text": "ExecutionDuration" + } + ], + "path": "x-pack/plugins/alerting/common/alert_summary.ts", "deprecated": false } ], @@ -1813,42 +2509,51 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.Comparator", + "id": "def-public.BulkActionsObjectProp", "type": "Interface", "tags": [], - "label": "Comparator", + "label": "BulkActionsObjectProp", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.Comparator.text", - "type": "string", + "id": "def-public.BulkActionsObjectProp.alertStatusActions", + "type": "CompoundType", "tags": [], - "label": "text", + "label": "alertStatusActions", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.Comparator.value", - "type": "string", + "id": "def-public.BulkActionsObjectProp.onAlertStatusActionSuccess", + "type": "Uncategorized", "tags": [], - "label": "value", + "label": "onAlertStatusActionSuccess", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "signature": [ + "void | undefined" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.Comparator.requiredValues", - "type": "number", + "id": "def-public.BulkActionsObjectProp.onAlertStatusActionFailure", + "type": "Uncategorized", "tags": [], - "label": "requiredValues", + "label": "onAlertStatusActionFailure", "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", + "signature": [ + "void | undefined" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false } ], @@ -1856,17 +2561,17 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.GroupByType", + "id": "def-public.Comparator", "type": "Interface", "tags": [], - "label": "GroupByType", + "label": "Comparator", "description": [], "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "deprecated": false, "children": [ { "parentPluginId": "triggersActionsUi", - "id": "def-public.GroupByType.text", + "id": "def-public.Comparator.text", "type": "string", "tags": [], "label": "text", @@ -1876,17 +2581,7 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.GroupByType.sizeRequired", - "type": "boolean", - "tags": [], - "label": "sizeRequired", - "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", - "deprecated": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.GroupByType.value", + "id": "def-public.Comparator.value", "type": "string", "tags": [], "label": "value", @@ -1896,14 +2591,11 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.GroupByType.validNormalizedTypes", - "type": "Array", + "id": "def-public.Comparator.requiredValues", + "type": "number", "tags": [], - "label": "validNormalizedTypes", + "label": "requiredValues", "description": [], - "signature": [ - "string[]" - ], "path": "x-pack/plugins/triggers_actions_ui/public/common/types.ts", "deprecated": false } @@ -1943,42 +2635,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.IOption", - "type": "Interface", - "tags": [], - "label": "IOption", - "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.IOption.label", - "type": "string", - "tags": [], - "label": "label", - "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", - "deprecated": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.IOption.options", - "type": "Array", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "{ value: string; label: string; }[]" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/common/index_controls/index.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, { "parentPluginId": "triggersActionsUi", "id": "def-public.RuleAction", @@ -2173,7 +2829,7 @@ "label": "actionVariables", "description": [], "signature": [ - "AsActionVariables<\"params\"> & Partial>" + "AsActionVariables<\"params\"> & Partial>" ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false @@ -2371,6 +3027,19 @@ ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.RuleTypeModel.defaultRecoveryMessage", + "type": "string", + "tags": [], + "label": "defaultRecoveryMessage", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -2493,7 +3162,7 @@ "label": "setRuleProperty", "description": [], "signature": [ - "(key: Prop, value: ", + "(key: Prop, value: ", "SanitizedRule", "[Prop] | null) => void" ], @@ -3075,17 +3744,6 @@ } ], "enums": [ - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.AGGREGATION_TYPES", - "type": "Enum", - "tags": [], - "label": "AGGREGATION_TYPES", - "description": [], - "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "triggersActionsUi", "id": "def-public.COMPARATORS", @@ -3181,13 +3839,33 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.ActionVariables", + "id": "def-public.ActionVariables", + "type": "Type", + "tags": [], + "label": "ActionVariables", + "description": [], + "signature": [ + "AsActionVariables<\"params\"> & Partial>" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableConfigurationRegistryContract", "type": "Type", "tags": [], - "label": "ActionVariables", + "label": "AlertsTableConfigurationRegistryContract", "description": [], "signature": [ - "AsActionVariables<\"params\"> & Partial>" + "{ list: () => ", + "AlertsTableConfigurationRegistry", + "[]; get: (id: string) => ", + "AlertsTableConfigurationRegistry", + "; register: (objectType: ", + "AlertsTableConfigurationRegistry", + ") => void; has: (id: string) => boolean; }" ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false, @@ -3209,49 +3887,92 @@ }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.DEFAULT_HIDDEN_ACTION_TYPES", + "id": "def-public.NOTIFY_WHEN_OPTIONS", "type": "Array", "tags": [], - "label": "DEFAULT_HIDDEN_ACTION_TYPES", + "label": "NOTIFY_WHEN_OPTIONS", "description": [], "signature": [ - "string[]" + "EuiSuperSelectOption", + "<\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\">[]" ], - "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/index.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/application/sections/rule_form/rule_notify_when.tsx", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.PLUGIN_ID", - "type": "string", + "id": "def-public.Rule", + "type": "Type", "tags": [], - "label": "PLUGIN_ID", + "label": "Rule", "description": [], "signature": [ - "\"triggersActions\"" + "Omit<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.SanitizedRule", + "text": "SanitizedRule" + }, + ", \"alertTypeId\"> & { ruleTypeId: string; }" ], - "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/index.ts", + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "triggersActionsUi", - "id": "def-public.Rule", + "id": "def-public.RuleEventLogListProps", "type": "Type", "tags": [], - "label": "Rule", + "label": "RuleEventLogListProps", "description": [], "signature": [ - "Omit<", + "{ rule: ", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.Rule", + "text": "Rule" + }, + "<", { "pluginId": "alerting", "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-common.SanitizedRule", - "text": "SanitizedRule" + "section": "def-common.RuleTypeParams", + "text": "RuleTypeParams" }, - ", \"alertTypeId\"> & { ruleTypeId: string; }" + ">; localStorageKey?: string | undefined; refreshToken?: number | undefined; requestRefresh?: (() => Promise) | undefined; customLoadExecutionLogAggregations?: ((props: ", + "LoadExecutionLogAggregationsProps", + ") => Promise<", + { + "pluginId": "alerting", + "scope": "common", + "docId": "kibAlertingPluginApi", + "section": "def-common.IExecutionLogWithErrorsResult", + "text": "IExecutionLogWithErrorsResult" + }, + ">) | undefined; } & Pick<", + "ComponentOpts", + ", \"loadExecutionLogAggregations\">" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list.tsx", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.RuleStatus", + "type": "Type", + "tags": [], + "label": "RuleStatus", + "description": [], + "signature": [ + "\"disabled\" | \"enabled\" | \"snoozed\"" ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false, @@ -3354,20 +4075,6 @@ "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false, "initialIsOpen": false - }, - { - "parentPluginId": "triggersActionsUi", - "id": "def-public.VIEW_LICENSE_OPTIONS_LINK", - "type": "string", - "tags": [], - "label": "VIEW_LICENSE_OPTIONS_LINK", - "description": [], - "signature": [ - "\"https://www.elastic.co/subscriptions\"" - ], - "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/index.ts", - "deprecated": false, - "initialIsOpen": false } ], "objects": [ @@ -3422,13 +4129,7 @@ "label": "value", "description": [], "signature": [ - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.AGGREGATION_TYPES", - "text": "AGGREGATION_TYPES" - } + "AGGREGATION_TYPES" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "deprecated": false @@ -3502,13 +4203,7 @@ "label": "value", "description": [], "signature": [ - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.AGGREGATION_TYPES", - "text": "AGGREGATION_TYPES" - } + "AGGREGATION_TYPES" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "deprecated": false @@ -3569,13 +4264,7 @@ "label": "value", "description": [], "signature": [ - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.AGGREGATION_TYPES", - "text": "AGGREGATION_TYPES" - } + "AGGREGATION_TYPES" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "deprecated": false @@ -3636,13 +4325,7 @@ "label": "value", "description": [], "signature": [ - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.AGGREGATION_TYPES", - "text": "AGGREGATION_TYPES" - } + "AGGREGATION_TYPES" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "deprecated": false @@ -3703,13 +4386,7 @@ "label": "value", "description": [], "signature": [ - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.AGGREGATION_TYPES", - "text": "AGGREGATION_TYPES" - } + "AGGREGATION_TYPES" ], "path": "x-pack/plugins/triggers_actions_ui/public/common/constants/aggregation_types.ts", "deprecated": false @@ -4435,9 +5112,21 @@ "description": [], "signature": [ "(props: ", - "AlertsTableProps", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.AlertsTableProps", + "text": "AlertsTableProps" + }, ") => React.ReactElement<", - "AlertsTableProps", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.AlertsTableProps", + "text": "AlertsTableProps" + }, ", string | React.JSXElementConstructor>" ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", @@ -4451,7 +5140,47 @@ "label": "props", "description": [], "signature": [ - "AlertsTableProps" + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.AlertsTableProps", + "text": "AlertsTableProps" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getAlertsStateTable", + "type": "Function", + "tags": [], + "label": "getAlertsStateTable", + "description": [], + "signature": [ + "(props: ", + "AlertsTableStateProps", + ") => React.ReactElement<", + "AlertsTableStateProps", + ", string | React.JSXElementConstructor>" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getAlertsStateTable.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "AlertsTableStateProps" ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "deprecated": false, @@ -4493,6 +5222,175 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleTagFilter", + "type": "Function", + "tags": [], + "label": "getRuleTagFilter", + "description": [], + "signature": [ + "(props: ", + "RuleTagFilterProps", + ") => React.ReactElement<", + "RuleTagFilterProps", + ", string | React.JSXElementConstructor>" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleTagFilter.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "RuleTagFilterProps" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleStatusFilter", + "type": "Function", + "tags": [], + "label": "getRuleStatusFilter", + "description": [], + "signature": [ + "(props: ", + "RuleStatusFilterProps", + ") => React.ReactElement<", + "RuleStatusFilterProps", + ", string | React.JSXElementConstructor>" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleStatusFilter.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "RuleStatusFilterProps" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleTagBadge", + "type": "Function", + "tags": [], + "label": "getRuleTagBadge", + "description": [], + "signature": [ + "(props: ", + "RuleTagBadgeProps", + ") => React.ReactElement<", + "RuleTagBadgeProps", + ", string | React.JSXElementConstructor>" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleTagBadge.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "RuleTagBadgeProps" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleEventLogList", + "type": "Function", + "tags": [], + "label": "getRuleEventLogList", + "description": [], + "signature": [ + "(props: ", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.RuleEventLogListProps", + "text": "RuleEventLogListProps" + }, + ") => React.ReactElement<", + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.RuleEventLogListProps", + "text": "RuleEventLogListProps" + }, + ", string | React.JSXElementConstructor>" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleEventLogList.$1", + "type": "CompoundType", + "tags": [], + "label": "props", + "description": [], + "signature": [ + { + "pluginId": "triggersActionsUi", + "scope": "public", + "docId": "kibTriggersActionsUiPluginApi", + "section": "def-public.RuleEventLogListProps", + "text": "RuleEventLogListProps" + } + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getRulesList", + "type": "Function", + "tags": [], + "label": "getRulesList", + "description": [], + "signature": [ + "() => React.ReactElement>" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "lifecycle": "start", @@ -4576,7 +5474,7 @@ "label": "CoreQueryParams", "description": [], "signature": [ - "{ readonly termSize?: number | undefined; readonly termField?: string | undefined; readonly aggField?: string | undefined; readonly index: string | string[]; readonly aggType: string; readonly groupBy: string; readonly timeWindowSize: number; readonly timeWindowUnit: string; readonly timeField: string; }" + "{ readonly aggField?: string | undefined; readonly termSize?: number | undefined; readonly termField?: string | undefined; readonly index: string | string[]; readonly aggType: string; readonly timeWindowSize: number; readonly timeWindowUnit: string; readonly groupBy: string; readonly timeField: string; }" ], "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/core_query_types.ts", "deprecated": false, @@ -4632,7 +5530,7 @@ "label": "TimeSeriesQuery", "description": [], "signature": [ - "{ readonly interval?: string | undefined; readonly termSize?: number | undefined; readonly termField?: string | undefined; readonly aggField?: string | undefined; readonly dateStart?: string | undefined; readonly dateEnd?: string | undefined; readonly index: string | string[]; readonly aggType: string; readonly groupBy: string; readonly timeWindowSize: number; readonly timeWindowUnit: string; readonly timeField: string; }" + "{ readonly interval?: string | undefined; readonly aggField?: string | undefined; readonly termSize?: number | undefined; readonly termField?: string | undefined; readonly dateStart?: string | undefined; readonly dateEnd?: string | undefined; readonly index: string | string[]; readonly aggType: string; readonly timeWindowSize: number; readonly timeWindowUnit: string; readonly groupBy: string; readonly timeField: string; }" ], "path": "x-pack/plugins/triggers_actions_ui/server/data/lib/time_series_types.ts", "deprecated": false, @@ -4898,7 +5796,7 @@ "\nParses the string value used in `xpack.trigger_actions_ui.enableExperimental` kibana configuration,\nwhich should be a string of values delimited by a comma (`,`)\n" ], "signature": [ - "(configValue: string[]) => Readonly<{ rulesListDatagrid: boolean; internalAlertsTable: boolean; internalShareableComponentsSandbox: boolean; rulesDetailLogs: boolean; }>" + "(configValue: string[]) => Readonly<{ rulesListDatagrid: boolean; internalAlertsTable: boolean; internalShareableComponentsSandbox: boolean; ruleTagFilter: boolean; ruleStatusFilter: boolean; rulesDetailLogs: boolean; }>" ], "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", "deprecated": false, @@ -5055,7 +5953,7 @@ "label": "ExperimentalFeatures", "description": [], "signature": [ - "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly internalShareableComponentsSandbox: boolean; readonly rulesDetailLogs: boolean; }" + "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly internalShareableComponentsSandbox: boolean; readonly ruleTagFilter: boolean; readonly ruleStatusFilter: boolean; readonly rulesDetailLogs: boolean; }" ], "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", "deprecated": false, @@ -5087,7 +5985,7 @@ "\nA list of allowed values that can be used in `xpack.trigger_actions_ui.enableExperimental`.\nThis object is then used to validate and parse the value entered." ], "signature": [ - "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly internalShareableComponentsSandbox: boolean; readonly rulesDetailLogs: boolean; }" + "{ readonly rulesListDatagrid: boolean; readonly internalAlertsTable: boolean; readonly internalShareableComponentsSandbox: boolean; readonly ruleTagFilter: boolean; readonly ruleStatusFilter: boolean; readonly rulesDetailLogs: boolean; }" ], "path": "x-pack/plugins/triggers_actions_ui/common/experimental_features.ts", "deprecated": false, diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index 20c5152aa8df3..b0933be896e01 100644 --- a/api_docs/triggers_actions_ui.mdx +++ b/api_docs/triggers_actions_ui.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/triggersActionsUi title: "triggersActionsUi" image: https://source.unsplash.com/400x175/?github summary: API docs for the triggersActionsUi plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'triggersActionsUi'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 321 | 0 | 307 | 25 | +| 374 | 0 | 360 | 34 | ## Client diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx index 5038ea2fa6daa..7ac1bf72da390 100644 --- a/api_docs/ui_actions.mdx +++ b/api_docs/ui_actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActions title: "uiActions" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActions plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActions'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ui_actions_enhanced.devdocs.json b/api_docs/ui_actions_enhanced.devdocs.json index 3b0d84d8d7efc..8c21ceb442853 100644 --- a/api_docs/ui_actions_enhanced.devdocs.json +++ b/api_docs/ui_actions_enhanced.devdocs.json @@ -2661,6 +2661,38 @@ } ] }, + { + "parentPluginId": "uiActionsEnhanced", + "id": "def-public.DrilldownDefinition.isConfigurable", + "type": "Function", + "tags": [], + "label": "isConfigurable", + "description": [ + "\nCompatibility check during drilldown creation.\nCould be used to filter out a drilldown if it's not compatible with the current context." + ], + "signature": [ + "((context: FactoryContext) => boolean) | undefined" + ], + "path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "uiActionsEnhanced", + "id": "def-public.DrilldownDefinition.isConfigurable.$1", + "type": "Uncategorized", + "tags": [], + "label": "context", + "description": [], + "signature": [ + "FactoryContext" + ], + "path": "x-pack/plugins/ui_actions_enhanced/public/drilldowns/drilldown_definition.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "uiActionsEnhanced", "id": "def-public.DrilldownDefinition.euiIcon", diff --git a/api_docs/ui_actions_enhanced.mdx b/api_docs/ui_actions_enhanced.mdx index 7aeea3d866aad..24bd693b2f85b 100644 --- a/api_docs/ui_actions_enhanced.mdx +++ b/api_docs/ui_actions_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActionsEnhanced title: "uiActionsEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActionsEnhanced plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 203 | 0 | 141 | 9 | +| 205 | 0 | 142 | 9 | ## Client diff --git a/api_docs/unified_search.devdocs.json b/api_docs/unified_search.devdocs.json index 28d29d8e5f2db..d984b361b46e1 100644 --- a/api_docs/unified_search.devdocs.json +++ b/api_docs/unified_search.devdocs.json @@ -3,6 +3,72 @@ "client": { "classes": [], "functions": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPicker", + "type": "Function", + "tags": [], + "label": "DataViewPicker", + "description": [], + "signature": [ + "({ isMissingCurrent, currentDataViewId, onChangeDataView, onAddField, onDataViewCreated, trigger, selectableProps, showNewMenuTour, }: ", + "DataViewPickerProps", + ") => JSX.Element" + ], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPicker.$1", + "type": "Object", + "tags": [], + "label": "{\n isMissingCurrent,\n currentDataViewId,\n onChangeDataView,\n onAddField,\n onDataViewCreated,\n trigger,\n selectableProps,\n showNewMenuTour,\n}", + "description": [], + "signature": [ + "DataViewPickerProps" + ], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewsList", + "type": "Function", + "tags": [], + "label": "DataViewsList", + "description": [], + "signature": [ + "({\n dataViewsList,\n onChangeDataView,\n currentDataViewId,\n selectableProps,\n searchListInputId,\n}: ", + "DataViewsListProps", + ") => JSX.Element" + ], + "path": "src/plugins/unified_search/public/dataview_picker/dataview_list.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewsList.$1", + "type": "Object", + "tags": [], + "label": "{\n dataViewsList,\n onChangeDataView,\n currentDataViewId,\n selectableProps,\n searchListInputId,\n}", + "description": [], + "signature": [ + "DataViewsListProps" + ], + "path": "src/plugins/unified_search/public/dataview_picker/dataview_list.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "unifiedSearch", "id": "def-public.FilterItem", @@ -552,19 +618,6 @@ "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx", "deprecated": false }, - { - "parentPluginId": "unifiedSearch", - "id": "def-public.QueryStringInputProps.nonKqlModeHelpText", - "type": "string", - "tags": [], - "label": "nonKqlModeHelpText", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/plugins/unified_search/public/query_string_input/query_string_input.tsx", - "deprecated": false - }, { "parentPluginId": "unifiedSearch", "id": "def-public.QueryStringInputProps.autoSubmit", diff --git a/api_docs/unified_search.mdx b/api_docs/unified_search.mdx index 285d17efcba81..5c582da19bdd3 100644 --- a/api_docs/unified_search.mdx +++ b/api_docs/unified_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch title: "unifiedSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-servic | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 79 | 2 | 75 | 11 | +| 82 | 2 | 78 | 13 | ## Client diff --git a/api_docs/unified_search_autocomplete.mdx b/api_docs/unified_search_autocomplete.mdx index f6c59fdec600f..a49b78f67908a 100644 --- a/api_docs/unified_search_autocomplete.mdx +++ b/api_docs/unified_search_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch-autocomplete title: "unifiedSearch.autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch.autocomplete plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-servic | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 79 | 2 | 75 | 11 | +| 82 | 2 | 78 | 13 | ## Client diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx index 3ba684cb1b7fe..fe09a9cb32c88 100644 --- a/api_docs/url_forwarding.mdx +++ b/api_docs/url_forwarding.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/urlForwarding title: "urlForwarding" image: https://source.unsplash.com/400x175/?github summary: API docs for the urlForwarding plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'urlForwarding'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/usage_collection.mdx b/api_docs/usage_collection.mdx index 121a877b20b16..c1e0bb33fe839 100644 --- a/api_docs/usage_collection.mdx +++ b/api_docs/usage_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/usageCollection title: "usageCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the usageCollection plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'usageCollection'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/ux.mdx b/api_docs/ux.mdx index ef94504e31dc9..4110f94fb7e48 100644 --- a/api_docs/ux.mdx +++ b/api_docs/ux.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ux title: "ux" image: https://source.unsplash.com/400x175/?github summary: API docs for the ux plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ux'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_default_editor.devdocs.json b/api_docs/vis_default_editor.devdocs.json index 31fe2478171c1..cf5112446cd85 100644 --- a/api_docs/vis_default_editor.devdocs.json +++ b/api_docs/vis_default_editor.devdocs.json @@ -438,7 +438,7 @@ "label": "LegendSizeSettings", "description": [], "signature": [ - "({ legendSize, onLegendSizeChange, isVerticalLegend, }: LegendSizeSettingsProps) => JSX.Element" + "({ legendSize, onLegendSizeChange, isVerticalLegend, showAutoOption, }: LegendSizeSettingsProps) => JSX.Element" ], "path": "src/plugins/vis_default_editor/public/components/options/legend_size_settings.tsx", "deprecated": false, @@ -448,7 +448,7 @@ "id": "def-public.LegendSizeSettings.$1", "type": "Object", "tags": [], - "label": "{\n legendSize,\n onLegendSizeChange,\n isVerticalLegend,\n}", + "label": "{\n legendSize,\n onLegendSizeChange,\n isVerticalLegend,\n showAutoOption,\n}", "description": [], "signature": [ "LegendSizeSettingsProps" diff --git a/api_docs/vis_default_editor.mdx b/api_docs/vis_default_editor.mdx index 42f51f6f9501c..16d74687338a3 100644 --- a/api_docs/vis_default_editor.mdx +++ b/api_docs/vis_default_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visDefaultEditor title: "visDefaultEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the visDefaultEditor plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visDefaultEditor'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_gauge.mdx b/api_docs/vis_type_gauge.mdx index 15770aeb62c3d..d332d95f26729 100644 --- a/api_docs/vis_type_gauge.mdx +++ b/api_docs/vis_type_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeGauge title: "visTypeGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeGauge plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeGauge'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_heatmap.mdx b/api_docs/vis_type_heatmap.mdx index 6460ab30cde48..45865f8df920e 100644 --- a/api_docs/vis_type_heatmap.mdx +++ b/api_docs/vis_type_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeHeatmap title: "visTypeHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeHeatmap plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeHeatmap'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_pie.mdx b/api_docs/vis_type_pie.mdx index 1e97d6977d0df..2f684b92a7ac1 100644 --- a/api_docs/vis_type_pie.mdx +++ b/api_docs/vis_type_pie.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypePie title: "visTypePie" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypePie plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypePie'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_table.mdx b/api_docs/vis_type_table.mdx index 0bdbae2ed0092..95d0bdd7f8e19 100644 --- a/api_docs/vis_type_table.mdx +++ b/api_docs/vis_type_table.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTable title: "visTypeTable" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTable plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTable'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_timelion.mdx b/api_docs/vis_type_timelion.mdx index 962bbd0c90c3f..f274568753a10 100644 --- a/api_docs/vis_type_timelion.mdx +++ b/api_docs/vis_type_timelion.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimelion title: "visTypeTimelion" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimelion plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimelion'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_timeseries.mdx b/api_docs/vis_type_timeseries.mdx index b26a90a93f8f0..a44c6d12d0b67 100644 --- a/api_docs/vis_type_timeseries.mdx +++ b/api_docs/vis_type_timeseries.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimeseries title: "visTypeTimeseries" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimeseries plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimeseries'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_vega.mdx b/api_docs/vis_type_vega.mdx index e65deb3cea8a9..0f2ce9a848904 100644 --- a/api_docs/vis_type_vega.mdx +++ b/api_docs/vis_type_vega.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVega title: "visTypeVega" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVega plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVega'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_vislib.mdx b/api_docs/vis_type_vislib.mdx index aba082b0dfb43..5e602875fc604 100644 --- a/api_docs/vis_type_vislib.mdx +++ b/api_docs/vis_type_vislib.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVislib title: "visTypeVislib" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVislib plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVislib'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/vis_type_xy.mdx b/api_docs/vis_type_xy.mdx index 8b80289230ed5..56d96e2b40441 100644 --- a/api_docs/vis_type_xy.mdx +++ b/api_docs/vis_type_xy.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeXy title: "visTypeXy" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeXy plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- diff --git a/api_docs/visualizations.devdocs.json b/api_docs/visualizations.devdocs.json index 500393546b819..0955a832d785c 100644 --- a/api_docs/visualizations.devdocs.json +++ b/api_docs/visualizations.devdocs.json @@ -4737,6 +4737,17 @@ } ], "enums": [ + { + "parentPluginId": "visualizations", + "id": "def-public.LegendSize", + "type": "Enum", + "tags": [], + "label": "LegendSize", + "description": [], + "path": "src/plugins/visualizations/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "visualizations", "id": "def-public.VisGroups", @@ -4764,6 +4775,27 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "visualizations", + "id": "def-public.DEFAULT_LEGEND_SIZE", + "type": "string", + "tags": [], + "label": "DEFAULT_LEGEND_SIZE", + "description": [], + "signature": [ + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.LegendSize", + "text": "LegendSize" + }, + ".MEDIUM" + ], + "path": "src/plugins/visualizations/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "visualizations", "id": "def-public.Dimension", @@ -5420,6 +5452,20 @@ } ], "objects": [ + { + "parentPluginId": "visualizations", + "id": "def-public.LegendSizeToPixels", + "type": "Object", + "tags": [], + "label": "LegendSizeToPixels", + "description": [], + "signature": [ + "{ readonly auto: undefined; readonly small: 80; readonly medium: 130; readonly large: 180; readonly xlarge: 230; }" + ], + "path": "src/plugins/visualizations/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "visualizations", "id": "def-public.VIS_EVENT_TO_TRIGGER", @@ -5991,7 +6037,23 @@ "section": "def-common.DatatableColumn", "text": "DatatableColumn" }, - "[]) => ", + "[], defaultColumnFormat: ", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + "> | undefined) => ", { "pluginId": "fieldFormats", "scope": "common", @@ -6053,6 +6115,35 @@ "path": "src/plugins/visualizations/common/utils/accessors.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "visualizations", + "id": "def-common.getFormatByAccessor.$3", + "type": "Object", + "tags": [], + "label": "defaultColumnFormat", + "description": [], + "signature": [ + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.SerializedFieldFormat", + "text": "SerializedFieldFormat" + }, + "<", + { + "pluginId": "fieldFormats", + "scope": "common", + "docId": "kibFieldFormatsPluginApi", + "section": "def-common.FieldFormatParams", + "text": "FieldFormatParams" + }, + "> | undefined" + ], + "path": "src/plugins/visualizations/common/utils/accessors.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [], @@ -6822,8 +6913,41 @@ "initialIsOpen": false } ], - "enums": [], + "enums": [ + { + "parentPluginId": "visualizations", + "id": "def-common.LegendSize", + "type": "Enum", + "tags": [], + "label": "LegendSize", + "description": [], + "path": "src/plugins/visualizations/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + } + ], "misc": [ + { + "parentPluginId": "visualizations", + "id": "def-common.DEFAULT_LEGEND_SIZE", + "type": "string", + "tags": [], + "label": "DEFAULT_LEGEND_SIZE", + "description": [], + "signature": [ + { + "pluginId": "visualizations", + "scope": "common", + "docId": "kibVisualizationsPluginApi", + "section": "def-common.LegendSize", + "text": "LegendSize" + }, + ".MEDIUM" + ], + "path": "src/plugins/visualizations/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "visualizations", "id": "def-common.Dimension", @@ -6877,6 +7001,21 @@ "initialIsOpen": false } ], - "objects": [] + "objects": [ + { + "parentPluginId": "visualizations", + "id": "def-common.LegendSizeToPixels", + "type": "Object", + "tags": [], + "label": "LegendSizeToPixels", + "description": [], + "signature": [ + "{ readonly auto: undefined; readonly small: 80; readonly medium: 130; readonly large: 180; readonly xlarge: 230; }" + ], + "path": "src/plugins/visualizations/common/constants.ts", + "deprecated": false, + "initialIsOpen": false + } + ] } } \ No newline at end of file diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index 992f0475d6f4f..7a0ddbd58caef 100644 --- a/api_docs/visualizations.mdx +++ b/api_docs/visualizations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visualizations title: "visualizations" image: https://source.unsplash.com/400x175/?github summary: API docs for the visualizations plugin -date: 2022-04-26 +date: 2022-05-24 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info. --- @@ -18,7 +18,7 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 365 | 12 | 344 | 14 | +| 372 | 12 | 351 | 14 | ## Client @@ -59,12 +59,18 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) ## Common +### Objects + + ### Functions ### Interfaces +### Enums + + ### Consts, variables and types diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index f0e0e929fad6e..ab4a6630b301e 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -347,7 +347,7 @@ must contain `from` and `to` values (see [horizontal] [[notifications-banner]]`notifications:banner`:: A custom banner intended for temporary notices to all users. Supports -https://help.github.com/en/articles/basic-writing-and-formatting-syntax[Markdown]. +https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax[Markdown]. [[notifications-lifetime-banner]]`notifications:lifetime:banner`:: The duration, in milliseconds, for banner notification displays. The default diff --git a/package.json b/package.json index 644517d2d86d1..35b9926461592 100644 --- a/package.json +++ b/package.json @@ -110,7 +110,7 @@ "@elastic/datemath": "5.0.3", "@elastic/elasticsearch": "npm:@elastic/elasticsearch-canary@8.2.0-canary.2", "@elastic/ems-client": "8.3.2", - "@elastic/eui": "55.1.3", + "@elastic/eui": "55.1.4", "@elastic/filesaver": "1.1.2", "@elastic/node-crypto": "1.2.1", "@elastic/numeral": "^2.5.1", diff --git a/src/core/server/ui_settings/settings/notifications.ts b/src/core/server/ui_settings/settings/notifications.ts index 746f7851a748f..2084dd3207348 100644 --- a/src/core/server/ui_settings/settings/notifications.ts +++ b/src/core/server/ui_settings/settings/notifications.ts @@ -26,7 +26,7 @@ export const getNotificationsSettings = (): Record => 'core.ui_settings.params.notifications.banner.markdownLinkText', values: { markdownLink: - `` + i18n.translate('core.ui_settings.params.notifications.banner.markdownLinkText', { defaultMessage: 'Markdown supported', diff --git a/src/dev/license_checker/config.ts b/src/dev/license_checker/config.ts index 66e2664b2e8b4..84229dab16dd9 100644 --- a/src/dev/license_checker/config.ts +++ b/src/dev/license_checker/config.ts @@ -77,6 +77,6 @@ export const LICENSE_OVERRIDES = { 'jsts@1.6.2': ['Eclipse Distribution License - v 1.0'], // cf. https://github.com/bjornharrtell/jsts '@mapbox/jsonlint-lines-primitives@2.0.2': ['MIT'], // license in readme https://github.com/tmcw/jsonlint '@elastic/ems-client@8.3.2': ['Elastic License 2.0'], - '@elastic/eui@55.1.3': ['SSPL-1.0 OR Elastic License 2.0'], + '@elastic/eui@55.1.4': ['SSPL-1.0 OR Elastic License 2.0'], 'language-subtag-registry@0.3.21': ['CC-BY-4.0'], // retired ODC‑By license https://github.com/mattcg/language-subtag-registry }; diff --git a/src/plugins/dashboard/public/application/top_nav/editor_menu.tsx b/src/plugins/dashboard/public/application/top_nav/editor_menu.tsx index b0d4270c4bca5..5192759f2166a 100644 --- a/src/plugins/dashboard/public/application/top_nav/editor_menu.tsx +++ b/src/plugins/dashboard/public/application/top_nav/editor_menu.tsx @@ -11,6 +11,9 @@ import { EuiContextMenu, EuiContextMenuPanelItemDescriptor, EuiContextMenuItemIcon, + EuiFlexGroup, + EuiFlexItem, + EuiBadge, } from '@elastic/eui'; import { METRIC_TYPE } from '@kbn/analytics'; import { i18n } from '@kbn/i18n'; @@ -124,9 +127,30 @@ export const EditorMenu = ({ dashboardContainer, createNewVisType }: Props) => { }); const getVisTypeMenuItem = (visType: BaseVisType): EuiContextMenuPanelItemDescriptor => { - const { name, title, titleInWizard, description, icon = 'empty', group } = visType; + const { + name, + title, + titleInWizard, + description, + icon = 'empty', + group, + isDeprecated, + } = visType; return { - name: titleInWizard || title, + name: !isDeprecated ? ( + titleInWizard || title + ) : ( + + {titleInWizard || title} + + + {i18n.translate('dashboard.editorMenu.deprecatedTag', { + defaultMessage: 'Deprecated', + })} + + + + ), icon: icon as string, onClick: // not all the agg-based visualizations need to be created via the wizard diff --git a/src/plugins/input_control_vis/public/input_control_vis_type.ts b/src/plugins/input_control_vis/public/input_control_vis_type.ts index c5eb5ad5d91fe..1eb88cc7db3f3 100644 --- a/src/plugins/input_control_vis/public/input_control_vis_type.ts +++ b/src/plugins/input_control_vis/public/input_control_vis_type.ts @@ -21,14 +21,15 @@ export function createInputControlVisTypeDefinition( return { name: 'input_control_vis', title: i18n.translate('inputControl.register.controlsTitle', { - defaultMessage: 'Controls', + defaultMessage: 'Input controls', }), icon: 'controlsHorizontal', group: VisGroups.TOOLS, description: i18n.translate('inputControl.register.controlsDescription', { - defaultMessage: 'Add dropdown menus and range sliders to your dashboard.', + defaultMessage: 'Input controls are deprecated and will be removed in a future version.', }), stage: 'experimental', + isDeprecated: true, visConfig: { defaults: { controls: [], diff --git a/src/plugins/vis_type_markdown/public/__snapshots__/markdown_options.test.tsx.snap b/src/plugins/vis_type_markdown/public/__snapshots__/markdown_options.test.tsx.snap index 03431fe2437b7..6c0413cf380ae 100644 --- a/src/plugins/vis_type_markdown/public/__snapshots__/markdown_options.test.tsx.snap +++ b/src/plugins/vis_type_markdown/public/__snapshots__/markdown_options.test.tsx.snap @@ -39,7 +39,7 @@ exports[`MarkdownOptions should match snapshot 1`] = ` size="xs" > { public readonly icon; public readonly image; public readonly stage; + public readonly isDeprecated; public readonly group; public readonly titleInWizard; public readonly options: VisTypeOptions; @@ -65,6 +66,7 @@ export class BaseVisType { this.editorConfig = defaultsDeep({}, opts.editorConfig, { collections: {} }); this.options = defaultsDeep({}, opts.options, defaultOptions); this.stage = opts.stage ?? 'production'; + this.isDeprecated = opts.isDeprecated ?? false; this.group = opts.group ?? VisGroups.AGGBASED; this.titleInWizard = opts.titleInWizard ?? ''; this.hidden = opts.hidden ?? false; diff --git a/src/plugins/visualizations/public/vis_types/types.ts b/src/plugins/visualizations/public/vis_types/types.ts index 60853afe37e63..73b3f96ab2ea7 100644 --- a/src/plugins/visualizations/public/vis_types/types.ts +++ b/src/plugins/visualizations/public/vis_types/types.ts @@ -194,6 +194,10 @@ export interface VisTypeDefinition { * @default 'production' */ readonly stage?: 'experimental' | 'beta' | 'production'; + /** + * It sets the vis type on a deprecated mode when is true + */ + readonly isDeprecated?: boolean; /** * Describes the experience group that the visualization belongs. * It can be on tools, aggregation based or promoted group. diff --git a/src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts b/src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts index f113a0a212fe6..8e5a4556c7335 100644 --- a/src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts +++ b/src/plugins/visualizations/public/vis_types/vis_type_alias_registry.ts @@ -44,6 +44,7 @@ export interface VisTypeAlias { note?: string; getSupportedTriggers?: () => string[]; stage: VisualizationStage; + isDeprecated?: boolean; appExtensions?: { visualizations: VisualizationsAppExtension; diff --git a/src/plugins/visualizations/public/visualize_app/components/experimental_vis_info.tsx b/src/plugins/visualizations/public/visualize_app/components/experimental_vis_info.tsx index 3cb91537fc91d..039308d233332 100644 --- a/src/plugins/visualizations/public/visualize_app/components/experimental_vis_info.tsx +++ b/src/plugins/visualizations/public/visualize_app/components/experimental_vis_info.tsx @@ -12,26 +12,31 @@ import { FormattedMessage } from '@kbn/i18n-react'; export const InfoComponent = () => { const title = ( - <> - + ); + + const text = ( + - GitHub - - ), - }} - /> - + values={{ + githubLink: ( + + GitHub + + ), + }} + /> ); return ( @@ -41,7 +46,9 @@ export const InfoComponent = () => { size="s" title={title} iconType="beaker" - /> + > + {text} + ); }; diff --git a/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx b/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx index f69f53e4a24ab..4598d2d23e613 100644 --- a/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx +++ b/src/plugins/visualizations/public/visualize_app/components/visualize_editor_common.tsx @@ -128,7 +128,6 @@ export const VisualizeEditorCommon = ({ chartName && (chartNeedsWarning || deprecatedChartsNeedWarning) ? CHARTS_CONFIG_TOKENS[chartName as CHARTS_WITHOUT_SMALL_MULTIPLES] : undefined; - const hasLegacyChartsEnabled = chartToken ? getUISettings().get(chartToken) : true; return ( @@ -151,17 +150,19 @@ export const VisualizeEditorCommon = ({ onAppLeave={onAppLeave} /> )} - {visInstance?.vis?.type?.stage === 'experimental' && } + {visInstance?.vis?.type?.stage === 'experimental' && + !visInstance?.vis?.type?.isDeprecated && } {!hasLegacyChartsEnabled && isSplitChart && chartNeedsWarning && chartToken && chartName && ( )} - {hasLegacyChartsEnabled && deprecatedChartsNeedWarning && chartToken && chartName && ( + {((hasLegacyChartsEnabled && deprecatedChartsNeedWarning && chartToken && chartName) || + visInstance?.vis?.type?.isDeprecated) && ( )} diff --git a/src/plugins/visualizations/public/visualize_app/components/viz_chart_warning.tsx b/src/plugins/visualizations/public/visualize_app/components/viz_chart_warning.tsx index 649f797eaf174..c8030bb39b1f6 100644 --- a/src/plugins/visualizations/public/visualize_app/components/viz_chart_warning.tsx +++ b/src/plugins/visualizations/public/visualize_app/components/viz_chart_warning.tsx @@ -23,7 +23,7 @@ import type { interface Props { chartType: CHART_WITHOUT_SMALL_MULTIPLES | CHART_TO_BE_DEPRECATED; - chartConfigToken: string; + chartConfigToken?: string; mode?: 'old' | 'new'; } @@ -149,11 +149,21 @@ const TimelionWarningFormatMessage: FC = (props) => { ); }; +const ControlsWarningFormatMessage: FC = (props) => { + return ( + + ); +}; + const warningMessages = { [CHARTS_WITHOUT_SMALL_MULTIPLES.heatmap]: HeatmapWarningFormatMessage, [CHARTS_WITHOUT_SMALL_MULTIPLES.gauge]: GaugeWarningFormatMessage, [CHARTS_TO_BE_DEPRECATED.pie]: PieWarningFormatMessage, [CHARTS_TO_BE_DEPRECATED.timelion]: TimelionWarningFormatMessage, + [CHARTS_TO_BE_DEPRECATED.controls]: ControlsWarningFormatMessage, }; export const VizChartWarning: FC = ({ chartType, chartConfigToken, mode }) => { diff --git a/src/plugins/visualizations/public/visualize_app/utils/split_chart_warning_helpers.ts b/src/plugins/visualizations/public/visualize_app/utils/split_chart_warning_helpers.ts index a00ab83669bb8..9476fc32f0cd6 100644 --- a/src/plugins/visualizations/public/visualize_app/utils/split_chart_warning_helpers.ts +++ b/src/plugins/visualizations/public/visualize_app/utils/split_chart_warning_helpers.ts @@ -23,6 +23,7 @@ export const CHARTS_WITHOUT_SMALL_MULTIPLES = { export const CHARTS_TO_BE_DEPRECATED = { pie: 'pie', timelion: 'timelion', + controls: 'input_control_vis', } as const; export type CHARTS_WITHOUT_SMALL_MULTIPLES = $Values; diff --git a/src/plugins/visualizations/public/wizard/group_selection/group_selection.tsx b/src/plugins/visualizations/public/wizard/group_selection/group_selection.tsx index d380c4244ad25..559a38715c487 100644 --- a/src/plugins/visualizations/public/wizard/group_selection/group_selection.tsx +++ b/src/plugins/visualizations/public/wizard/group_selection/group_selection.tsx @@ -26,6 +26,7 @@ import { EuiDescriptionListTitle, EuiDescriptionListDescription, EuiDescriptionList, + EuiBadge, } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; import { DocLinksStart } from '@kbn/core/public'; @@ -224,7 +225,7 @@ const ToolsGroup = ({ visType, onVisTypeSelected, showExperimental }: VisCardPro - + {'titleInWizard' in visType && visType.titleInWizard @@ -232,7 +233,7 @@ const ToolsGroup = ({ visType, onVisTypeSelected, showExperimental }: VisCardPro : visType.title} - {visType.stage === 'experimental' && ( + {visType.stage === 'experimental' && !visType.isDeprecated ? ( + ) : ( + visType.isDeprecated && ( + + + + + + ) )} diff --git a/src/plugins/visualizations/server/plugin.ts b/src/plugins/visualizations/server/plugin.ts index eabea76bd31c9..09ba5c2699519 100644 --- a/src/plugins/visualizations/server/plugin.ts +++ b/src/plugins/visualizations/server/plugin.ts @@ -59,8 +59,7 @@ export class VisualizationsPlugin }), value: true, description: i18n.translate('visualizations.advancedSettings.visualizeEnableLabsText', { - defaultMessage: `Allows users to create, view, and edit visualizations that are in technical preview. - If disabled, only visualizations that are considered production-ready are available to the user.`, + defaultMessage: `When enabled, allows you to create, view, and edit visualizations that are in technical preview. When disabled, only production-ready visualizations are available.`, }), category: ['visualization'], schema: schema.boolean(), diff --git a/test/analytics/__fixtures__/plugins/analytics_plugin_a/public/plugin.ts b/test/analytics/__fixtures__/plugins/analytics_plugin_a/public/plugin.ts index d98fddfc6943b..eaf53a3e86e15 100644 --- a/test/analytics/__fixtures__/plugins/analytics_plugin_a/public/plugin.ts +++ b/test/analytics/__fixtures__/plugins/analytics_plugin_a/public/plugin.ts @@ -7,8 +7,8 @@ */ import { BehaviorSubject, firstValueFrom, ReplaySubject } from 'rxjs'; -import { take, toArray } from 'rxjs/operators'; -import type { Plugin, CoreSetup, TelemetryCounter, CoreStart } from '@kbn/core/public'; +import { takeWhile, tap, toArray } from 'rxjs/operators'; +import type { Plugin, CoreSetup, CoreStart, TelemetryCounter, Event } from '@kbn/core/server'; import type { Action } from './custom_shipper'; import { CustomShipper } from './custom_shipper'; import './types'; @@ -52,10 +52,20 @@ export class AnalyticsPluginA implements Plugin { plugin: 'analyticsPluginA', step: 'setup', }); - + let found = false; window.__analyticsPluginA__ = { - getLastActions: async (takeNumberOfActions: number) => - firstValueFrom(this.actions$.pipe(take(takeNumberOfActions), toArray())), + getActionsUntilReportTestPluginLifecycleEvent: async () => + firstValueFrom( + this.actions$.pipe( + takeWhile(() => !found), + tap(({ action, meta }) => { + found = + action === 'reportEvents' && + meta.find((event: Event) => event.event_type === 'test-plugin-lifecycle'); + }), + toArray() + ) + ), stats, setOptIn(optIn: boolean) { analytics.optIn({ global: { enabled: optIn } }); diff --git a/test/analytics/__fixtures__/plugins/analytics_plugin_a/public/types.ts b/test/analytics/__fixtures__/plugins/analytics_plugin_a/public/types.ts index fd6836bd4d699..197113f5368b6 100644 --- a/test/analytics/__fixtures__/plugins/analytics_plugin_a/public/types.ts +++ b/test/analytics/__fixtures__/plugins/analytics_plugin_a/public/types.ts @@ -12,7 +12,7 @@ import type { Action } from './custom_shipper'; declare global { interface Window { __analyticsPluginA__: { - getLastActions: (takeNumberOfActions: number) => Promise; + getActionsUntilReportTestPluginLifecycleEvent: () => Promise; stats: TelemetryCounter[]; setOptIn: (optIn: boolean) => void; }; diff --git a/test/analytics/__fixtures__/plugins/analytics_plugin_a/server/plugin.ts b/test/analytics/__fixtures__/plugins/analytics_plugin_a/server/plugin.ts index 8ee729a8346bb..cd6f01f9f6384 100644 --- a/test/analytics/__fixtures__/plugins/analytics_plugin_a/server/plugin.ts +++ b/test/analytics/__fixtures__/plugins/analytics_plugin_a/server/plugin.ts @@ -7,9 +7,9 @@ */ import { BehaviorSubject, firstValueFrom, ReplaySubject } from 'rxjs'; -import { take, toArray } from 'rxjs/operators'; +import { takeWhile, tap, toArray } from 'rxjs/operators'; import { schema } from '@kbn/config-schema'; -import type { Plugin, CoreSetup, CoreStart, TelemetryCounter } from '@kbn/core/server'; +import type { Plugin, CoreSetup, CoreStart, TelemetryCounter, Event } from '@kbn/core/server'; import type { Action } from './custom_shipper'; import { CustomShipper } from './custom_shipper'; @@ -79,17 +79,21 @@ export class AnalyticsPluginAPlugin implements Plugin { router.get( { path: '/internal/analytics_plugin_a/actions', - validate: { - query: schema.object({ - takeNumberOfActions: schema.number({ min: 1 }), - }), - }, + validate: false, }, async (context, req, res) => { - const { takeNumberOfActions } = req.query; - - const actions = await firstValueFrom(actions$.pipe(take(takeNumberOfActions), toArray())); - + let found = false; + const actions = await firstValueFrom( + actions$.pipe( + takeWhile(() => !found), + tap(({ action, meta }) => { + found = + action === 'reportEvents' && + meta.find((event: Event) => event.event_type === 'test-plugin-lifecycle'); + }), + toArray() + ) + ); return res.ok({ body: actions }); } ); diff --git a/test/analytics/tests/analytics_from_the_browser.ts b/test/analytics/tests/analytics_from_the_browser.ts index c05492fe30961..3d208a096168a 100644 --- a/test/analytics/tests/analytics_from_the_browser.ts +++ b/test/analytics/tests/analytics_from_the_browser.ts @@ -7,9 +7,9 @@ */ import expect from '@kbn/expect'; -import type { TelemetryCounter } from '@kbn/core/server'; -import { Action } from '@kbn/analytics-plugin-a-plugin/server/custom_shipper'; -import { FtrProviderContext } from '../services'; +import type { Event, TelemetryCounter } from '@kbn/core/server'; +import type { Action } from '@kbn/analytics-plugin-a-plugin/server/custom_shipper'; +import type { FtrProviderContext } from '../services'; import '@kbn/analytics-plugin-a-plugin/public/types'; export default function ({ getService, getPageObjects }: FtrProviderContext) { @@ -30,10 +30,9 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { ); }; - const getActions = async (takeNumberOfActions: number): Promise => { - return await browser.execute( - (count) => window.__analyticsPluginA__.getLastActions(count), - takeNumberOfActions + const getActions = async (): Promise => { + return await browser.execute(() => + window.__analyticsPluginA__.getActionsUntilReportTestPluginLifecycleEvent() ); }; @@ -65,52 +64,69 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) { it('after setting opt-in, it should extend the contexts and send the events', async () => { await ebtUIHelper.setOptIn(true); - const actions = await getActions(3); + const actions = await getActions(); + + const [_, extendContextAction, ...reportEventsActions] = actions; // Validating the remote user_agent because that's the only field that it's added by the FTR plugin. - const context = actions[1].meta; + const context = extendContextAction.meta; expect(context).to.have.property('user_agent'); expect(context.user_agent).to.be.a('string'); + reportEventsActions.forEach((reportEventAction) => { + expect(reportEventAction.action).to.eql('reportEvents'); + // Get the first event type + const initiallyBatchedEventType = reportEventAction.meta[0].event_type; + // Check that all event types in this batch are the same. + reportEventAction.meta.forEach((event: Event) => { + expect(event.event_type).to.eql(initiallyBatchedEventType); + }); + }); + + // Find the action calling to report test-plugin-lifecycle events. + const reportTestPluginLifecycleEventsAction = reportEventsActions.find( + (reportEventAction) => { + return ( + reportEventAction.action === 'reportEvents' && + reportEventAction.meta[0].event_type === 'test-plugin-lifecycle' + ); + } + ); // Some context providers emit very early. We are OK with that. - const initialContext = actions[2].meta[0].context; + const initialContext = reportTestPluginLifecycleEventsAction!.meta[0].context; + + const reportEventContext = reportTestPluginLifecycleEventsAction!.meta[1].context; + + const setupEvent = reportTestPluginLifecycleEventsAction!.meta.findIndex( + (event: Event) => + event.event_type === 'test-plugin-lifecycle' && + event.properties.plugin === 'analyticsPluginA' && + event.properties.step === 'setup' + ); + + const startEvent = reportTestPluginLifecycleEventsAction!.meta.findIndex( + (event: Event) => + event.event_type === 'test-plugin-lifecycle' && + event.properties.plugin === 'analyticsPluginA' && + event.properties.step === 'start' + ); + + expect(setupEvent).to.be.greaterThan(-1); + expect(startEvent).to.be.greaterThan(setupEvent); - const reportEventContext = actions[2].meta[1].context; expect(reportEventContext).to.have.property('user_agent'); expect(reportEventContext.user_agent).to.be.a('string'); - expect(actions).to.eql([ - { action: 'optIn', meta: true }, - { action: 'extendContext', meta: context }, - { - action: 'reportEvents', - meta: [ - { - timestamp: actions[2].meta[0].timestamp, - event_type: 'test-plugin-lifecycle', - context: initialContext, - properties: { plugin: 'analyticsPluginA', step: 'setup' }, - }, - { - timestamp: actions[2].meta[1].timestamp, - event_type: 'test-plugin-lifecycle', - context: reportEventContext, - properties: { plugin: 'analyticsPluginA', step: 'start' }, - }, - ], - }, - ]); - // Testing the FTR helper as well expect(await ebtUIHelper.getLastEvents(2, ['test-plugin-lifecycle'])).to.eql([ { - timestamp: actions[2].meta[0].timestamp, + timestamp: reportTestPluginLifecycleEventsAction!.meta[setupEvent].timestamp, event_type: 'test-plugin-lifecycle', context: initialContext, properties: { plugin: 'analyticsPluginA', step: 'setup' }, }, { - timestamp: actions[2].meta[1].timestamp, + timestamp: reportTestPluginLifecycleEventsAction!.meta[startEvent].timestamp, event_type: 'test-plugin-lifecycle', context: reportEventContext, properties: { plugin: 'analyticsPluginA', step: 'start' }, diff --git a/test/analytics/tests/analytics_from_the_server.ts b/test/analytics/tests/analytics_from_the_server.ts index 820f7e51adc96..3bb771b47de43 100644 --- a/test/analytics/tests/analytics_from_the_server.ts +++ b/test/analytics/tests/analytics_from_the_server.ts @@ -7,9 +7,9 @@ */ import expect from '@kbn/expect'; -import type { TelemetryCounter } from '@kbn/core/server'; -import { Action } from '@kbn/analytics-plugin-a-plugin/server/custom_shipper'; -import { FtrProviderContext } from '../services'; +import type { Event, TelemetryCounter } from '@kbn/core/server'; +import type { Action } from '@kbn/analytics-plugin-a-plugin/server/custom_shipper'; +import type { FtrProviderContext } from '../services'; export default function ({ getService }: FtrProviderContext) { const supertest = getService('supertest'); @@ -27,10 +27,9 @@ export default function ({ getService }: FtrProviderContext) { return resp.body; }; - const getActions = async (takeNumberOfActions: number): Promise => { + const getActions = async (): Promise => { const resp = await supertest .get(`/internal/analytics_plugin_a/actions`) - .query({ takeNumberOfActions }) .set('kbn-xsrf', 'xxx') .expect(200); @@ -59,86 +58,119 @@ export default function ({ getService }: FtrProviderContext) { ]); }); - it('after setting opt-in, it should extend the contexts and send the events', async () => { - await ebtServerHelper.setOptIn(true); + describe('after setting opt-in', () => { + let actions: Action[]; + let context: Action['meta']; - const actions = await getActions(3); + before(async () => { + await ebtServerHelper.setOptIn(true); + actions = await getActions(); + context = actions[1].meta; + }); - // Validating the remote PID because that's the only field that it's added by the FTR plugin. - const context = actions[1].meta; - expect(context).to.have.property('pid'); - expect(context.pid).to.be.a('number'); + it('it should extend the contexts with pid injected by "analytics_plugin_a"', async () => { + // Validating the remote PID because that's the only field that it's added by the FTR plugin. + expect(context).to.have.property('pid'); + expect(context.pid).to.be.a('number'); + }); - // Some context providers emit very early. We are OK with that. - const initialContext = actions[2].meta[0].context; + it('it calls optIn first, then extendContext, followed by reportEvents', async () => { + const [optInAction, extendContextAction, ...reportEventsAction] = actions; + expect(optInAction).to.eql({ action: 'optIn', meta: true }); + expect(extendContextAction).to.eql({ action: 'extendContext', meta: context }); + reportEventsAction.forEach((entry) => expect(entry.action).to.eql('reportEvents')); + }); - const reportEventContext = actions[2].meta[1].context; - expect(context).to.have.property('pid'); - expect(context.pid).to.be.a('number'); + it('Initial calls to reportEvents from cached events group the requests by event_type', async () => { + // We know that after opting-in, the client will send the events in batches, grouped by event-type. + const [, , ...reportEventsActions] = actions; + reportEventsActions.forEach((reportEventAction) => { + expect(reportEventAction.action).to.eql('reportEvents'); + // Get the first event type + const initiallyBatchedEventType = reportEventAction.meta[0].event_type; + // Check that all event types in this batch are the same. + reportEventAction.meta.forEach((event: Event) => { + expect(event.event_type).to.eql(initiallyBatchedEventType); + }); + }); + }); - expect(actions).to.eql([ - { action: 'optIn', meta: true }, - { action: 'extendContext', meta: context }, - { - action: 'reportEvents', - meta: [ - { - timestamp: actions[2].meta[0].timestamp, - event_type: 'test-plugin-lifecycle', - context: initialContext, - properties: { plugin: 'analyticsPluginA', step: 'setup' }, - }, - { - timestamp: actions[2].meta[1].timestamp, - event_type: 'test-plugin-lifecycle', - context: reportEventContext, - properties: { plugin: 'analyticsPluginA', step: 'start' }, - }, - ], - }, - ]); + it('"test-plugin-lifecycle" is received in the expected order of "setup" first, then "start"', async () => { + // We know that after opting-in, the client will send the events in batches, grouped by event-type. + const [, , ...reportEventsActions] = actions; + // Find the action calling to report test-plugin-lifecycle events. + const reportTestPluginLifecycleEventsAction = reportEventsActions.find( + (reportEventAction) => { + return ( + reportEventAction.action === 'reportEvents' && + reportEventAction.meta[0].event_type === 'test-plugin-lifecycle' + ); + } + ); + // Find the setup and start events and validate that they are sent in the correct order. + const initialContext = reportTestPluginLifecycleEventsAction!.meta[0].context; // read this from the reportTestPlugin + const reportEventContext = reportTestPluginLifecycleEventsAction!.meta[1].context; + const setupEvent = reportTestPluginLifecycleEventsAction!.meta.findIndex( + (event: Event) => + event.event_type === 'test-plugin-lifecycle' && + event.properties.plugin === 'analyticsPluginA' && + event.properties.step === 'setup' + ); - // This helps us to also test the helpers - const events = await ebtServerHelper.getLastEvents(2, ['test-plugin-lifecycle']); - expect(events).to.eql([ - { - timestamp: actions[2].meta[0].timestamp, - event_type: 'test-plugin-lifecycle', - context: initialContext, - properties: { plugin: 'analyticsPluginA', step: 'setup' }, - }, - { - timestamp: actions[2].meta[1].timestamp, - event_type: 'test-plugin-lifecycle', - context: reportEventContext, - properties: { plugin: 'analyticsPluginA', step: 'start' }, - }, - ]); + const startEvent = reportTestPluginLifecycleEventsAction!.meta.findIndex( + (event: Event) => + event.event_type === 'test-plugin-lifecycle' && + event.properties.plugin === 'analyticsPluginA' && + event.properties.step === 'start' + ); - const telemetryCounters = await getTelemetryCounters(3); - expect(telemetryCounters).to.eql([ - { - type: 'succeeded', - event_type: 'test-plugin-lifecycle', - source: 'FTR-shipper', - code: '200', - count: 1, - }, - { - type: 'succeeded', - event_type: 'test-plugin-lifecycle', - source: 'FTR-shipper', - code: '200', - count: 1, - }, - { - type: 'sent_to_shipper', - event_type: 'test-plugin-lifecycle', - source: 'client', - code: 'OK', - count: 2, - }, - ]); + expect(setupEvent).to.be.greaterThan(-1); + expect(startEvent).to.be.greaterThan(setupEvent); + + // This helps us to also test the helpers + const events = await ebtServerHelper.getLastEvents(2, ['test-plugin-lifecycle']); + expect(events).to.eql([ + { + timestamp: reportTestPluginLifecycleEventsAction!.meta[setupEvent].timestamp, + event_type: 'test-plugin-lifecycle', + context: initialContext, + properties: { plugin: 'analyticsPluginA', step: 'setup' }, + }, + { + timestamp: reportTestPluginLifecycleEventsAction!.meta[startEvent].timestamp, + event_type: 'test-plugin-lifecycle', + context: reportEventContext, + properties: { plugin: 'analyticsPluginA', step: 'start' }, + }, + ]); + }); + + it('should report the plugin lifecycle events as telemetry counters', async () => { + const telemetryCounters = await getTelemetryCounters(3); + expect(telemetryCounters).to.eql([ + { + type: 'succeeded', + event_type: 'test-plugin-lifecycle', + source: 'FTR-shipper', + code: '200', + count: 1, + }, + { + type: 'succeeded', + event_type: 'test-plugin-lifecycle', + source: 'FTR-shipper', + code: '200', + count: 1, + }, + { + type: 'sent_to_shipper', + event_type: 'test-plugin-lifecycle', + source: 'client', + code: 'OK', + count: 2, + }, + ]); + }); }); }); } diff --git a/x-pack/plugins/cloud_security_posture/common/constants.ts b/x-pack/plugins/cloud_security_posture/common/constants.ts index 360827f7855f0..99e626b328889 100644 --- a/x-pack/plugins/cloud_security_posture/common/constants.ts +++ b/x-pack/plugins/cloud_security_posture/common/constants.ts @@ -5,6 +5,7 @@ * 2.0. */ +export const INFO_ROUTE_PATH = '/internal/cloud_security_posture/setup_status'; export const STATS_ROUTE_PATH = '/internal/cloud_security_posture/stats'; export const FINDINGS_ROUTE_PATH = '/internal/cloud_security_posture/findings'; export const BENCHMARKS_ROUTE_PATH = '/internal/cloud_security_posture/benchmarks'; diff --git a/x-pack/plugins/cloud_security_posture/common/types.ts b/x-pack/plugins/cloud_security_posture/common/types.ts index 110e8c071deff..43269ca39dd31 100644 --- a/x-pack/plugins/cloud_security_posture/common/types.ts +++ b/x-pack/plugins/cloud_security_posture/common/types.ts @@ -47,6 +47,10 @@ export interface ComplianceDashboardData { trend: PostureTrend[]; } +export interface CspSetupStatus { + latestFindingsIndexStatus: 'applicable' | 'inapplicable'; +} + export interface CspRulesStatus { all: number; enabled: number; diff --git a/x-pack/plugins/cloud_security_posture/public/common/api/use_compliance_dashboard_data_api.ts b/x-pack/plugins/cloud_security_posture/public/common/api/use_compliance_dashboard_data_api.ts index 4ab446395686f..feb9cf50ad120 100644 --- a/x-pack/plugins/cloud_security_posture/public/common/api/use_compliance_dashboard_data_api.ts +++ b/x-pack/plugins/cloud_security_posture/public/common/api/use_compliance_dashboard_data_api.ts @@ -5,14 +5,16 @@ * 2.0. */ -import { useQuery } from 'react-query'; -import { useKibana } from '@kbn/kibana-react-plugin/public'; +import { type QueryObserverOptions, useQuery } from 'react-query'; +import { useKibana } from '../hooks/use_kibana'; import { ComplianceDashboardData } from '../../../common/types'; import { STATS_ROUTE_PATH } from '../../../common/constants'; -const getStatsKey = 'csp_dashboard_stats'; +const getStatsKey = ['csp_dashboard_stats']; -export const useComplianceDashboardDataApi = () => { +export const useComplianceDashboardDataApi = ( + options: QueryObserverOptions +) => { const { http } = useKibana().services; - return useQuery([getStatsKey], () => http!.get(STATS_ROUTE_PATH)); + return useQuery(getStatsKey, () => http.get(STATS_ROUTE_PATH), options); }; diff --git a/x-pack/plugins/cloud_security_posture/public/common/api/use_setup_status_api.ts b/x-pack/plugins/cloud_security_posture/public/common/api/use_setup_status_api.ts new file mode 100644 index 0000000000000..c9ca47679942e --- /dev/null +++ b/x-pack/plugins/cloud_security_posture/public/common/api/use_setup_status_api.ts @@ -0,0 +1,18 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { useQuery } from 'react-query'; +import { useKibana } from '../hooks/use_kibana'; +import { CspSetupStatus } from '../../../common/types'; +import { INFO_ROUTE_PATH } from '../../../common/constants'; + +const getCspSetupStatusQueryKey = 'csp_info_key'; + +export const useCspSetupStatusApi = () => { + const { http } = useKibana().services; + return useQuery([getCspSetupStatusQueryKey], () => http.get(INFO_ROUTE_PATH)); +}; diff --git a/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.test.tsx b/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.test.tsx index c191e88a68c3c..82c3d15735049 100644 --- a/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.test.tsx +++ b/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.test.tsx @@ -58,6 +58,8 @@ describe('', () => { jest.resetAllMocks(); // if package installation status is 'not_installed', CspPageTemplate will render a noDataConfig prompt (useCisKubernetesIntegration as jest.Mock).mockImplementation(() => ({ + isSuccess: true, + isLoading: false, data: { item: { status: 'installed' } }, })); }); @@ -99,6 +101,7 @@ describe('', () => { it('renders integrations installation prompt if integration is not installed', () => { (useCisKubernetesIntegration as jest.Mock).mockImplementation(() => ({ isSuccess: true, + isLoading: false, data: { item: { status: 'not_installed' } }, })); diff --git a/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx b/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx index d7dab061742cb..975d5949bbae9 100644 --- a/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx +++ b/x-pack/plugins/cloud_security_posture/public/components/csp_page_template.tsx @@ -168,10 +168,7 @@ export const CspPageTemplate = ({ const cisIntegrationLink = useCISIntegrationLink(); const getNoDataConfig = (): KibanaPageTemplateProps['noDataConfig'] => { - if ( - cisKubernetesPackageInfo?.isSuccess && - cisKubernetesPackageInfo.data.item.status === 'not_installed' - ) { + if (cisKubernetesPackageInfo.data?.item.status !== 'installed') { return getPackageNotInstalledNoDataConfig(cisIntegrationLink); } @@ -180,18 +177,18 @@ export const CspPageTemplate = ({ return kibanaPageTemplateProps.noDataConfig || DEFAULT_NO_DATA_CONFIG; } - // when the consumer didn't pass a query, most likely to handle the render on his own - if (!query) return kibanaPageTemplateProps.noDataConfig; + return kibanaPageTemplateProps.noDataConfig; }; const getTemplate = (): KibanaPageTemplateProps['template'] => { - if (query?.isLoading || query?.isError) return 'centeredContent'; + if (query?.isLoading || query?.isError || cisKubernetesPackageInfo.isLoading) + return 'centeredContent'; return kibanaPageTemplateProps.template || 'default'; }; const render = () => { - if (query?.isLoading) return loadingRender(); + if (query?.isLoading || cisKubernetesPackageInfo.isLoading) return loadingRender(); if (query?.isError) return errorRender(query.error); if (query?.isSuccess) return children; @@ -203,10 +200,10 @@ export const CspPageTemplate = ({ {...DEFAULT_PAGE_PROPS} {...kibanaPageTemplateProps} template={getTemplate()} - noDataConfig={getNoDataConfig()} + noDataConfig={cisKubernetesPackageInfo.isSuccess ? getNoDataConfig() : undefined} > - {cisKubernetesPackageInfo?.data?.item.status === 'installed' && render()} + <>{render()} ); diff --git a/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_charts/compliance_trend_chart.tsx b/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_charts/compliance_trend_chart.tsx deleted file mode 100644 index 4f260d66d073b..0000000000000 --- a/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_charts/compliance_trend_chart.tsx +++ /dev/null @@ -1,36 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import React from 'react'; -import { - Chart, - Settings, - Axis, - timeFormatter, - niceTimeFormatByDay, - AreaSeries, -} from '@elastic/charts'; - -export const ComplianceTrendChart = () => ( - - - - - - -); diff --git a/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_dashboard.test.tsx b/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_dashboard.test.tsx new file mode 100644 index 0000000000000..14d8c60c583ec --- /dev/null +++ b/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_dashboard.test.tsx @@ -0,0 +1,235 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React from 'react'; +import { coreMock } from '@kbn/core/public/mocks'; +import { render, screen } from '@testing-library/react'; +import { TestProvider } from '../../test/test_provider'; +import { ComplianceDashboard } from '..'; +import { useCspSetupStatusApi } from '../../common/api/use_setup_status_api'; +import { NO_DATA_CONFIG_TEXT } from './translations'; +import { useCisKubernetesIntegration } from '../../common/api/use_cis_kubernetes_integration'; +import * as TEXT from './translations'; +import { useComplianceDashboardDataApi } from '../../common/api/use_compliance_dashboard_data_api'; + +jest.mock('../../common/api/use_setup_status_api'); +jest.mock('../../common/api/use_cis_kubernetes_integration'); +jest.mock('../../common/api/use_compliance_dashboard_data_api'); + +const mockDashboardData = { + stats: { + totalFailed: 17, + totalPassed: 155, + totalFindings: 172, + postureScore: 90.1, + }, + groupedFindingsEvaluation: [ + { + name: 'RBAC and Service Accounts', + totalFindings: 104, + totalFailed: 0, + totalPassed: 104, + }, + { + name: 'API Server', + totalFindings: 27, + totalFailed: 11, + totalPassed: 16, + }, + { + name: 'Master Node Configuration Files', + totalFindings: 17, + totalFailed: 1, + totalPassed: 16, + }, + { + name: 'Kubelet', + totalFindings: 11, + totalFailed: 4, + totalPassed: 7, + }, + { + name: 'etcd', + totalFindings: 6, + totalFailed: 0, + totalPassed: 6, + }, + { + name: 'Worker Node Configuration Files', + totalFindings: 5, + totalFailed: 0, + totalPassed: 5, + }, + { + name: 'Scheduler', + totalFindings: 2, + totalFailed: 1, + totalPassed: 1, + }, + ], + clusters: [ + { + meta: { + clusterId: '8f9c5b98-cc02-4827-8c82-316e2cc25870', + benchmarkName: 'CIS Kubernetes V1.20', + lastUpdate: 1653218903921, + }, + stats: { + totalFailed: 17, + totalPassed: 155, + totalFindings: 172, + postureScore: 90.1, + }, + groupedFindingsEvaluation: [ + { + name: 'RBAC and Service Accounts', + totalFindings: 104, + totalFailed: 0, + totalPassed: 104, + }, + { + name: 'API Server', + totalFindings: 27, + totalFailed: 11, + totalPassed: 16, + }, + { + name: 'Master Node Configuration Files', + totalFindings: 17, + totalFailed: 1, + totalPassed: 16, + }, + { + name: 'Kubelet', + totalFindings: 11, + totalFailed: 4, + totalPassed: 7, + }, + { + name: 'etcd', + totalFindings: 6, + totalFailed: 0, + totalPassed: 6, + }, + { + name: 'Worker Node Configuration Files', + totalFindings: 5, + totalFailed: 0, + totalPassed: 5, + }, + { + name: 'Scheduler', + totalFindings: 2, + totalFailed: 1, + totalPassed: 1, + }, + ], + trend: [ + { + timestamp: '2022-05-22T11:03:00.000Z', + totalFindings: 172, + totalFailed: 17, + totalPassed: 155, + postureScore: 90.1, + }, + { + timestamp: '2022-05-22T10:25:00.000Z', + totalFindings: 172, + totalFailed: 17, + totalPassed: 155, + postureScore: 90.1, + }, + ], + }, + ], + trend: [ + { + timestamp: '2022-05-22T11:03:00.000Z', + totalFindings: 172, + totalFailed: 17, + totalPassed: 155, + postureScore: 90.1, + }, + { + timestamp: '2022-05-22T10:25:00.000Z', + totalFindings: 172, + totalFailed: 17, + totalPassed: 155, + postureScore: 90.1, + }, + ], +}; + +describe('', () => { + beforeEach(() => { + jest.resetAllMocks(); + (useCisKubernetesIntegration as jest.Mock).mockImplementation(() => ({ + isSuccess: true, + isLoading: false, + data: { item: { status: 'installed' } }, + })); + }); + + const renderComplianceDashboardPage = () => { + const mockCore = coreMock.createStart(); + + render( + + + + ); + }; + + it('shows noDataConfig when latestFindingsIndexStatus is inapplicable', () => { + (useCspSetupStatusApi as jest.Mock).mockImplementation(() => ({ + data: { latestFindingsIndexStatus: 'inapplicable' }, + })); + (useComplianceDashboardDataApi as jest.Mock).mockImplementation(() => ({ + data: undefined, + })); + + renderComplianceDashboardPage(); + + Object.values(NO_DATA_CONFIG_TEXT).forEach((text) => + expect(screen.getAllByText(text)[0]).toBeInTheDocument() + ); + expect(screen.queryByText(TEXT.CLOUD_POSTURE_SCORE)).not.toBeInTheDocument(); + }); + + it('shows dashboard when latestFindingsIndexStatus is applicable', () => { + (useCspSetupStatusApi as jest.Mock).mockImplementation(() => ({ + isLoading: false, + isSuccess: true, + data: { latestFindingsIndexStatus: 'applicable' }, + })); + + (useComplianceDashboardDataApi as jest.Mock).mockImplementation(() => ({ + isSuccess: true, + isLoading: false, + data: mockDashboardData, + })); + + renderComplianceDashboardPage(); + + [NO_DATA_CONFIG_TEXT.BUTTON_TITLE, NO_DATA_CONFIG_TEXT.DESCRIPTION].forEach((text) => + expect(screen.queryByText(text)).not.toBeInTheDocument() + ); + expect(screen.getByText(TEXT.CLOUD_POSTURE_SCORE)).toBeInTheDocument(); + }); +}); diff --git a/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_dashboard.tsx b/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_dashboard.tsx index f7d73f92809d3..978307d59c5ec 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_dashboard.tsx +++ b/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/compliance_dashboard.tsx @@ -8,6 +8,7 @@ import React from 'react'; import { EuiSpacer, EuiIcon } from '@elastic/eui'; import { type KibanaPageTemplateProps } from '@kbn/kibana-react-plugin/public'; +import { UseQueryResult } from 'react-query'; import { allNavigationItems } from '../../common/navigation/constants'; import { useCspBreadcrumbs } from '../../common/navigation/use_csp_breadcrumbs'; import { SummarySection } from './dashboard_sections/summary_section'; @@ -15,6 +16,7 @@ import { BenchmarksSection } from './dashboard_sections/benchmarks_section'; import { useComplianceDashboardDataApi } from '../../common/api'; import { CspPageTemplate } from '../../components/csp_page_template'; import { CLOUD_POSTURE, NO_DATA_CONFIG_TEXT } from './translations'; +import { useCspSetupStatusApi } from '../../common/api/use_setup_status_api'; const getNoDataConfig = (onClick: () => void): KibanaPageTemplateProps['noDataConfig'] => ({ pageTitle: NO_DATA_CONFIG_TEXT.PAGE_TITLE, @@ -33,21 +35,27 @@ const getNoDataConfig = (onClick: () => void): KibanaPageTemplateProps['noDataCo }); export const ComplianceDashboard = () => { - const getDashboardDataQuery = useComplianceDashboardDataApi(); + const getInfo = useCspSetupStatusApi(); + const isFindingsIndexApplicable = getInfo.data?.latestFindingsIndexStatus === 'applicable'; + const getDashboardData = useComplianceDashboardDataApi({ + enabled: isFindingsIndexApplicable, + }); useCspBreadcrumbs([allNavigationItems.dashboard]); + const pageQuery: UseQueryResult = isFindingsIndexApplicable ? getDashboardData : getInfo; + return ( - {getDashboardDataQuery.data && ( + {getDashboardData.data && ( <> - + - + )} diff --git a/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/dashboard_sections/benchmarks_section.tsx b/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/dashboard_sections/benchmarks_section.tsx index daa154f62aad7..b3543291cd147 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/dashboard_sections/benchmarks_section.tsx +++ b/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/dashboard_sections/benchmarks_section.tsx @@ -63,7 +63,7 @@ export const BenchmarksSection = ({ const shortId = cluster.meta.clusterId.slice(0, 6); return ( - <> + @@ -122,7 +122,7 @@ export const BenchmarksSection = ({ - + ); })} diff --git a/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/translations.ts b/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/translations.ts index b553dee72b7b4..1154d0e55de08 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/translations.ts +++ b/x-pack/plugins/cloud_security_posture/public/pages/compliance_dashboard/translations.ts @@ -85,7 +85,7 @@ export const FINDINGS = i18n.translate('xpack.csp.findings', { export const NO_DATA_CONFIG_TEXT = { PAGE_TITLE: i18n.translate('xpack.csp.complianceDashboard.noDataConfig.pageTitle', { - defaultMessage: 'Cloud Security Compliance Dashboard', + defaultMessage: 'Cloud Posture Dashboard', }), SOLUTION: i18n.translate('xpack.csp.complianceDashboard.noDataConfig.solutionNameLabel', { defaultMessage: 'Cloud Security Posture', @@ -94,6 +94,7 @@ export const NO_DATA_CONFIG_TEXT = { defaultMessage: 'Try Again', }), DESCRIPTION: i18n.translate('xpack.csp.complianceDashboard.noDataConfig.actionDescription', { - defaultMessage: 'You can try to refetch your data', + defaultMessage: + "The cloud posture dashboard can't be presented since there are no findings. This can happen due to the agent not being installed yet, or since data is still being processed.", }), }; diff --git a/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings_by_resource/use_findings_by_resource.ts b/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings_by_resource/use_findings_by_resource.ts index e2da77c8ba2a2..d78b2568f7e5d 100644 --- a/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings_by_resource/use_findings_by_resource.ts +++ b/x-pack/plugins/cloud_security_posture/public/pages/findings/latest_findings_by_resource/use_findings_by_resource.ts @@ -13,8 +13,8 @@ import { useKibana } from '../../../common/hooks/use_kibana'; import { showErrorToast } from '../latest_findings/use_latest_findings'; import type { FindingsBaseEsQuery, FindingsQueryResult } from '../types'; -// a large number to probably get all the buckets -const MAX_BUCKETS = 1000 * 1000; +// Maximum number of grouped findings, default limit in elasticsearch is set to 65,536 (ref: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-settings.html#search-settings-max-buckets) +const MAX_BUCKETS = 60 * 1000; interface UseResourceFindingsOptions extends FindingsBaseEsQuery { from: NonNullable; diff --git a/x-pack/plugins/cloud_security_posture/server/routes/index.ts b/x-pack/plugins/cloud_security_posture/server/routes/index.ts index f5c500f24a0dc..143c2e45d5511 100755 --- a/x-pack/plugins/cloud_security_posture/server/routes/index.ts +++ b/x-pack/plugins/cloud_security_posture/server/routes/index.ts @@ -8,6 +8,7 @@ import { defineGetComplianceDashboardRoute } from './compliance_dashboard/compliance_dashboard'; import { defineGetBenchmarksRoute } from './benchmarks/benchmarks'; import { defineUpdateRulesConfigRoute } from './configuration/update_rules_configuration'; +import { defineGetCspSetupStatusRoute } from './setup_status/setup_status'; import { CspAppContext } from '../plugin'; import { CspRouter } from '../types'; @@ -15,4 +16,5 @@ export function defineRoutes(router: CspRouter, cspContext: CspAppContext) { defineGetComplianceDashboardRoute(router, cspContext); defineGetBenchmarksRoute(router, cspContext); defineUpdateRulesConfigRoute(router, cspContext); + defineGetCspSetupStatusRoute(router, cspContext); } diff --git a/x-pack/plugins/cloud_security_posture/server/routes/setup_status/setup_status.test.ts b/x-pack/plugins/cloud_security_posture/server/routes/setup_status/setup_status.test.ts new file mode 100644 index 0000000000000..2e9879688d65c --- /dev/null +++ b/x-pack/plugins/cloud_security_posture/server/routes/setup_status/setup_status.test.ts @@ -0,0 +1,81 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { CspAppService } from '../../lib/csp_app_services'; +import { CspAppContext } from '../../plugin'; +import { defineGetCspSetupStatusRoute } from './setup_status'; +import { httpServerMock, httpServiceMock, loggingSystemMock } from '@kbn/core/server/mocks'; +// eslint-disable-next-line @kbn/eslint/no-restricted-paths +import { elasticsearchClientMock } from '@kbn/core/server/elasticsearch/client/mocks'; +import { ESSearchResponse } from '@kbn/core/types/elasticsearch'; + +describe('CspSetupStatus route', () => { + const logger: ReturnType = + loggingSystemMock.createLogger(); + const mockResponse = httpServerMock.createResponseFactory(); + const mockRequest = httpServerMock.createKibanaRequest(); + const mockEsClient = elasticsearchClientMock.createElasticsearchClient(); + const mockContext = { + core: { + elasticsearch: { client: { asCurrentUser: mockEsClient } }, + }, + }; + const router = httpServiceMock.createRouter(); + const cspAppContextService = new CspAppService(); + + const cspContext: CspAppContext = { + logger, + service: cspAppContextService, + }; + + beforeEach(() => { + jest.clearAllMocks(); + }); + + it('validate the API route path', async () => { + defineGetCspSetupStatusRoute(router, cspContext); + const [config] = router.get.mock.calls[0]; + + expect(config.path).toEqual('/internal/cloud_security_posture/setup_status'); + }); + + it('validate the API result when there are no findings in latest findings index', async () => { + defineGetCspSetupStatusRoute(router, cspContext); + mockEsClient.search.mockResponse({ + hits: { + hits: [], + }, + } as unknown as ESSearchResponse); + + const [_, handler] = router.get.mock.calls[0]; + + await handler(mockContext, mockRequest, mockResponse); + const [call] = mockResponse.ok.mock.calls; + const body = call[0]!.body; + + expect(mockResponse.ok).toHaveBeenCalledTimes(1); + await expect(body).toEqual({ latestFindingsIndexStatus: 'inapplicable' }); + }); + + it('validate the API result when there are findings in latest findings index', async () => { + defineGetCspSetupStatusRoute(router, cspContext); + mockEsClient.search.mockResponse({ + hits: { + hits: [{}], + }, + } as unknown as ESSearchResponse); + + const [_, handler] = router.get.mock.calls[0]; + + await handler(mockContext, mockRequest, mockResponse); + const [call] = mockResponse.ok.mock.calls; + const body = call[0]!.body; + + expect(mockResponse.ok).toHaveBeenCalledTimes(1); + await expect(body).toEqual({ latestFindingsIndexStatus: 'applicable' }); + }); +}); diff --git a/x-pack/plugins/cloud_security_posture/server/routes/setup_status/setup_status.ts b/x-pack/plugins/cloud_security_posture/server/routes/setup_status/setup_status.ts new file mode 100644 index 0000000000000..9f2c42f49de4f --- /dev/null +++ b/x-pack/plugins/cloud_security_posture/server/routes/setup_status/setup_status.ts @@ -0,0 +1,62 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import { transformError } from '@kbn/securitysolution-es-utils'; +import { ElasticsearchClient } from '@kbn/core/server'; +import { INFO_ROUTE_PATH, LATEST_FINDINGS_INDEX_DEFAULT_NS } from '../../../common/constants'; +import { CspAppContext } from '../../plugin'; +import { CspRouter } from '../../types'; +import { CspSetupStatus } from '../../../common/types'; + +const getLatestFindingsStatus = async ( + esClient: ElasticsearchClient +): Promise => { + try { + const queryResult = await esClient.search({ + index: LATEST_FINDINGS_INDEX_DEFAULT_NS, + query: { + match_all: {}, + }, + size: 1, + }); + const hasLatestFinding = !!queryResult.hits.hits.length; + + return hasLatestFinding ? 'applicable' : 'inapplicable'; + } catch (e) { + return 'inapplicable'; + } +}; + +export const defineGetCspSetupStatusRoute = (router: CspRouter, cspContext: CspAppContext): void => + router.get( + { + path: INFO_ROUTE_PATH, + validate: false, + }, + async (context, _, response) => { + try { + const esClient = (await context.core).elasticsearch.client.asCurrentUser; + const latestFindingsIndexStatus = await getLatestFindingsStatus(esClient); + + const body: CspSetupStatus = { + latestFindingsIndexStatus, + }; + + return response.ok({ + body, + }); + } catch (err) { + const error = transformError(err); + cspContext.logger.error(`Error while fetching findings status: ${err}`); + + return response.customError({ + body: { message: error.message }, + statusCode: error.statusCode, + }); + } + } + ); diff --git a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/save_config.tsx b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/save_config.tsx index c37d13a01e64a..5c1c0b3199600 100644 --- a/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/save_config.tsx +++ b/x-pack/plugins/enterprise_search/public/applications/workplace_search/views/content_sources/components/add_source/save_config.tsx @@ -17,13 +17,10 @@ import { EuiFlexItem, EuiForm, EuiFormRow, - EuiLink, EuiSpacer, EuiSteps, - EuiText, } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; -import { FormattedMessage } from '@kbn/i18n-react'; import { LicensingLogic } from '../../../../../shared/licensing'; import { ApiKey } from '../../../../components/shared/api_key'; @@ -32,6 +29,7 @@ import { PUBLIC_KEY_LABEL, CONSUMER_KEY_LABEL, REMOVE_BUTTON } from '../../../.. import { Configuration } from '../../../../types'; import { ExternalConnectorFormFields } from './add_external_connector'; +import { ExternalConnectorDocumentation } from './add_external_connector'; import { AddSourceLogic, SourceConfigFormElement } from './add_source_logic'; import { ConfigDocsLinks } from './config_docs_links'; import { OAUTH_SAVE_CONFIG_BUTTON, OAUTH_BACK_BUTTON } from './constants'; @@ -101,7 +99,7 @@ export const SaveConfig: React.FC = ({ const { sourceConfigData, buttonLoading, configuredFields } = useValues(AddSourceLogic); - const { accountContextOnly, serviceType, configured, configurableFields = [] } = sourceConfigData; + const { accountContextOnly, serviceType, configurableFields = [] } = sourceConfigData; const formFields: SourceConfigFormElement[] = serviceType === 'external' @@ -213,43 +211,7 @@ export const SaveConfig: React.FC = ({ {serviceType === 'external' && ( <> - -

- {configured ? ( - - {i18n.translate( - 'xpack.enterpriseSearch.workplaceSearch.contentSource.saveConfig.externalConnectorDocumenation.documentationLinkLabel', - { defaultMessage: 'documentation' } - )} - - ), - }} - /> - ) : ( - - {i18n.translate( - 'xpack.enterpriseSearch.workplaceSearch.contentSource.saveConfig.externalConnectorDocumenation.documentationLinkLabel', - { defaultMessage: 'documentation' } - )} - - ), - }} - /> - )} -

- + )} diff --git a/x-pack/plugins/fleet/public/applications/fleet/sections/data_stream/list_page/index.tsx b/x-pack/plugins/fleet/public/applications/fleet/sections/data_stream/list_page/index.tsx index a4693407569ef..daf4aff7079b8 100644 --- a/x-pack/plugins/fleet/public/applications/fleet/sections/data_stream/list_page/index.tsx +++ b/x-pack/plugins/fleet/public/applications/fleet/sections/data_stream/list_page/index.tsx @@ -105,11 +105,14 @@ export const DataStreamListPage: React.FunctionComponent<{}> = () => { }, }, { - field: 'size_in_bytes_formatted', + field: 'size_in_bytes', sortable: true, name: i18n.translate('xpack.fleet.dataStreamList.sizeColumnTitle', { defaultMessage: 'Size', }), + render: (_, datastream: DataStream) => { + return <>{datastream.size_in_bytes_formatted}; + }, }, { name: i18n.translate('xpack.fleet.dataStreamList.actionsColumnTitle', { diff --git a/x-pack/plugins/fleet/public/applications/integrations/sections/epm/screens/home/available_packages.tsx b/x-pack/plugins/fleet/public/applications/integrations/sections/epm/screens/home/available_packages.tsx index 154669409b457..095a38cdcd92f 100644 --- a/x-pack/plugins/fleet/public/applications/integrations/sections/epm/screens/home/available_packages.tsx +++ b/x-pack/plugins/fleet/public/applications/integrations/sections/epm/screens/home/available_packages.tsx @@ -351,11 +351,11 @@ export const AvailablePackages: React.FC = memo(() => { icon={} href={addBasePath('/app/integrations/detail/endpoint/')} title={i18n.translate('xpack.fleet.featuredSecurityTitle', { - defaultMessage: 'Endpoint Security', + defaultMessage: 'Endpoint and Cloud Security', })} description={i18n.translate('xpack.fleet.featuredSecurityDesc', { defaultMessage: - 'Protect your hosts with threat prevention, detection, and deep security data visibility.', + 'Protect your hosts and cloud workloads with threat prevention, detection, and deep security data visibility.', })} /> diff --git a/x-pack/plugins/ml/public/application/components/validate_job/validate_job_view.js b/x-pack/plugins/ml/public/application/components/validate_job/validate_job_view.js index af1fb980448be..64910f5abfd21 100644 --- a/x-pack/plugins/ml/public/application/components/validate_job/validate_job_view.js +++ b/x-pack/plugins/ml/public/application/components/validate_job/validate_job_view.js @@ -165,7 +165,9 @@ export class ValidateJobUI extends Component { title: job.job_id, }); if (typeof this.props.setIsValid === 'function') { - this.props.setIsValid(!messagesContainError); + // we show a warning that the user can proceed at their own risk + // therefore return true so the wizard can enable the Next button + this.props.setIsValid(true); } }) .catch((error) => { diff --git a/x-pack/plugins/ml/public/application/jobs/new_job/job_from_lens/create_job.ts b/x-pack/plugins/ml/public/application/jobs/new_job/job_from_lens/create_job.ts index ea0d8ab6247d1..35654fbc28786 100644 --- a/x-pack/plugins/ml/public/application/jobs/new_job/job_from_lens/create_job.ts +++ b/x-pack/plugins/ml/public/application/jobs/new_job/job_from_lens/create_job.ts @@ -39,7 +39,7 @@ import { hasIncompatibleProperties, hasSourceField, isTermsField, - isStringField, + isCompatibleSplitFieldType, getMlFunction, getJobsItemsFromEmbeddable, } from './utils'; @@ -288,7 +288,7 @@ async function extractFields( ); } - if (splitField !== null && isStringField(splitField) === false) { + if (splitField !== null && isCompatibleSplitFieldType(splitField) === false) { throw Error( i18n.translate('xpack.ml.newJob.fromLens.createJob.error.splitFieldMustBeString', { defaultMessage: 'Selected split field type must be string.', diff --git a/x-pack/plugins/ml/public/application/jobs/new_job/job_from_lens/utils.ts b/x-pack/plugins/ml/public/application/jobs/new_job/job_from_lens/utils.ts index e4b2ae91b3ba2..d2440fa756a80 100644 --- a/x-pack/plugins/ml/public/application/jobs/new_job/job_from_lens/utils.ts +++ b/x-pack/plugins/ml/public/application/jobs/new_job/job_from_lens/utils.ts @@ -16,8 +16,12 @@ import type { TermsIndexPatternColumn, SeriesType, XYLayerConfig, + DataType, } from '@kbn/lens-plugin/public'; import { layerTypes } from '@kbn/lens-plugin/public'; +import { KBN_FIELD_TYPES } from '@kbn/data-plugin/public'; + +import { ML_JOB_AGGREGATION } from '../../../../../common/constants/aggregation_types'; export const COMPATIBLE_SERIES_TYPES: SeriesType[] = [ 'line', @@ -35,6 +39,11 @@ export const COMPATIBLE_LAYER_TYPE: XYDataLayerConfig['layerType'] = layerTypes. export const COMPATIBLE_VISUALIZATION = 'lnsXY'; +export const COMPATIBLE_SPLIT_FIELD_TYPES: DataType[] = [ + KBN_FIELD_TYPES.STRING, + KBN_FIELD_TYPES.IP, +]; + export function getJobsItemsFromEmbeddable(embeddable: Embeddable) { const { query, filters, timeRange } = embeddable.getInput(); @@ -68,19 +77,19 @@ export function getJobsItemsFromEmbeddable(embeddable: Embeddable) { export function lensOperationToMlFunction(operationType: string) { switch (operationType) { case 'average': - return 'mean'; + return ML_JOB_AGGREGATION.MEAN; case 'count': - return 'count'; + return ML_JOB_AGGREGATION.COUNT; case 'max': - return 'max'; + return ML_JOB_AGGREGATION.MAX; case 'median': - return 'median'; + return ML_JOB_AGGREGATION.MEDIAN; case 'min': - return 'min'; + return ML_JOB_AGGREGATION.MIN; case 'sum': - return 'sum'; + return ML_JOB_AGGREGATION.SUM; case 'unique_count': - return 'distinct_count'; + return ML_JOB_AGGREGATION.DISTINCT_COUNT; default: return null; @@ -167,8 +176,8 @@ export function isTermsField(column: GenericIndexPatternColumn): column is Terms return column.operationType === 'terms' && 'params' in column; } -export function isStringField(column: GenericIndexPatternColumn) { - return column.dataType === 'string'; +export function isCompatibleSplitFieldType(column: GenericIndexPatternColumn) { + return COMPATIBLE_SPLIT_FIELD_TYPES.includes(column.dataType); } export function hasIncompatibleProperties(column: GenericIndexPatternColumn) { diff --git a/x-pack/plugins/ml/public/application/jobs/new_job/pages/components/validation_step/skip_validatoin.tsx b/x-pack/plugins/ml/public/application/jobs/new_job/pages/components/validation_step/skip_validatoin.tsx new file mode 100644 index 0000000000000..22f68c6b14ba3 --- /dev/null +++ b/x-pack/plugins/ml/public/application/jobs/new_job/pages/components/validation_step/skip_validatoin.tsx @@ -0,0 +1,29 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0; you may not use this file except in compliance with the Elastic License + * 2.0. + */ + +import React, { FC } from 'react'; +import { FormattedMessage } from '@kbn/i18n-react'; +import { EuiButtonEmpty } from '@elastic/eui'; +import { WIZARD_STEPS } from '../step_types'; + +export const SkipValidationButton: FC<{ + nextActive: boolean; + setCurrentStep: React.Dispatch>; +}> = ({ nextActive, setCurrentStep }) => + nextActive ? null : ( + setCurrentStep(WIZARD_STEPS.SUMMARY)} + iconType="arrowRight" + iconSide="right" + data-test-subj="mlJobWizardNavButtonPrevious" + > + + + ); diff --git a/x-pack/plugins/ml/public/application/jobs/new_job/pages/components/validation_step/validation.tsx b/x-pack/plugins/ml/public/application/jobs/new_job/pages/components/validation_step/validation.tsx index d2a0e83200d92..ee0786379df51 100644 --- a/x-pack/plugins/ml/public/application/jobs/new_job/pages/components/validation_step/validation.tsx +++ b/x-pack/plugins/ml/public/application/jobs/new_job/pages/components/validation_step/validation.tsx @@ -12,6 +12,7 @@ import { JobCreatorContext } from '../job_creator_context'; import { ml } from '../../../../../services/ml_api_service'; import { ValidateJob } from '../../../../../components/validate_job'; import { JOB_TYPE } from '../../../../../../../common/constants/new_job'; +import { SkipValidationButton } from './skip_validatoin'; const idFilterList = [ 'job_id_valid', @@ -72,7 +73,9 @@ export const ValidationStep: FC = ({ setCurrentStep, isCurrentStep }) previous={() => setCurrentStep(WIZARD_STEPS.JOB_DETAILS)} next={() => setCurrentStep(WIZARD_STEPS.SUMMARY)} nextActive={nextActive} - /> + > + + )} {isCurrentStep === false && } diff --git a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/question_answering/question_answering_inference.ts b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/question_answering/question_answering_inference.ts index 9f62e4da4b76e..f2b27d9e45c91 100644 --- a/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/question_answering/question_answering_inference.ts +++ b/x-pack/plugins/ml/public/application/trained_models/models_management/test_models/models/question_answering/question_answering_inference.ts @@ -7,7 +7,7 @@ import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { BehaviorSubject } from 'rxjs'; - +import { i18n } from '@kbn/i18n'; import { InferenceBase, InferResponse } from '../inference_base'; import { getQuestionAnsweringInput } from './question_answering_input'; import { getQuestionAnsweringOutputComponent } from './question_answering_output'; @@ -90,7 +90,13 @@ export class QuestionAnsweringInference extends InferenceBase { - const body = await client.asInternalUser.nodes.info({ - filter_path: 'nodes.*.attributes', - }); + const body = await client.asInternalUser.nodes.info( + { + filter_path: 'nodes.*.attributes', + }, + { maxRetries: 0 } + ); let count = 0; if (typeof body.nodes === 'object') { @@ -31,10 +34,13 @@ export async function getMlNodeCount(client: IScopedClusterClient): Promise(params); + const body = await asInternalUser.search(params, { maxRetries: 0 }); const annotations = ( (body.aggregations!.by_job as estypes.AggregationsTermsAggregateBase) diff --git a/x-pack/plugins/ml/server/models/bucket_span_estimator/bucket_span_estimator.js b/x-pack/plugins/ml/server/models/bucket_span_estimator/bucket_span_estimator.js index 8575ca7781ab7..5560f2ad22827 100644 --- a/x-pack/plugins/ml/server/models/bucket_span_estimator/bucket_span_estimator.js +++ b/x-pack/plugins/ml/server/models/bucket_span_estimator/bucket_span_estimator.js @@ -262,21 +262,24 @@ export function estimateBucketSpanFactory(client) { const getFieldCardinality = function (index, field, runtimeMappings, indicesOptions) { return new Promise((resolve, reject) => { asCurrentUser - .search({ - index, - size: 0, - body: { - aggs: { - field_count: { - cardinality: { - field, + .search( + { + index, + size: 0, + body: { + aggs: { + field_count: { + cardinality: { + field, + }, }, }, + ...(runtimeMappings !== undefined ? { runtime_mappings: runtimeMappings } : {}), }, - ...(runtimeMappings !== undefined ? { runtime_mappings: runtimeMappings } : {}), + ...(indicesOptions ?? {}), }, - ...(indicesOptions ?? {}), - }) + { maxRetries: 0 } + ) .then((body) => { const value = get(body, ['aggregations', 'field_count', 'value'], 0); resolve(value); @@ -297,26 +300,29 @@ export function estimateBucketSpanFactory(client) { .then((value) => { const numPartitions = Math.floor(value / NUM_PARTITIONS) || 1; asCurrentUser - .search({ - index, - size: 0, - body: { - query, - aggs: { - fields_bucket_counts: { - terms: { - field, - include: { - partition: 0, - num_partitions: numPartitions, + .search( + { + index, + size: 0, + body: { + query, + aggs: { + fields_bucket_counts: { + terms: { + field, + include: { + partition: 0, + num_partitions: numPartitions, + }, }, }, }, + ...(runtimeMappings !== undefined ? { runtime_mappings: runtimeMappings } : {}), }, - ...(runtimeMappings !== undefined ? { runtime_mappings: runtimeMappings } : {}), + ...(indicesOptions ?? {}), }, - ...(indicesOptions ?? {}), - }) + { maxRetries: 0 } + ) .then((body) => { // eslint-disable-next-line camelcase if (body.aggregations?.fields_bucket_counts?.buckets !== undefined) { diff --git a/x-pack/plugins/ml/server/models/bucket_span_estimator/polled_data_checker.js b/x-pack/plugins/ml/server/models/bucket_span_estimator/polled_data_checker.js index 6c2c90e0d96d4..7ccd3d4a30c64 100644 --- a/x-pack/plugins/ml/server/models/bucket_span_estimator/polled_data_checker.js +++ b/x-pack/plugins/ml/server/models/bucket_span_estimator/polled_data_checker.js @@ -72,12 +72,15 @@ export function polledDataCheckerFactory({ asCurrentUser }) { async performSearch(intervalMs) { const searchBody = this.createSearch(intervalMs); - const body = await asCurrentUser.search({ - index: this.index, - size: 0, - body: searchBody, - ...(this.indicesOptions ?? {}), - }); + const body = await asCurrentUser.search( + { + index: this.index, + size: 0, + body: searchBody, + ...(this.indicesOptions ?? {}), + }, + { maxRetries: 0 } + ); return body; } diff --git a/x-pack/plugins/ml/server/models/bucket_span_estimator/single_series_checker.js b/x-pack/plugins/ml/server/models/bucket_span_estimator/single_series_checker.js index 4a6956db25e6a..bc8077e44c72c 100644 --- a/x-pack/plugins/ml/server/models/bucket_span_estimator/single_series_checker.js +++ b/x-pack/plugins/ml/server/models/bucket_span_estimator/single_series_checker.js @@ -200,12 +200,15 @@ export function singleSeriesCheckerFactory({ asCurrentUser }) { async performSearch(intervalMs) { const searchBody = this.createSearch(intervalMs); - const body = await asCurrentUser.search({ - index: this.index, - size: 0, - body: searchBody, - ...(this.indicesOptions ?? {}), - }); + const body = await asCurrentUser.search( + { + index: this.index, + size: 0, + body: searchBody, + ...(this.indicesOptions ?? {}), + }, + { maxRetries: 0 } + ); return body; } diff --git a/x-pack/plugins/ml/server/models/data_frame_analytics/analytics_audit_messages.ts b/x-pack/plugins/ml/server/models/data_frame_analytics/analytics_audit_messages.ts index 2a84e757cd6b7..417187b7e4214 100644 --- a/x-pack/plugins/ml/server/models/data_frame_analytics/analytics_audit_messages.ts +++ b/x-pack/plugins/ml/server/models/data_frame_analytics/analytics_audit_messages.ts @@ -69,15 +69,18 @@ export function analyticsAuditMessagesProvider({ asInternalUser }: IScopedCluste }); } - const body = await asInternalUser.search({ - index: ML_NOTIFICATION_INDEX_PATTERN, - ignore_unavailable: true, - size: SIZE, - body: { - sort: [{ timestamp: { order: 'desc' } }, { job_id: { order: 'asc' } }], - query, + const body = await asInternalUser.search( + { + index: ML_NOTIFICATION_INDEX_PATTERN, + ignore_unavailable: true, + size: SIZE, + body: { + sort: [{ timestamp: { order: 'desc' } }, { job_id: { order: 'asc' } }], + query, + }, }, - }); + { maxRetries: 0 } + ); let messages: JobMessage[] = []; if (typeof body.hits.total !== 'number' && body.hits.total?.value) { diff --git a/x-pack/plugins/ml/server/models/data_frame_analytics/validation.ts b/x-pack/plugins/ml/server/models/data_frame_analytics/validation.ts index 517f3cadf3b18..6d4982ecbf464 100644 --- a/x-pack/plugins/ml/server/models/data_frame_analytics/validation.ts +++ b/x-pack/plugins/ml/server/models/data_frame_analytics/validation.ts @@ -261,16 +261,19 @@ async function getValidationCheckMessages( } try { - const body = await asCurrentUser.search({ - index, - size: 0, - track_total_hits: true, - body: { - ...(source.runtime_mappings ? { runtime_mappings: source.runtime_mappings } : {}), - query, - aggs, + const body = await asCurrentUser.search( + { + index, + size: 0, + track_total_hits: true, + body: { + ...(source.runtime_mappings ? { runtime_mappings: source.runtime_mappings } : {}), + query, + aggs, + }, }, - }); + { maxRetries: 0 } + ); // @ts-expect-error incorrect search response type const totalDocs = body.hits.total.value; diff --git a/x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts b/x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts index 5dc86d3490420..9bf107106a056 100644 --- a/x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts +++ b/x-pack/plugins/ml/server/models/data_recognizer/data_recognizer.ts @@ -304,11 +304,14 @@ export class DataRecognizer { query: moduleConfig.query, }; - const body = await this._client.asCurrentUser.search({ - index, - size, - body: searchBody, - }); + const body = await this._client.asCurrentUser.search( + { + index, + size, + body: searchBody, + }, + { maxRetries: 0 } + ); // @ts-expect-error incorrect search response type return body.hits.total.value > 0; diff --git a/x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts b/x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts index cbb1c0cc3710d..bbfc43257caf5 100644 --- a/x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts +++ b/x-pack/plugins/ml/server/models/data_visualizer/data_visualizer.ts @@ -204,16 +204,19 @@ const getAggIntervals = async ( return aggs; }, {} as Record); - const body = await asCurrentUser.search({ - index: indexPattern, - size: 0, - body: { - query, - aggs: buildSamplerAggregation(minMaxAggs, samplerShardSize), + const body = await asCurrentUser.search( + { + index: indexPattern, size: 0, - ...(isPopulatedObject(runtimeMappings) ? { runtime_mappings: runtimeMappings } : {}), + body: { + query, + aggs: buildSamplerAggregation(minMaxAggs, samplerShardSize), + size: 0, + ...(isPopulatedObject(runtimeMappings) ? { runtime_mappings: runtimeMappings } : {}), + }, }, - }); + { maxRetries: 0 } + ); const aggsPath = getSamplerAggregationsResponsePath(samplerShardSize); const aggregations = aggsPath.length > 0 ? get(body.aggregations, aggsPath) : body.aggregations; @@ -290,16 +293,19 @@ export const getHistogramsForFields = async ( return []; } - const body = await asCurrentUser.search({ - index: indexPattern, - size: 0, - body: { - query, - aggs: buildSamplerAggregation(chartDataAggs, samplerShardSize), + const body = await asCurrentUser.search( + { + index: indexPattern, size: 0, - ...(isPopulatedObject(runtimeMappings) ? { runtime_mappings: runtimeMappings } : {}), + body: { + query, + aggs: buildSamplerAggregation(chartDataAggs, samplerShardSize), + size: 0, + ...(isPopulatedObject(runtimeMappings) ? { runtime_mappings: runtimeMappings } : {}), + }, }, - }); + { maxRetries: 0 } + ); const aggsPath = getSamplerAggregationsResponsePath(samplerShardSize); const aggregations = aggsPath.length > 0 ? get(body.aggregations, aggsPath) : body.aggregations; @@ -666,12 +672,15 @@ export class DataVisualizer { : {}), }; - const body = await this._asCurrentUser.search({ - index, - track_total_hits: true, - size, - body: searchBody, - }); + const body = await this._asCurrentUser.search( + { + index, + track_total_hits: true, + size, + body: searchBody, + }, + { maxRetries: 0 } + ); const aggregations = body.aggregations; // @ts-expect-error incorrect search response type @@ -757,11 +766,14 @@ export class DataVisualizer { }; filterCriteria.push({ exists: { field } }); - const body = await this._asCurrentUser.search({ - index, - size, - body: searchBody, - }); + const body = await this._asCurrentUser.search( + { + index, + size, + body: searchBody, + }, + { maxRetries: 0 } + ); // @ts-expect-error incorrect search response type return body.hits.total.value > 0; } @@ -802,11 +814,14 @@ export class DataVisualizer { ...(isPopulatedObject(runtimeMappings) ? { runtime_mappings: runtimeMappings } : {}), }; - const body = await this._asCurrentUser.search({ - index, - size, - body: searchBody, - }); + const body = await this._asCurrentUser.search( + { + index, + size, + body: searchBody, + }, + { maxRetries: 0 } + ); const buckets: { [key: string]: number } = {}; const dataByTimeBucket: Array<{ key: string; doc_count: number }> = get( @@ -907,11 +922,14 @@ export class DataVisualizer { ...(isPopulatedObject(runtimeMappings) ? { runtime_mappings: runtimeMappings } : {}), }; - const body = await this._asCurrentUser.search({ - index, - size, - body: searchBody, - }); + const body = await this._asCurrentUser.search( + { + index, + size, + body: searchBody, + }, + { maxRetries: 0 } + ); const aggregations = body.aggregations; const aggsPath = getSamplerAggregationsResponsePath(samplerShardSize); const batchStats: NumericFieldStats[] = []; @@ -1030,11 +1048,14 @@ export class DataVisualizer { ...(isPopulatedObject(runtimeMappings) ? { runtime_mappings: runtimeMappings } : {}), }; - const body = await this._asCurrentUser.search({ - index, - size, - body: searchBody, - }); + const body = await this._asCurrentUser.search( + { + index, + size, + body: searchBody, + }, + { maxRetries: 0 } + ); const aggregations = body.aggregations; const aggsPath = getSamplerAggregationsResponsePath(samplerShardSize); const batchStats: StringFieldStats[] = []; @@ -1106,11 +1127,14 @@ export class DataVisualizer { ...(isPopulatedObject(runtimeMappings) ? { runtime_mappings: runtimeMappings } : {}), }; - const body = await this._asCurrentUser.search({ - index, - size, - body: searchBody, - }); + const body = await this._asCurrentUser.search( + { + index, + size, + body: searchBody, + }, + { maxRetries: 0 } + ); const aggregations = body.aggregations; const aggsPath = getSamplerAggregationsResponsePath(samplerShardSize); const batchStats: DateFieldStats[] = []; @@ -1175,11 +1199,14 @@ export class DataVisualizer { ...(isPopulatedObject(runtimeMappings) ? { runtime_mappings: runtimeMappings } : {}), }; - const body = await this._asCurrentUser.search({ - index, - size, - body: searchBody, - }); + const body = await this._asCurrentUser.search( + { + index, + size, + body: searchBody, + }, + { maxRetries: 0 } + ); const aggregations = body.aggregations; const aggsPath = getSamplerAggregationsResponsePath(samplerShardSize); const batchStats: BooleanFieldStats[] = []; @@ -1240,11 +1267,14 @@ export class DataVisualizer { ...(isPopulatedObject(runtimeMappings) ? { runtime_mappings: runtimeMappings } : {}), }; - const body = await this._asCurrentUser.search({ - index, - size, - body: searchBody, - }); + const body = await this._asCurrentUser.search( + { + index, + size, + body: searchBody, + }, + { maxRetries: 0 } + ); const stats = { fieldName: field, examples: [] as any[], diff --git a/x-pack/plugins/ml/server/models/fields_service/fields_service.ts b/x-pack/plugins/ml/server/models/fields_service/fields_service.ts index a3d6b74e057e0..64348a0656009 100644 --- a/x-pack/plugins/ml/server/models/fields_service/fields_service.ts +++ b/x-pack/plugins/ml/server/models/fields_service/fields_service.ts @@ -45,10 +45,13 @@ export function fieldsServiceProvider({ asCurrentUser }: IScopedClusterClient) { fieldNames: string[], datafeedConfig?: Datafeed ): Promise { - const body = await asCurrentUser.fieldCaps({ - index, - fields: fieldNames, - }); + const body = await asCurrentUser.fieldCaps( + { + index, + fields: fieldNames, + }, + { maxRetries: 0 } + ); const aggregatableFields: string[] = []; const datafeedAggregations = getDatafeedAggregations(datafeedConfig); @@ -180,11 +183,14 @@ export function fieldsServiceProvider({ asCurrentUser }: IScopedClusterClient) { ...runtimeMappings, }; - const { aggregations } = await asCurrentUser.search({ - index, - body, - ...(datafeedConfig?.indices_options ?? {}), - }); + const { aggregations } = await asCurrentUser.search( + { + index, + body, + ...(datafeedConfig?.indices_options ?? {}), + }, + { maxRetries: 0 } + ); if (!aggregations) { return {}; @@ -222,27 +228,30 @@ export function fieldsServiceProvider({ asCurrentUser }: IScopedClusterClient) { }> { const obj = { success: true, start: { epoch: 0, string: '' }, end: { epoch: 0, string: '' } }; - const { aggregations } = await asCurrentUser.search({ - index, - size: 0, - body: { - ...(query ? { query } : {}), - aggs: { - earliest: { - min: { - field: timeFieldName, + const { aggregations } = await asCurrentUser.search( + { + index, + size: 0, + body: { + ...(query ? { query } : {}), + aggs: { + earliest: { + min: { + field: timeFieldName, + }, }, - }, - latest: { - max: { - field: timeFieldName, + latest: { + max: { + field: timeFieldName, + }, }, }, + ...(isPopulatedObject(runtimeMappings) ? { runtime_mappings: runtimeMappings } : {}), }, - ...(isPopulatedObject(runtimeMappings) ? { runtime_mappings: runtimeMappings } : {}), + ...(indicesOptions ?? {}), }, - ...(indicesOptions ?? {}), - }); + { maxRetries: 0 } + ); if (aggregations && aggregations.earliest && aggregations.latest) { // @ts-expect-error incorrect search response type @@ -397,11 +406,14 @@ export function fieldsServiceProvider({ asCurrentUser }: IScopedClusterClient) { }, }; - const { aggregations } = await asCurrentUser.search({ - index, - body, - ...(datafeedConfig?.indices_options ?? {}), - }); + const { aggregations } = await asCurrentUser.search( + { + index, + body, + ...(datafeedConfig?.indices_options ?? {}), + }, + { maxRetries: 0 } + ); if (!aggregations) { return cachedValues; diff --git a/x-pack/plugins/ml/server/models/job_audit_messages/job_audit_messages.ts b/x-pack/plugins/ml/server/models/job_audit_messages/job_audit_messages.ts index 36d09d3e236b2..023780dd1ad99 100644 --- a/x-pack/plugins/ml/server/models/job_audit_messages/job_audit_messages.ts +++ b/x-pack/plugins/ml/server/models/job_audit_messages/job_audit_messages.ts @@ -150,15 +150,18 @@ export function jobAuditMessagesProvider( }); } - const body = await asInternalUser.search({ - index: ML_NOTIFICATION_INDEX_PATTERN, - ignore_unavailable: true, - size: SIZE, - body: { - sort: [{ timestamp: { order: 'desc' } }, { job_id: { order: 'asc' } }], - query, + const body = await asInternalUser.search( + { + index: ML_NOTIFICATION_INDEX_PATTERN, + ignore_unavailable: true, + size: SIZE, + body: { + sort: [{ timestamp: { order: 'desc' } }, { job_id: { order: 'asc' } }], + query, + }, }, - }); + { maxRetries: 0 } + ); let messages: JobMessage[] = []; const notificationIndices: string[] = []; @@ -222,36 +225,38 @@ export function jobAuditMessagesProvider( }, }; - const body = await asInternalUser.search({ - index: ML_NOTIFICATION_INDEX_PATTERN, - ignore_unavailable: true, - size: 0, - body: { - query, - aggs: { - levelsPerJob: { - terms: { - field: 'job_id', - size: levelsPerJobAggSize, - }, - aggs: { - levels: { - terms: { - field: 'level', - }, - aggs: { - latestMessage: { - terms: { - field: 'message.raw', - size: 1, - order: { - latestMessage: 'desc', + const body = await asInternalUser.search( + { + index: ML_NOTIFICATION_INDEX_PATTERN, + ignore_unavailable: true, + size: 0, + body: { + query, + aggs: { + levelsPerJob: { + terms: { + field: 'job_id', + size: levelsPerJobAggSize, + }, + aggs: { + levels: { + terms: { + field: 'level', + }, + aggs: { + latestMessage: { + terms: { + field: 'message.raw', + size: 1, + order: { + latestMessage: 'desc', + }, }, - }, - aggs: { - latestMessage: { - max: { - field: 'timestamp', + aggs: { + latestMessage: { + max: { + field: 'timestamp', + }, }, }, }, @@ -262,7 +267,8 @@ export function jobAuditMessagesProvider( }, }, }, - }); + { maxRetries: 0 } + ); interface LevelsPerJob { key: string; @@ -389,25 +395,31 @@ export function jobAuditMessagesProvider( }; const promises: Array> = [ - asInternalUser.updateByQuery({ - index: notificationIndices.join(','), - ignore_unavailable: true, - refresh: false, - conflicts: 'proceed', - body: { - query, - script: { - source: 'ctx._source.cleared = true', - lang: 'painless', + asInternalUser.updateByQuery( + { + index: notificationIndices.join(','), + ignore_unavailable: true, + refresh: false, + conflicts: 'proceed', + body: { + query, + script: { + source: 'ctx._source.cleared = true', + lang: 'painless', + }, }, }, - }), + { maxRetries: 0 } + ), ...notificationIndices.map((index) => - asInternalUser.index({ - index, - body: newClearedMessage, - refresh: 'wait_for', - }) + asInternalUser.index( + { + index, + body: newClearedMessage, + refresh: 'wait_for', + }, + { maxRetries: 0 } + ) ), ]; @@ -428,46 +440,49 @@ export function jobAuditMessagesProvider( jobIds: string[], earliestMs?: number ): Promise { - const body = await asInternalUser.search({ - index: ML_NOTIFICATION_INDEX_PATTERN, - ignore_unavailable: true, - size: 0, - body: { - query: { - bool: { - filter: [ - ...(earliestMs ? [{ range: { timestamp: { gte: earliestMs } } }] : []), - { terms: { job_id: jobIds } }, - { - term: { level: { value: MESSAGE_LEVEL.ERROR } }, - }, - ], - }, - }, - aggs: { - by_job: { - terms: { - field: 'job_id', - size: jobIds.length, + const body = await asInternalUser.search( + { + index: ML_NOTIFICATION_INDEX_PATTERN, + ignore_unavailable: true, + size: 0, + body: { + query: { + bool: { + filter: [ + ...(earliestMs ? [{ range: { timestamp: { gte: earliestMs } } }] : []), + { terms: { job_id: jobIds } }, + { + term: { level: { value: MESSAGE_LEVEL.ERROR } }, + }, + ], }, - aggs: { - latest_errors: { - top_hits: { - size: 10, - sort: [ - { - timestamp: { - order: 'desc', + }, + aggs: { + by_job: { + terms: { + field: 'job_id', + size: jobIds.length, + }, + aggs: { + latest_errors: { + top_hits: { + size: 10, + sort: [ + { + timestamp: { + order: 'desc', + }, }, - }, - ], + ], + }, }, }, }, }, }, }, - }); + { maxRetries: 0 } + ); const errors = body.aggregations!.by_job as estypes.AggregationsTermsAggregateBase<{ key: string; diff --git a/x-pack/plugins/ml/server/models/job_service/jobs.ts b/x-pack/plugins/ml/server/models/job_service/jobs.ts index 7eb5a1cf1d722..1ffa9687fca95 100644 --- a/x-pack/plugins/ml/server/models/job_service/jobs.ts +++ b/x-pack/plugins/ml/server/models/job_service/jobs.ts @@ -499,10 +499,13 @@ export function jobsProvider( async function blockingJobTasks() { const jobs: Array> = []; try { - const body = await asInternalUser.tasks.list({ - actions: JOB_ACTION_TASKS, - detailed: true, - }); + const body = await asInternalUser.tasks.list( + { + actions: JOB_ACTION_TASKS, + detailed: true, + }, + { maxRetries: 0 } + ); if (body.nodes !== undefined) { Object.values(body.nodes).forEach(({ tasks }) => { diff --git a/x-pack/plugins/ml/server/models/job_service/new_job/categorization/examples.ts b/x-pack/plugins/ml/server/models/job_service/new_job/categorization/examples.ts index a5cb9e8507429..f7dc30a4221d5 100644 --- a/x-pack/plugins/ml/server/models/job_service/new_job/categorization/examples.ts +++ b/x-pack/plugins/ml/server/models/job_service/new_job/categorization/examples.ts @@ -62,18 +62,21 @@ export function categorizationExamplesProvider({ } } } - const body = await asCurrentUser.search>({ - index: indexPatternTitle, - size, - body: { - fields: [categorizationFieldName], - _source: false, - query, - sort: ['_doc'], - ...(runtimeMappings !== undefined ? { runtime_mappings: runtimeMappings } : {}), + const body = await asCurrentUser.search>( + { + index: indexPatternTitle, + size, + body: { + fields: [categorizationFieldName], + _source: false, + query, + sort: ['_doc'], + ...(runtimeMappings !== undefined ? { runtime_mappings: runtimeMappings } : {}), + }, + ...(indicesOptions ?? {}), }, - ...(indicesOptions ?? {}), - }); + { maxRetries: 0 } + ); // hit.fields can be undefined if value is originally null const tempExamples = body.hits.hits.map(({ fields }) => @@ -126,12 +129,15 @@ export function categorizationExamplesProvider({ } async function loadTokens(examples: string[], analyzer: CategorizationAnalyzer) { - const { tokens } = await asInternalUser.indices.analyze({ - body: { - ...getAnalyzer(analyzer), - text: examples, + const { tokens } = await asInternalUser.indices.analyze( + { + body: { + ...getAnalyzer(analyzer), + text: examples, + }, }, - }); + { maxRetries: 0 } + ); const lengths = examples.map((e) => e.length); const sumLengths = lengths.map( diff --git a/x-pack/plugins/ml/server/models/job_service/new_job/line_chart.ts b/x-pack/plugins/ml/server/models/job_service/new_job/line_chart.ts index 4b1efbbd7e014..7b008fad0235c 100644 --- a/x-pack/plugins/ml/server/models/job_service/new_job/line_chart.ts +++ b/x-pack/plugins/ml/server/models/job_service/new_job/line_chart.ts @@ -57,7 +57,7 @@ export function newJobLineChartProvider({ asCurrentUser }: IScopedClusterClient) indicesOptions ); - const body = await asCurrentUser.search(json); + const body = await asCurrentUser.search(json, { maxRetries: 0 }); return processSearchResults( body, aggFieldNamePairs.map((af) => af.field) diff --git a/x-pack/plugins/ml/server/models/job_service/new_job/population_chart.ts b/x-pack/plugins/ml/server/models/job_service/new_job/population_chart.ts index 8d4a5fec9f497..38fd898dda3cc 100644 --- a/x-pack/plugins/ml/server/models/job_service/new_job/population_chart.ts +++ b/x-pack/plugins/ml/server/models/job_service/new_job/population_chart.ts @@ -63,7 +63,7 @@ export function newJobPopulationChartProvider({ asCurrentUser }: IScopedClusterC indicesOptions ); - const body = await asCurrentUser.search(json); + const body = await asCurrentUser.search(json, { maxRetries: 0 }); return processSearchResults( body, aggFieldNamePairs.map((af) => af.field) diff --git a/x-pack/plugins/ml/server/models/job_service/new_job_caps/field_service.ts b/x-pack/plugins/ml/server/models/job_service/new_job_caps/field_service.ts index cff7739ef8f74..18cc00c5678ea 100644 --- a/x-pack/plugins/ml/server/models/job_service/new_job_caps/field_service.ts +++ b/x-pack/plugins/ml/server/models/job_service/new_job_caps/field_service.ts @@ -63,10 +63,13 @@ class FieldsService { } private async loadFieldCaps(): Promise { - return await this._mlClusterClient.asCurrentUser.fieldCaps({ - index: this._indexPattern, - fields: '*', - }); + return await this._mlClusterClient.asCurrentUser.fieldCaps( + { + index: this._indexPattern, + fields: '*', + }, + { maxRetries: 0 } + ); } // create field object from the results from _field_caps diff --git a/x-pack/plugins/ml/server/models/job_service/new_job_caps/rollup.ts b/x-pack/plugins/ml/server/models/job_service/new_job_caps/rollup.ts index a62535b0c981c..91e50fb3ca4cb 100644 --- a/x-pack/plugins/ml/server/models/job_service/new_job_caps/rollup.ts +++ b/x-pack/plugins/ml/server/models/job_service/new_job_caps/rollup.ts @@ -33,9 +33,12 @@ export async function rollupServiceProvider( rollupIndexPatternObject.typeMeta?.params !== undefined ) { const rollUpIndex: string = rollupIndexPatternObject.typeMeta.params.rollup_index; - const rollupCaps = await asCurrentUser.rollup.getRollupIndexCaps({ - index: rollUpIndex, - }); + const rollupCaps = await asCurrentUser.rollup.getRollupIndexCaps( + { + index: rollUpIndex, + }, + { maxRetries: 0 } + ); const indexRollupCaps = rollupCaps[rollUpIndex]; if (indexRollupCaps && indexRollupCaps.rollup_jobs) { diff --git a/x-pack/plugins/ml/server/models/job_validation/validate_cardinality.ts b/x-pack/plugins/ml/server/models/job_validation/validate_cardinality.ts index 811f52a271d81..9aa9ed2ec92c6 100644 --- a/x-pack/plugins/ml/server/models/job_validation/validate_cardinality.ts +++ b/x-pack/plugins/ml/server/models/job_validation/validate_cardinality.ts @@ -83,10 +83,13 @@ const validateFactory = (client: IScopedClusterClient, job: CombinedJob): Valida ] as string[]; // use fieldCaps endpoint to get data about whether fields are aggregatable - const fieldCaps = await asCurrentUser.fieldCaps({ - index: job.datafeed_config.indices.join(','), - fields: uniqueFieldNames, - }); + const fieldCaps = await asCurrentUser.fieldCaps( + { + index: job.datafeed_config.indices.join(','), + fields: uniqueFieldNames, + }, + { maxRetries: 0 } + ); const datafeedAggregations = getDatafeedAggregations(datafeedConfig); let aggregatableFieldNames: string[] = []; diff --git a/x-pack/plugins/ml/server/models/job_validation/validate_datafeed_preview.ts b/x-pack/plugins/ml/server/models/job_validation/validate_datafeed_preview.ts index 60d092ee6acbe..3b4066bc1d3ab 100644 --- a/x-pack/plugins/ml/server/models/job_validation/validate_datafeed_preview.ts +++ b/x-pack/plugins/ml/server/models/job_validation/validate_datafeed_preview.ts @@ -37,7 +37,7 @@ export async function validateDatafeedPreview( datafeed_config: datafeed, }, }, - authHeader + { ...authHeader, maxRetries: 0 } // previewDatafeed response type is incorrect )) as unknown as { body: unknown[] }; diff --git a/x-pack/plugins/ml/server/models/job_validation/validate_time_range.ts b/x-pack/plugins/ml/server/models/job_validation/validate_time_range.ts index 7578f24d05e02..6d75b8c587eac 100644 --- a/x-pack/plugins/ml/server/models/job_validation/validate_time_range.ts +++ b/x-pack/plugins/ml/server/models/job_validation/validate_time_range.ts @@ -32,10 +32,13 @@ export async function isValidTimeField({ asCurrentUser }: IScopedClusterClient, const timeField = job.data_description.time_field!; // check if time_field is of type 'date' or 'date_nanos' - const fieldCaps = await asCurrentUser.fieldCaps({ - index, - fields: [timeField], - }); + const fieldCaps = await asCurrentUser.fieldCaps( + { + index, + fields: [timeField], + }, + { maxRetries: 0 } + ); let fieldType = fieldCaps?.fields[timeField]?.date?.type; if (fieldType === undefined) { diff --git a/x-pack/plugins/ml/server/models/results_service/anomaly_charts.ts b/x-pack/plugins/ml/server/models/results_service/anomaly_charts.ts index c5a31106f4ddf..725fed25f1bce 100644 --- a/x-pack/plugins/ml/server/models/results_service/anomaly_charts.ts +++ b/x-pack/plugins/ml/server/models/results_service/anomaly_charts.ts @@ -271,7 +271,7 @@ export function anomalyChartsDataProvider(mlClient: MlClient, client: IScopedClu } } - const resp = await client?.asCurrentUser.search(esSearchRequest); + const resp = await client?.asCurrentUser.search(esSearchRequest, { maxRetries: 0 }); const obj: MetricData = { success: true, results: {} }; // @ts-ignore @@ -1551,7 +1551,7 @@ export function anomalyChartsDataProvider(mlClient: MlClient, client: IScopedClu body.aggs.sample.aggs.byTime.aggs.entities.aggs.metric = metricAgg; } - const resp = await client!.asCurrentUser.search(body); + const resp = await client!.asCurrentUser.search(body, { maxRetries: 0 }); // Because of the sampling, results of metricFunctions which use sum or count // can be significantly skewed. Taking into account totalHits we calculate a diff --git a/x-pack/plugins/ml/server/models/results_service/results_service.ts b/x-pack/plugins/ml/server/models/results_service/results_service.ts index 39fbaeb74b45c..b84b693fcc111 100644 --- a/x-pack/plugins/ml/server/models/results_service/results_service.ts +++ b/x-pack/plugins/ml/server/models/results_service/results_service.ts @@ -725,7 +725,9 @@ export function resultsServiceProvider(mlClient: MlClient, client?: IScopedClust }; if (client) { - const { aggregations } = await client.asCurrentUser.search(esSearchRequest); + const { aggregations } = await client.asCurrentUser.search(esSearchRequest, { + maxRetries: 0, + }); finalResults.datafeedResults = // @ts-expect-error incorrect search response type diff --git a/x-pack/plugins/ml/server/routes/datafeeds.ts b/x-pack/plugins/ml/server/routes/datafeeds.ts index d5da9f7f420b4..f12d5855bbdbc 100644 --- a/x-pack/plugins/ml/server/routes/datafeeds.ts +++ b/x-pack/plugins/ml/server/routes/datafeeds.ts @@ -371,7 +371,7 @@ export function dataFeedRoutes({ router, routeGuard }: RouteInitialization) { { datafeed_id: datafeedId, }, - getAuthorizationHeader(request) + { ...getAuthorizationHeader(request), maxRetries: 0 } ); return response.ok({ diff --git a/x-pack/plugins/ml/server/routes/indices.ts b/x-pack/plugins/ml/server/routes/indices.ts index 65df5287ac75f..a35c665a4108b 100644 --- a/x-pack/plugins/ml/server/routes/indices.ts +++ b/x-pack/plugins/ml/server/routes/indices.ts @@ -41,7 +41,7 @@ export function indicesRoutes({ router, routeGuard }: RouteInitialization) { requestFields !== undefined && Array.isArray(requestFields) ? requestFields.join(',') : '*'; - const body = await client.asCurrentUser.fieldCaps({ index, fields }); + const body = await client.asCurrentUser.fieldCaps({ index, fields }, { maxRetries: 0 }); return response.ok({ body }); } catch (e) { return response.customError(wrapError(e)); diff --git a/x-pack/plugins/ml/server/routes/job_service.ts b/x-pack/plugins/ml/server/routes/job_service.ts index 5504682406a00..24aead28bb705 100644 --- a/x-pack/plugins/ml/server/routes/job_service.ts +++ b/x-pack/plugins/ml/server/routes/job_service.ts @@ -895,7 +895,10 @@ export function jobServiceRoutes({ router, routeGuard }: RouteInitialization) { }, } as estypes.MlPreviewDatafeedRequest); - const body = await mlClient.previewDatafeed(payload, getAuthorizationHeader(request)); + const body = await mlClient.previewDatafeed(payload, { + ...getAuthorizationHeader(request), + maxRetries: 0, + }); return response.ok({ body, }); diff --git a/x-pack/plugins/ml/server/usage/collector.ts b/x-pack/plugins/ml/server/usage/collector.ts index 44a403b15a9bd..be09ccae6367a 100644 --- a/x-pack/plugins/ml/server/usage/collector.ts +++ b/x-pack/plugins/ml/server/usage/collector.ts @@ -88,32 +88,35 @@ export function registerCollector(usageCollection: UsageCollectionSetup, kibanaI }, isReady: () => !!kibanaIndex, fetch: async ({ esClient }) => { - const result = await esClient.search({ - index: kibanaIndex, - size: 0, - body: { - query: { - bool: { - filter: [ - { term: { type: 'alert' } }, - { - term: { - 'alert.alertTypeId': ML_ALERT_TYPES.ANOMALY_DETECTION, + const result = await esClient.search( + { + index: kibanaIndex, + size: 0, + body: { + query: { + bool: { + filter: [ + { term: { type: 'alert' } }, + { + term: { + 'alert.alertTypeId': ML_ALERT_TYPES.ANOMALY_DETECTION, + }, }, - }, - ], + ], + }, }, - }, - aggs: { - count_by_result_type: { - terms: { - field: 'alert.params.resultType', - size: 3, + aggs: { + count_by_result_type: { + terms: { + field: 'alert.params.resultType', + size: 3, + }, }, }, }, }, - }); + { maxRetries: 0 } + ); const aggResponse = result.aggregations as { count_by_result_type: { @@ -132,24 +135,27 @@ export function registerCollector(usageCollection: UsageCollectionSetup, kibanaI alert: { params: MlAnomalyDetectionJobsHealthRuleParams; }; - }>({ - index: kibanaIndex, - size: 10000, - body: { - query: { - bool: { - filter: [ - { term: { type: 'alert' } }, - { - term: { - 'alert.alertTypeId': ML_ALERT_TYPES.AD_JOBS_HEALTH, + }>( + { + index: kibanaIndex, + size: 10000, + body: { + query: { + bool: { + filter: [ + { term: { type: 'alert' } }, + { + term: { + 'alert.alertTypeId': ML_ALERT_TYPES.AD_JOBS_HEALTH, + }, }, - }, - ], + ], + }, }, }, }, - }); + { maxRetries: 0 } + ); const resultsByCheckType = jobsHealthRuleInstances.hits.hits.reduce( (acc, curr) => { diff --git a/x-pack/plugins/security_solution/common/endpoint/data_generators/endpoint_action_generator.ts b/x-pack/plugins/security_solution/common/endpoint/data_generators/endpoint_action_generator.ts index e0ae0f17adbde..c7dc46532a653 100644 --- a/x-pack/plugins/security_solution/common/endpoint/data_generators/endpoint_action_generator.ts +++ b/x-pack/plugins/security_solution/common/endpoint/data_generators/endpoint_action_generator.ts @@ -11,8 +11,10 @@ import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { ENDPOINT_ACTION_RESPONSES_DS, ENDPOINT_ACTIONS_INDEX } from '../constants'; import { BaseDataGenerator } from './base_data_generator'; import { + ActionDetails, ActivityLogItemTypes, EndpointActivityLogActionResponse, + EndpointPendingActions, ISOLATION_ACTIONS, LogsEndpointAction, LogsEndpointActionResponse, @@ -103,6 +105,82 @@ export class EndpointActionGenerator extends BaseDataGenerator { }); } + generateActionDetails(overrides: DeepPartial = {}): ActionDetails { + const details: ActionDetails = { + agents: ['agent-a'], + command: 'isolate', + completedAt: '2022-04-30T16:08:47.449Z', + id: '123', + isCompleted: true, + isExpired: false, + wasSuccessful: true, + errors: undefined, + logEntries: [ + { + item: { + data: { + '@timestamp': '2022-04-27T16:08:47.449Z', + action_id: '123', + agents: ['agent-a'], + data: { + command: 'isolate', + comment: '5wb6pu6kh2xix5i', + }, + expiration: '2022-04-29T16:08:47.449Z', + input_type: 'endpoint', + type: 'INPUT_ACTION', + user_id: 'elastic', + }, + id: '44d8b915-c69c-4c48-8c86-b57d0bd631d0', + }, + type: 'fleetAction', + }, + { + item: { + data: { + '@timestamp': '2022-04-30T16:08:47.449Z', + action_data: { + command: 'unisolate', + comment: '', + }, + action_id: '123', + agent_id: 'agent-a', + completed_at: '2022-04-30T16:08:47.449Z', + error: '', + started_at: '2022-04-30T16:08:47.449Z', + }, + id: '54-65-65-98', + }, + type: 'fleetResponse', + }, + { + item: { + data: { + '@timestamp': '2022-04-30T16:08:47.449Z', + EndpointActions: { + action_id: '123', + completed_at: '2022-04-30T16:08:47.449Z', + data: { + command: 'unisolate', + comment: '', + }, + started_at: '2022-04-30T16:08:47.449Z', + }, + agent: { + id: 'agent-a', + }, + }, + id: '32-65-98', + }, + type: 'response', + }, + ], + startedAt: '2022-04-27T16:08:47.449Z', + }; + + return merge(details, overrides); + } + generateActivityLogActionResponse( overrides: DeepPartial ): EndpointActivityLogActionResponse { @@ -118,6 +196,21 @@ export class EndpointActionGenerator extends BaseDataGenerator { ); } + generateAgentPendingActionsSummary( + overrides: Partial = {} + ): EndpointPendingActions { + return merge( + { + agent_id: this.seededUUIDv4(), + pending_actions: { + isolate: 2, + unisolate: 0, + }, + }, + overrides + ); + } + randomFloat(): number { return this.random(); } diff --git a/x-pack/plugins/security_solution/common/endpoint/types/actions.ts b/x-pack/plugins/security_solution/common/endpoint/types/actions.ts index 9ca07a26e03ed..6ff3a58109f83 100644 --- a/x-pack/plugins/security_solution/common/endpoint/types/actions.ts +++ b/x-pack/plugins/security_solution/common/endpoint/types/actions.ts @@ -200,8 +200,17 @@ export interface ActionDetails { * performed on the endpoint */ command: string; + /** + * Will be set to true only if action is not yet completed and elapsed time has exceeded + * the request's expiration date + */ isExpired: boolean; + /** Action has been completed */ isCompleted: boolean; + /** If the action was successful */ + wasSuccessful: boolean; + /** Any errors encountered if `wasSuccessful` is `false` */ + errors: undefined | string[]; /** The date when the initial action request was submitted */ startedAt: string; /** The date when the action was completed (a response by the endpoint (not fleet) was received) */ diff --git a/x-pack/plugins/security_solution/public/app/home/global_header/index.tsx b/x-pack/plugins/security_solution/public/app/home/global_header/index.tsx index 768f05a36527c..bc21dc804cb33 100644 --- a/x-pack/plugins/security_solution/public/app/home/global_header/index.tsx +++ b/x-pack/plugins/security_solution/public/app/home/global_header/index.tsx @@ -27,7 +27,6 @@ import { timelineDefaults } from '../../../timelines/store/timeline/defaults'; import { timelineSelectors } from '../../../timelines/store/timeline'; import { useShallowEqualSelector } from '../../../common/hooks/use_selector'; import { getScopeFromPath, showSourcererByPath } from '../../../common/containers/sourcerer'; -import { ConsolesPopoverHeaderSectionItem } from '../../../common/components/consoles_popover_header_section_item'; const BUTTON_ADD_DATA = i18n.translate('xpack.securitySolution.globalHeader.buttonAddData', { defaultMessage: 'Add integrations', @@ -73,9 +72,6 @@ export const GlobalHeader = React.memo( return ( - {/* The consoles Popover may or may not be shown, depending on the user's authz */} - - {isDetectionsPath(pathname) && ( diff --git a/x-pack/plugins/security_solution/public/cases/components/use_insert_timeline/index.test.tsx b/x-pack/plugins/security_solution/public/cases/components/use_insert_timeline/index.test.tsx index 386a095feac6e..f49f6fe0e28ad 100644 --- a/x-pack/plugins/security_solution/public/cases/components/use_insert_timeline/index.test.tsx +++ b/x-pack/plugins/security_solution/public/cases/components/use_insert_timeline/index.test.tsx @@ -7,7 +7,7 @@ import { renderHook } from '@testing-library/react-hooks'; -import { mockTimelineModel } from '../../../common/mock'; +import { mockTimelineModel } from '../../../common/mock/timeline_results'; import { useFormatUrl } from '../../../common/components/link_to'; import { SecurityPageName } from '../../../app/types'; import { useInsertTimeline } from '.'; diff --git a/x-pack/plugins/security_solution/public/common/components/consoles_popover_header_section_item/consoles_popover_header_section_item.test.tsx b/x-pack/plugins/security_solution/public/common/components/consoles_popover_header_section_item/consoles_popover_header_section_item.test.tsx deleted file mode 100644 index f51c02bb63a47..0000000000000 --- a/x-pack/plugins/security_solution/public/common/components/consoles_popover_header_section_item/consoles_popover_header_section_item.test.tsx +++ /dev/null @@ -1,63 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import React from 'react'; -import { AppContextTestRender, createAppRootMockRenderer } from '../../mock/endpoint'; -import { ConsolesPopoverHeaderSectionItem } from './consoles_popover_header_section_item'; -import { useUserPrivileges as _useUserPrivileges } from '../user_privileges'; -import { getEndpointPrivilegesInitialStateMock } from '../user_privileges/endpoint/mocks'; - -jest.mock('../user_privileges'); -const userUserPrivilegesMock = _useUserPrivileges as jest.Mock; - -describe('When rendering the `ConsolesPopoverHeaderSectionItem`', () => { - let render: () => ReturnType; - let renderResult: ReturnType; - let setExperimentalFlag: AppContextTestRender['setExperimentalFlag']; - - beforeEach(() => { - const mockedContext = createAppRootMockRenderer(); - - setExperimentalFlag = mockedContext.setExperimentalFlag; - setExperimentalFlag({ responseActionsConsoleEnabled: true }); - render = () => { - return (renderResult = mockedContext.render()); - }; - }); - - afterEach(() => { - userUserPrivilegesMock.mockReturnValue({ - ...userUserPrivilegesMock(), - endpointPrivileges: getEndpointPrivilegesInitialStateMock(), - }); - }); - - it('should show menu item if feature flag is true and user has authz to endpoint management', () => { - render(); - - expect(renderResult.getByTestId('endpointConsoles')).toBeTruthy(); - }); - - it('should hide the menu item if feature flag is false', () => { - setExperimentalFlag({ responseActionsConsoleEnabled: false }); - render(); - - expect(renderResult.queryByTestId('endpointConsoles')).toBeNull(); - }); - - it('should hide menu item if user does not have authz to endpoint management', () => { - userUserPrivilegesMock.mockReturnValue({ - ...userUserPrivilegesMock(), - endpointPrivileges: getEndpointPrivilegesInitialStateMock({ - canAccessEndpointManagement: false, - }), - }); - render(); - - expect(renderResult.queryByTestId('endpointConsoles')).toBeNull(); - }); -}); diff --git a/x-pack/plugins/security_solution/public/common/components/consoles_popover_header_section_item/consoles_popover_header_section_item.tsx b/x-pack/plugins/security_solution/public/common/components/consoles_popover_header_section_item/consoles_popover_header_section_item.tsx deleted file mode 100644 index 4cf4617789cf6..0000000000000 --- a/x-pack/plugins/security_solution/public/common/components/consoles_popover_header_section_item/consoles_popover_header_section_item.tsx +++ /dev/null @@ -1,77 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0; you may not use this file except in compliance with the Elastic License - * 2.0. - */ - -import React, { memo, useState, useCallback, useMemo } from 'react'; -import { EuiHeaderSectionItem, EuiHeaderSectionItemButton, EuiPopover } from '@elastic/eui'; -import { i18n } from '@kbn/i18n'; -import { useUserPrivileges } from '../user_privileges'; -import { useIsExperimentalFeatureEnabled } from '../../hooks/use_experimental_features'; - -const LABELS = Object.freeze({ - buttonLabel: i18n.translate('xpack.securitySolution.consolesPopoverHeaderItem.buttonLabel', { - defaultMessage: 'Endpoint consoles', - }), -}); - -const ConsolesPopover = memo(() => { - const [isPopoverOpen, setIsPopoverOpen] = useState(false); - - const handlePopoverToggle = useCallback(() => { - setIsPopoverOpen((prevState) => !prevState); - }, []); - - const handlePopoverClose = useCallback(() => { - setIsPopoverOpen(false); - }, []); - - const buttonTextProps = useMemo(() => { - return { style: { fontSize: '1rem' } }; - }, []); - - return ( - - - {LABELS.buttonLabel} - - } - isOpen={isPopoverOpen} - closePopover={handlePopoverClose} - repositionOnScroll - > - { - 'TODO: Currently open consoles and the ability to start a new console will be shown here soon' - } - - - ); -}); -ConsolesPopover.displayName = 'ConsolesPopover'; - -export const ConsolesPopoverHeaderSectionItem = memo((props) => { - const canAccessEndpointManagement = - useUserPrivileges().endpointPrivileges.canAccessEndpointManagement; - const isExperimentalFeatureEnabled = useIsExperimentalFeatureEnabled( - 'responseActionsConsoleEnabled' - ); - - return canAccessEndpointManagement && isExperimentalFeatureEnabled ? : null; -}); -ConsolesPopoverHeaderSectionItem.displayName = 'ConsolesPopoverHeaderSectionItem'; diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/__mocks__/index.ts b/x-pack/plugins/security_solution/public/common/components/event_details/__mocks__/index.ts index 17435e71a94b2..f6a08ea9f6c85 100644 --- a/x-pack/plugins/security_solution/public/common/components/event_details/__mocks__/index.ts +++ b/x-pack/plugins/security_solution/public/common/components/event_details/__mocks__/index.ts @@ -5,7 +5,7 @@ * 2.0. */ -export const mockAlertDetailsData = [ +export const generateAlertDetailsDataMock = () => [ { category: 'process', field: 'process.name', values: ['-'], originalValue: '-' }, { category: 'process', field: 'process.pid', values: [0], originalValue: 0 }, { category: 'process', field: 'process.executable', values: ['-'], originalValue: '-' }, @@ -654,3 +654,5 @@ export const mockAlertDetailsData = [ originalValue: ['dummy.exe'], }, ]; + +export const mockAlertDetailsData = generateAlertDetailsDataMock(); diff --git a/x-pack/plugins/security_solution/public/common/components/event_details/overview/__snapshots__/index.test.tsx.snap b/x-pack/plugins/security_solution/public/common/components/event_details/overview/__snapshots__/index.test.tsx.snap index ecb997b4cbfe9..0183f15e991c1 100644 --- a/x-pack/plugins/security_solution/public/common/components/event_details/overview/__snapshots__/index.test.tsx.snap +++ b/x-pack/plugins/security_solution/public/common/components/event_details/overview/__snapshots__/index.test.tsx.snap @@ -334,5 +334,55 @@ exports[`Event Details Overview Cards renders rows and spacers correctly 1`] = ` + .c0 { + position: fixed; + bottom: 60px; + left: 20px; + height: 50vh; + width: 48vw; + max-width: 90vw; +} + +.c0.is-hidden { + display: none; +} + +.c0.is-confirming .modal-content { + opacity: 0.3; +} + +.c0 .console-holder { + height: 100%; +} + +.c0 .terminate-confirm-panel { + max-width: 85%; + -webkit-box-flex: 0; + -webkit-flex-grow: 0; + -ms-flex-positive: 0; + flex-grow: 0; +} + + + .c0 { + position: fixed; + bottom: 60px; + left: 20px; + height: 50vh; + width: 48vw; + max-width: 90vw; +} + +.c0.is-hidden { + display: none; +} + +.c0.is-confirming .modal-content { + opacity: 0.3; +} + +.c0 .console-holder { + height: 100%; +} + +.c0 .terminate-confirm-panel { + max-width: 85%; + -webkit-box-flex: 0; + -webkit-flex-grow: 0; + -ms-flex-positive: 0; + flex-grow: 0; +} + +